【Laravel】Larastanの導入方法

【Laravel】Larastanの導入方法

2022年05月05日

やりたいこと

Laravelで構築されたプロジェクトに静的解析ツールであるLarastanを導入したい

 

手順

  1. larastanをインストール
  2. 設定ファイルを作成
  3. larastan実行

 

実装

1 larastanをインストール

以下コマンドでlarastanをインストールします

composer require nunomaduro/larastan:^2.0 --dev

なお、こちらはphp8.0以上,laravel9.0以上に対応しているので、それ以下のバージョンをお使いの方は以下コマンドを実行してください。

composer require nunomaduro/larastan:^1.0 --dev

2 設定ファイルを作成

ルートディレクトリ直下にphpstan.neonを作成してください。

内容は以下のように追記してください。

phpstan.neon

includes:
　- ./vendor/nunomaduro/larastan/extension.neon

parameters:

　paths:
　　- app

　# The level 9 is the highest level
　level: 6　・・・①

　excludePaths:
　　- ./*/*/FileToBeExcluded.php

　checkMissingIterableValueType: false
　checkGenericClassInNonGenericObjectType: false

①latastanでは解析のレベルを9まで設定することができます。

実際にどのレベルまで設定するかは、プロジェクトやチームの方針によってくる部分だと思うので、チームメンバーと相談して決めてください。

 

3 larastan実行

ここまででlarastanの設定は完了です。

あとは、ルートディレクトリで以下コマンドを実行するとlarastanが静的解析を行ってくれます。

./vendor/bin/phpstan analyse

 

以上！！！！！！！