はじめに
こんにちは、技術部の T です。
今回は静的解析ツール「Larastan」について書いていきます。
一人で開発をしている際に、セルフでのチェックには限界を感じ、導入してみました。
Larastanとは
Larastan はプログラムを実行することなく、コマンド 1 つでソースを解析し、エラーが生じる箇所や非推奨となっている実装箇所を発見するツールです。
PHPstan の拡張であり、名前の示す通り Laravel で開発を行う際に利用することが出来ます。
詳しくは以下の公式ドキュメントを参照してください
https://github.com/nunomaduro/larastan
Larastan導入
導入したいプロジェクトのルートディレクトリで以下のコマンドを実行
composer require nunomaduro/larastan --dev
同じ階層で phpstan.neon または phpstan.neon.dist というファイルを作成し以下の内容を記載する。
includes:
- ./vendor/nunomaduro/larastan/extension.neon
parameters:
paths:
- app
# The level 9 is the highest level
level: 5
ignoreErrors:
- '#PHPDoc tag @var#'
excludePaths:
- ./*/*/FileToBeExcluded.php
checkMissingIterableValueType: false
ファイルを作成したら、以下のコマンドを実行することで静的解析が行われます。
./vendor/bin/phpstan analyse
各種設定
「level: 5」の部分でチェックのレベルを 0 ～ 9 の 10 段階で設定できます。
チェックのレベルに関しては以下のページに詳しく記載があります
https://phpstan.org/user-guide/rule-levels
またどうしても無視したいエラーがある場合、「ignoreErrors:」に記載することで無視することが可能です。
最後に
個人での開発だけでなく、チームで開発を行う際の効率アップや、コードレビューの負担軽減などにも効果的なのでおすすめです。
関連記事
- 2022-09-20
- テクノロジー