PHP Mess Detector

PHP Mess Detector と Composer をインストールする

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

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

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

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

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

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

PHP Mess Detector 構成をリセットする

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

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

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

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

   

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

PhpStorm は、PHP の Mess Detector 構成を新たに実行するため、composer.json の変更を適用します。

PhpStorm で PHP Mess Detector を構成する

設定 (Ctrl+Alt+S) で | PHP | 品質ツール | PHP Mess Detector では、デフォルトの PHP インタープリターを変更したり、パスを手動でダウンロードしてインストールした PHP Mess Detector 実行可能ファイル(英語)に設定したり、PhpStorm で実行するときに PHP Mess Detector に渡されるオプションを追加したりできます。

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

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

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

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

• オプション : この領域で、PHP Mess Detector を PhpStorm インスペクションとして実行するときに実行する検証の横にあるチェックボックスを選択します。詳細については、PHP Mess Detector リファレンスページを参照してください。

Composer で PHP Mess Detector インスペクションを有効にする

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

composer.json の scripts セクションにルールセットが指定されていない場合、PhpStorm はさらにプロジェクトルートをチェックして、phpmd.xml のデフォルト名でルールセットを見つけます。ファイルが存在する場合は、インスペクションのカスタムルールセットとして自動的に選択されます。

• composer.json の scripts セクションで、phpmd PHP Mess Detector 起動コマンドをいずれかのリーフ要素に追加します。

  使用するコーディング標準を示すための引数として、組み込み標準の名前またはカスタムルールセットへのパスを指定します。

  例: 次のレコードを追加すると、コードサイズと論争の的になる組込みルールセットと、/my/src/custom_ruleset.xml ファイルで定義されているカスタムルールセットが選択されます。

  "scripts": { "phpmd": "phpmd codesize,controversial,/my/src/custom_ruleset.xml" }

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

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

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

   

3. ページの右側のペインで、PhpStorm が PHP Mess Detector インスペクション出力を処理する方法を構成します。

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

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

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

1. コーディング標準のルートディレクトリをプロジェクトルートの下に置きます。

2. PHP Mess Detector を PhpStorm インスペクションとして設定します。

3. コーディング標準を指定します。

4. インスペクションページの上部でプロジェクトプロファイルが選択されていることを確認します。このようなプロファイルは、特定のプロジェクトの .idea ディレクトリ (たとえば、$PROJECT_DIR$/.idea/inspectionProfiles) に保存されます。詳細については、「プロファイルを構成する」を参照してください。

5. 設定ダイアログのバージョン管理ページで、.idea ディレクトリがバージョン管理下にあることを確認します。

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

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

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

3. インスペクションの結果を問題ツールウィンドウで見る。PHP Mess Detector によって報告されたエラーと警告には、PhpStorm の内部インスペクションと区別するために phpmd のプレフィックスが付けられています。

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

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

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

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

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