PHP_CodeSniffer

Composer で PHP_CodeSniffer をインストールする

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

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

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

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

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

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

PHP_CodeSniffer 設定をリセット

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

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

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

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

   

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

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

PhpStorm で PHP_CodeSniffer を構成する

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

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

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

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

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

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

• オプション : この領域で、PHP_CodeSniffer を PhpStorm インスペクションとして実行するオプションを追加します。PHP_CodeSniffer リファレンスページの説明に従って、フィールドを編集します。

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

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

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

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

  使用するコーディング標準を示すために --standard 引数を指定します。例: 次のレコードを追加すると PSR2 にコーディング標準が設定されます。

  "scripts": { "phpcs": "phpcs --standard=PSR2" }

  次のレコードを追加すると、コーディング標準がカスタムに設定され、ルールセットのパスが <project root>/phpcs.xml に設定されます。

  "scripts": { "phpcs": "phpcs --standard=phpcs.xml" }

さらに、composer.json の require-dev セクション内にカスタムの非 PSR 標準依存関係を提供して、自動的に検出させることもできます。現在、以下の規格がサポートされています。

• Doctrine(英語)

• Drupal Coder(英語)

• Joomla(英語)

• Magento(英語)

• MediaWiki(英語)

• PHPCompatibility(英語)

• Symfony(英語)

• WordPress(英語)

• Yii(英語)

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

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

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

   

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

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

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

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

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

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

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

3. 問題ツールウィンドウのインスペクションの結果を表示します。PHP_CodeSniffer によって報告されたエラーと警告には、PhpStorm 内部インスペクションと区別するために、phpcs の接頭辞が付いています。

   

クイックフィックスを使用して問題を修正する

PhpStorm は問題を検出すると、PHP_CodeSniffer インスペクション設定に従って問題をハイライトします。

1. 検出された問題にキャレットを置いて をクリックするか、Alt+Enter を押します。

2. ポップアップメニューから PHP コードの美化と修正: ファイル全体を修正するを選択してください。これにより、現在のファイルで検出されたすべての問題が修正されます。

バッチモードで問題を検出したり、コードの再フォーマットで自動的に修正したりすることもできます。

コードの再フォーマットに関する問題を修正する

コードの再フォーマットアクションを実行することで、PHP_CodeSniffer によって検出された問題を修正できます。

1. 品質ツールの設定で PHP コードの美化と修正を外部フォーマッタとして設定します。

   これを行うには、設定ダイアログ (Ctrl+Alt+S) で PHP | 品質ツールに移動し、外部フォーマッターセクションで PHP コードの美化と修正を選択します。

   

2. 必要なファイルまたはプロジェクトスコープにコードの整形を適用します。

   • エディターで開かれたコードフラグメントまたはファイルの場合、メインメニューからコード | コードの整形を選択するか、Ctrl+Alt+L を押します。

   • プロジェクトツールウィンドウで選択したファイル、ディレクトリ、ファイルのグループについて、コンテキストメニューからコードの整形を選択するか、Ctrl+Alt+L を押します。

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

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

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

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

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