PHP_CodeSniffer
このページで、PHP_CodeSniffer 品質ツールを有効化して構成します。
項目 | 説明 |
|---|---|
構成 | リストから必要なインタープリターを選択します。 リストには、現在設定されているすべてのローカルおよびリモート PHP インタープリターが含まれています。 詳細については、 ローカル PHP インタープリターを構成する と リモート PHP インタープリターの構成 を参照してください。 ドロップダウンリストの右側にある |
無視対象ファイルの表示 | クリックすると PHP_CodeSniffer 無視されたファイル ダイアログが開き、PHP_CodeSniffer がスキップするファイルが一覧表示されます。 PhpStorm は、インスペクション中に PHP_CodeSniffer からの応答を待機する時間が ツールプロセスのタイムアウト フィールドで指定された上限を超えた場合、新しいファイルをリストに追加することを提案します。 これは処理が遅くなるのを防ぐために行われます。 各ファイルについて、PhpStorm はその名前と場所を表示します。
|
拡張子を持つファイルを確認する | PHP_CodeSniffer でチェックする必要があるファイル拡張子のコンマ区切りのリストを提供します。 |
警告を次のように表示する ... | PHP_CodeSniffer がエラーに加えて警告を報告するようにするには、チェックボックスを選択し、リストから 重大度を選択します。 チェックボックスをオフにすると、エラーのみが報告され、警告の報告が抑制されます。 |
スニフ名を表示 | チェックボックスを選択すると、対応するスニフの名前がエディターに表示されるか、インスペクションの概要に加えて インスペクションの結果が表示されます。 |
インストールされている標準パス | カスタムのサードパーティコーディング標準(Coder(英語) や Joomla コーディング標準(英語)など)に依存している場合は、使用する前に PHP_CodeSniffer と統合する必要があります。 これを行うには、 インストールされている標準パス チェックボックスを選択し、 |
コーディング基準 | 適用するコーディング基準を定めます。
|
実行モード | PHP_CodeSniffer がコードを解析するトリガーの頻度を設定します:
|
アイドルしきい値 (ms): | PHP_CodeSniffer を実行する前に、コードの変更後にミリ秒単位で遅延時間を設定します。 |
最小間隔 (ms): | 同じファイルで PHP_CodeSniffer を連続して実行する場合に必要な最小経過時間(ミリ秒)を定義します。 頻繁なファイル保存や大量の入力時に PHP_CodeSniffer が過度に実行されるのを防ぎます。 |
PHP_CodeSniffer ダイアログ
PHP_CodeSniffer ページの 構成 リストの隣にある をクリックするとダイアログが開きます。
このダイアログを使用して、使用する PHP インタープリター、PHP_CodeSniffer 実行可能ファイルへのパス、および PHP_CodeSniffer の動作を構成します。 詳細は PHP_CodeSniffer を参照してください。
項目 | 説明 |
|---|---|
インタープリターペイン | ダイアログの左側のペインには、PHP_CodeSniffer を使用するデフォルトの PHP インタープリターが表示されます。 別のインタープリターを追加するには、 |
PHP_CodeSniffer パス | このフィールドで、PHP_CodeSniffer スクリプトの場所を指定します。Windows の場合は phpcs.bat 、Linux や macOS の場合は phpcs です。 PhpStorm は、 phpcs.bat または phpcs への指定されたパスが PhpStorm と PHP_CodeSniffer 間の相互作用を保証すること、つまりツールが PhpStorm から起動でき、PhpStorm がそこから問題レポートを受信することを確認するには、 検証 ボタンをクリックします。 この検証は、 |
ツールプロセスのタイムアウト | このフィールドでは、PhpStorm が PHP_CodeSniffer からの結果を待つ時間を指定します。 タイムアウトを超えると、CPU とメモリの過度の使用を防ぐためにプロセスが終了します。 これにより、コンピューターの構成と使用するルールセットに応じて PHP_CodeSniffer プロセスの動作を微調整できます。 |
PHP コードの美化と修正の設定 | この領域で、 phpcbf へのパス フィールドに PHP コードの美化と修正(英語)ツールへのカスタムパスを指定します。 パスを手動で入力するか、 PHP Code Beautifier and Fixer を使用すると、PHP_CodeSniffer によって検出された多くのエラーを自動的に修正できます。 |