Psalm

Composer と Psalm をインストール

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

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

2. 以下のいずれか 1 つを実行します:

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

   • インストールされていない 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 を構成する

Psalm を Composer と共にインストールすると、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 の scripts セクションで構成ファイルが指定されていない場合、PhpStorm はさらにプロジェクトルートをチェックして、psalm.xml または psalm.xml.dist のデフォルト名を持つルールセットを見つけます。

• composer.json の scripts セクションで、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 に再度処理させるには、ファイルを選択して をクリックします。

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