Larastan
larastan/larastan
Larastan - 코드를 실행하지 않고도 버그를 찾아냅니다. Laravel용 phpstan/phpstan 확장 패키지
⚗️ Larastan 소개
Larastan은 Can Vural과 Nuno Maduro가 만들었고, 아트워크는 @Caneco가 디자인했습니다. 현재는 Can Vural, Nuno Maduro, Viktor Szépe가 유지보수하고 있으며, Laravel용 PHPStan 확장 패키지입니다. Larastan은 코드 속 오류를 찾아내는 일에 집중합니다. 테스트를 작성하기도 전에 여러 유형의 버그를 미리 잡아낼 수 있습니다.
- Laravel에 정적 타이핑을 더해 개발 생산성과 코드 품질을 높여 줍니다.
- Laravel의 아름다운 매직을 대부분 지원합니다.
- 코드 속 버그를 찾아냅니다.
엄밀히 말해 "정적 분석"은 애플리케이션 코드를 로드하지 않습니다. 하지만 Larastan은 애플리케이션의 컨테이너를 부팅하여, 런타임에서만 계산할 수 있는 타입까지 해석합니다. 그래서 "정적 분석" 대신 "코드 분석"이라는 표현을 사용합니다.
지원하는 Laravel 버전
| Laravel 버전 | Larastan 버전 |
|---|---|
| < 9 | 1.x |
| > 9.0 && >= 11.16 | 2.x |
| 11.16+ | 3.0+ |
스폰서
✨ 3단계로 시작하기
요구 사항:
1단계: 먼저 Composer로 Larastan을 Laravel 프로젝트의 개발 의존성(dev dependency)으로 설치합니다.
composer require --dev "larastan/larastan:^3.0"Laravel 패키지를 분석하는 데 Larastan을 사용하시나요? 그렇다면
orchestra/testbench를 추가로 설치해야 할 수 있습니다.
2단계: 그다음 애플리케이션 루트에 phpstan.neon 또는 phpstan.neon.dist 파일을 만듭니다. 다음과 같은 형태가 될 수 있습니다.
includes:
- vendor/larastan/larastan/extension.neon
- vendor/nesbot/carbon/extension.neon
parameters:
paths:
- app/
# Level 10 is the highest level
level: 5
# ignoreErrors:
# - '#PHPDoc tag @var#'
#
# excludePaths:
# - ./*/*/FileToBeExcluded.php사용 가능한 모든 옵션은 PHPStan 문서에서 확인할 수 있습니다: https://phpstan.org/config-reference
3단계: 마지막으로 phpstan 콘솔 명령어로 코드 분석을 시작합니다.
./vendor/bin/phpstan analyseAllowed memory size exhausted 오류가 발생하면 --memory-limit 옵션으로 해결할 수 있습니다.
./vendor/bin/phpstan analyse --memory-limit=2G오류 무시하기
특정 오류는 PHP 주석이나 설정 파일에서 무시할 수 있습니다.
// @phpstan-ignore-next-line
$test->badMethod();
$test->badMethod(); // @phpstan-ignore-linePHPStan 설정 파일에서 오류를 무시할 때는 오류 메시지를 기준으로 한 정규식을 작성합니다.
parameters:
ignoreErrors:
- '#Call to an undefined method .*badMethod\(\)#'베이스라인 파일
오래된 코드베이스에서는 높은 PHPStan 레벨을 통과하도록 모든 코드를 고치는 데 시간을 들이기 어려울 수 있습니다.
이럴 때 베이스라인 파일을 생성하면 됩니다. 베이스라인 파일은 현재 존재하는 모든 오류를 담은 설정 파일을 만들어 주므로, 기존 코드는 그대로 두고 새로 작성하는 코드부터 더 높은 기준을 적용할 수 있습니다. (PHPStan 문서)
./vendor/bin/phpstan analyse --generate-baseline규칙
Laravel 전용으로 설정할 수 있는 규칙 목록은 여기에서 확인할 수 있습니다.
기능
Larastan의 기능 목록은 여기에서 확인할 수 있습니다.
커스텀 PHPDoc 타입
Larastan 전용 PHPDoc 타입 목록은 여기에서 확인할 수 있습니다.
커스텀 PHPStan 설정 파라미터
PHPStan 설정 파일에서 사용할 수 있는 Larastan 전용 설정 파라미터 목록은 여기에서 확인할 수 있습니다.
무시해야 할 오류
Laravel의 일부 기능은 아직 Larastan/PHPStan이 이해하기에는 너무 마법 같은 방식으로 동작합니다. 자주 발생하는 무시할 오류 목록을 정리해 두었으니, 필요에 따라 추가해 사용하세요.
👊🏻 기여하기
Larastan에 기여를 고려해 주셔서 감사합니다. 모든 기여 가이드라인은 여기에 정리되어 있습니다.
📖 라이선스
Larastan은 MIT 라이선스로 배포되는 오픈소스 소프트웨어입니다.
