PHPStan
PhpStorm は、 PHPStan(英語) ツールまたはその Laravel 拡張機能 ララスタン(英語)との統合を通じてコード品質チェックを提供します。 どちらのツールも、一連の検証ルールに照らしてコードの一貫性を検証します。
コマンドラインの代わりに PhpStorm から PHPStan または Larastan を使用するには、PhpStorm に登録し、PhpStorm コードインスペクションとして設定する必要があります。 PhpStorm にインストールして有効にすると、ツールは開いているすべての PHP ファイルで使用でき、起動するために追加の手順は必要ありません。 オンザフライコードチェックはファイルが更新されるたびにアクティブになるため、発見された問題を簡単に取り除くことができます。
PHPStan によってオンザフライで報告されるエラーと警告は、 PhpStorm の内部コードインスペクションからのエラーと警告と同じ方法でエディターでハイライトされます。 ツールをバッチモードで実行すると、エラーと警告が 問題ツールウィンドウ に表示されます。 各メッセージには、PhpStorm 内部インスペクションと区別するために、 phpstan 接頭辞が付いています。
統合は オープンソースの PHPStan プラグイン(英語)を介して実装されます。 このプラグインは PhpStorm にバンドルされており、デフォルトで有効になっています。
前提条件
PHPStan を PhpStorm に統合する前に、次の前提条件が満たされていることを確認してください。
PHP エンジンの実行可能ファイルを含むディレクトリをシステム
pathに追加する必要があります。 これにより、コード品質ツールスクリプトがシステム全体の PHP エンジンへの呼び出しを実行できるようになります。Docker Compose ベースの リモートインタープリターの場合、追加のコンテナーが生成されないように、必ず
docker-compose execモードを使用してください。設定 ダイアログ(Ctrl+Alt+S )で に移動します。
表示される PHP ページで、 CLI インタープリター リストの横にある
をクリックします。
開いた CLI インタープリター ダイアログで、選択したインタープリターの ライフサイクル モードを 既存のコンテナーに接続する ('docker-compose exec') に設定します。

PHPStan をインストールして構成する
Composer を使用して PHPStan をインストールする
Composer とともに PHPStan または Larastan をインストールすると、PhpStorm は必要なスクリプトを自動的にダウンロードし、IDE に登録し、オプションで対応する コードインスペクションを有効にして構成します。
composer.json 内で、
phpstan/phpstan(英語) またはlarastan/larastan(英語) 依存関係レコードをrequireまたはrequire-devキーに追加します。 パッケージ名とバージョンのコード補完を取得するには、 Ctrl+Space を押します。以下のいずれか 1 つを実行します:
エディターパネルの上部にある インストール ショートカットリンクをクリックします。
インストールされていない Composer パッケージ インスペクションが有効になっている場合、PhpStorm は、現在インストールされていない宣言済みの依存関係をハイライトします。 Alt+Enter を押して、特定の依存関係をインストールするか、すべての依存関係を一度にインストールするかを選択します。
composer.json エディターのガター内のパッケージレコードの横にある をクリックすると、対応する 設定 ページが表示され、そこで PHPStan を手動で構成できます。

PHPStan 構成をリセットする
PHPStan が最初に構成された後、 composer.json をさらに変更しても、インスペクション構成には影響しません。 新しい変更を適用するには、PHPStan 構成をリセットします。
設定 ダイアログ (Ctrl+Alt+S) で、 に移動します。
構成 リストの横にある
をクリックします。
開いた PHPStan ダイアログで、 PHPStan パス フィールドを空にします。

composer.json エディターパネルの上部にある 更新 をクリックして、プロジェクト Composer の依存関係を更新します。 詳細については、「Web サーバーに接続する 」を参照してください。
PhpStorm は PHPStan 構成を新たに実行し、 composer.json の変更を適用します。
PhpStorm で PHPStan を構成する
Composer を使用して PHPStan をインストールする と、PhpStorm は vendor/bin フォルダー内の PHPStan の実行可能ファイルを自動的に検出し、システムパスで構成された PHP インタープリターを実行するように設定します。
設定 (Ctrl+Alt+S) で | では、デフォルトの PHP インタープリターを変更したり、パスを 手動でダウンロードしてインストールした PHPStan 実行可能ファイル(英語)に設定したり、PhpStorm で実行するときに PHPStan に渡すオプションを追加したりできます。

構成: このフィールドでは、デフォルトの PHP インタープリターと PHPStan 実行可能ファイルへのパスを変更できます。
インタープリターのみを変更するには、プロジェクトで構成されたローカルおよびリモート PHP インタープリターのリストから必要な項目を選択します。
PHPStan 実行可能ファイルへのパス、またはインタープリターとパスの両方を変更するには、 構成 リストの横にある
をクリックして PHPStan ダイアログを開き、 PHPStan ダイアログ リファレンスページの説明に従ってフィールドを編集します。
無視対象ファイルを表示します: この設定を使用して、 PHPStan 検証インスペクションからファイルを除外します。 詳細については、 品質ツールリファレンスページを参照してください。
Options: この領域で、 PHPStan コマンドオプション(英語)を追加して、 PHPStan を PhpStorm インスペクションとして実行します。 PHPStan のリファレンスページの説明に従って、フィールドを編集します。
PHPStan を PhpStorm インスペクションとして有効にする
PHPStan を PhpStorm インスペクションとして設定する方法は二通りあります: Composer を使用した PHPStan のインストール時に自動で設定する方法と、 PhpStorm のインスペクション設定で手動で設定する方法です。
PHPStan インスペクションを Composer で有効にする
composer.json の スクリプト(英語)セクション内に PHPStan 構成ファイルに関する情報を含めることができます。 プロジェクトの依存関係を インストールまたは 更新すると、指定された構成ファイルが検出され、 PHPStan 検証インスペクションが自動的に有効になります。
composer.json の scripts セクションで構成ファイルが指定されていない場合、PhpStorm はさらにプロジェクトルートをチェックして、 phpstan.neon または phpstan.neon.dist のデフォルト名を持つルールセットを見つけます。
composer.json の
scriptsセクションで、phpstanPHPStan 起動コマンドをリーフ要素の 1 つに追加します。-c引数と構成ファイルへのパスを指定します。"scripts": { "phpstan": "vendor/bin/phpstan -c phpstan.neon" }
インスペクション設定で PHPStan 検証を有効にする
設定 ダイアログ(Ctrl+Alt+S )で、 エディター の インスペクション をクリックします。
開いている インスペクション ページで、 ノードを展開し、 PHPStan 検証 の横にあるチェックボックスを選択します。

インスペクション ページの右側のペインで、PhpStorm が PHPStan インスペクション出力を処理する方法を構成します。
スコープ: インスペクションアプリケーションを制限する スコープを選択します。
重大度: インスペクションの 重大度を選択します。 選択した値によって、検出された不一致が PhpStorm によってどの程度深刻に扱われ、 インスペクションの結果に表示されるかが決まります。
エディター内のハイライト: インスペクションによって検出された問題をエディターでハイライトする方法を選択します。
PHPStan をバッチモードで実行する
メインメニューで へ移動します。
開いた インスペクションスコープの指定 ダイアログで、リストからインスペクションプロファイルを選択するか、 構成… をクリックして インスペクション ダイアログを開き、新しいプロファイルを構成します。
構成… をクリックして、選択したインスペクションプロファイルの範囲内で適用される修正を確認し、 PHPStan 検証インスペクションが有効になっていることを確認することもできます。
インスペクションの結果を 問題ツールウィンドウ で見る。 PHPStan によって報告されたエラーと警告には、PhpStorm の内部インスペクションと区別するために
phpstan::の接頭辞が付けられます。
PHPStan 検証インスペクションからファイルを除外する
PHPStan 応答の待機が、 PHPStan ダイアログの ツールプロセスのタイムアウト フィールドで指定された制限を超えると、PhpStorm はファイルを 無視リストに追加することを提案します。
設定 ダイアログ (Ctrl+Alt+S) で、 に移動します。
無視対象ファイルを表示します のリンクをクリックしてください。
ファイルを追加するには、
をクリックし、表示されるダイアログで目的のファイルを探します。
リストからファイルを削除して PHPStan に再度処理させるには、ファイルを選択して
をクリックします。
一覧からすべてのファイルを削除するには、
をクリックします。