Psalm

Composer と Psalm をインストール

Psalm を Composer でインストールすると、PhpStorm は必要なスクリプトを自動でダウンロードし、IDE に登録し、オプションで対応する コードインスペクションを有効化および構成します。

1. composer.json 内で、 vimeo/psalm 依存関係レコードを require キーまたは require-dev キーに追加します。 パッケージ名とバージョンのコード補完を取得するには、 Ctrl+Space を押します。

2. 次のいずれかを実行します：

   • エディターパネルの上部にある インストール​する​ ショートカットリンクをクリックします。

   • インストールされていない Composer パッケージ インスペクションが有効化されている場合、PhpStorm は現在インストールされていない宣言済みの依存関係をハイライトします。 Alt+Enter を押して、特定の依存関係をインストールするか、すべての依存関係を一度にインストールするかを選択します。

composer.json エディターのガター内のパッケージレコードの横にある をクリックすると、対応する 設定 ページが表示され、そこで Psalm を手動で構成できます。

Psalm 構成をリセットする

Psalm が最初に構成された後、 composer.json をさらに変更しても、インスペクション構成には影響しません。 新しい変更を適用するには、Psalm 構成をリセットします。

1. 設定 ダイアログ (Ctrl+Alt+S) で、 PHP | 品質ツール | Psalm に移動します。

2. 構成 リストの横にある をクリックします。

3. 開いた Psalm ダイアログで、 Psalm パス フィールドを空にします。

   

4. composer.json エディターパネルの上部にある 更新する をクリックして、プロジェクト Composer の依存関係を更新します。 詳細については、 依存関係を更新する を参照してください。

PhpStorm は Psalm の構成を新たに実行し、 composer.json への変更を適用します。

PhpStorm で Psalm を構成する

Composer で Psalm をインストールすると 、PhpStorm は vendor/bin フォルダー内の Psalm の実行可能ファイルを自動的に検出し、システムパスで設定された PHP インタープリターを使って実行します。

設定 （Ctrl+Alt+S ）｜ PHP | 品質ツール | Psalm では、デフォルトの PHP インタープリターの変更や、 手動でダウンロードしてインストールした Psalm 実行可能ファイルへのパスの設定、または PhpStorm で実行時に Psalm へ渡すオプションの追加ができます。

• 構成: このフィールドでは、デフォルトの PHP インタープリターと Psalm 実行可能ファイルへのパスを変更できます。

  1. インタープリターのみを変更するには、プロジェクトで構成されたローカルおよびリモート PHP インタープリターのリストから必要な項目を選択します。

  2. Psalm 実行可能ファイルへのパス、またはインタープリターとパスの両方を変更するには、 構成 リストの横にある をクリックして Psalm ダイアログを開き、 Psalm ダイアログ リファレンスページの説明に従ってフィールドを編集します。

• 無視対象ファイルの表示 ：この設定を使って Psalm 検証インスペクションからファイルを除外します。 詳細については、 品質ツール リファレンスページを参照してください。

• オプション ：この領域で、 Psalm を PhpStorm インスペクションとして実行するためのオプションを追加します。 Psalm 参照ページの説明に従って、フィールドを編集します。

Psalm インスペクションを Composer で有効にする

composer.json の スクリプト(英語)セクション内に Psalm 構成ファイルに関する情報を含めることができます。 プロジェクトの依存関係を インストールまたは 更新すると、指定された構成ファイルが検出され、 Psalm 検証インスペクションが自動的に有効になります。

composer.json の スクリプト セクションで構成ファイルが指定されていない場合、PhpStorm はさらにプロジェクトルートを確認し、 psalm.xml または psalm.xml.dist のデフォルト名のルールセットを探します。

• composer.json の スクリプト セクションで、 psalm Psalm 起動コマンドをリーフ要素の 1 つに追加します。

  --config 引数と構成ファイルへのパスを指定します。

  "scripts": { "psalm": "vendor/bin/psalm --config=psalm.xml" }

インスペクション設定で Psalm 検証を有効にする

1. 設定 ダイアログ（Ctrl+Alt+S ）で、 エディター の インスペクション をクリックします。

2. 開いている インスペクション ページで、 PHP | 品質ツール ノードを展開し、 Psalm 検証 の横にあるチェックボックスを選択します。

3. ページ右側のペインで、PhpStorm が Psalm インスペクション出力をどう処理するか構成します：

   1. スコープ: インスペクションアプリケーションを制限する スコープを選択します。

   2. 重大度: インスペクションの 重大度を選択します。 選択した値によって、検出された不一致が PhpStorm でどの程度深刻に扱われ、 インスペクション結果に表示されるかが決まります。

   3. エディター内のハイライト: インスペクションによって検出された問題をエディターでハイライトする方法を選択します。

Psalm キャッシュを初期化する

Psalm 検証インスペクションは単一のファイルで実行できますが、Psalm はプロジェクト全体をパスします。 大規模なプロジェクトでは、初めて実行するときに Psalm の応答を待つと、 Psalm ダイアログの ツールプロセスのタイムアウト フィールドで指定された制限を超えることがあります。 このような場合、PhpStorm はエラーメッセージを表示します：

• 初期化キャッシュ リンクをクリックして、Psalm にプロジェクト全体をパスさせ、構成された キャッシュディレクトリ(英語)にキャッシュを生成させます。 リモートインタープリターを使用している場合は、キャッシュディレクトリをリモート環境内からアクセスできる場所に設定してください。

• Psalm 分析から除外する リンクをクリックすると、現在のファイルを 無視されたファイルリストに追加できます。

1. メインメニューで コード | コードのインスペクション へ移動します。

2. 開いた インスペクションスコープの指定 ダイアログで、リストからインスペクションプロファイルを選択するか、 構成… をクリックして インスペクションダイアログを開き、新しいプロファイルを構成します。

   構成… をクリックして、選択したインスペクションプロファイルの範囲内で適用される修正を確認し、 Psalm 検証インスペクションが有効になっていることを確認することもできます。

3. インスペクションの結果を 問題ツールウィンドウ で見る。 Psalm により報告されたエラーや警告は、PhpStorm の内部インスペクションと区別するために接頭辞が付けられています。

1. 設定 ダイアログ (Ctrl+Alt+S) で、 PHP | 品質ツール | Psalm に移動します。

2. 無視対象ファイルの表示 リンクをクリックします。

   • ファイルを追加するには、 をクリックし、表示されるダイアログで目的のファイルを探します。

   • リストからファイルを削除して Psalm に再度処理させるには、ファイルを選択して をクリックします。

   • 一覧からすべてのファイルを削除するには、 をクリックします。