PHP CS Fixer

Composer で PHP CS Fixer をインストールする

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

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

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

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

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

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

PHP CS Fixer 構成をリセット

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

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

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

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

   

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

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

PhpStorm で PHP CS Fixer を構成する

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

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

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

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

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

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

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

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

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

composer.json の スクリプト セクションにルールセットが指定されていない場合、PhpStorm はさらにプロジェクトルートを確認し、 .php_cs または .php_cs.dist というデフォルト名のルールセットを探します。 ファイルが存在する場合は、インスペクションの カスタムルールセットとして自動的に選択されます。

• composer.json の スクリプト セクションで、 php-cs-fixer PHP CS Fixer 起動コマンドをいずれかのリーフ要素に追加します。

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

  "scripts": { "php-cs-fixer": "php-cs-fixer --rules=@PSR1" }

  あるいは、 --config 引数とルールセットファイルへのパスを指定すると、コーディング標準が カスタムに設定されます。

  "scripts": { "php-cs-fixer": "php-cs-fixer --config=./.php_cs" }

インスペクション設定で PHP CS Fixer の検証を有効にする

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

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

   

3. ページ右側のペインで、PhpStorm が PHP CS Fixer インスペクションの出力をどのように処理するか構成してください：

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

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

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

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

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

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

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

   

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

問題が検出されると、PhpStorm は PHP CS Fixer インスペクションの設定に従ってそれをハイライト表示します。

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

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

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

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

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

1. 品質ツールの設定で PHP CS Fixer を外部フォーマッタとして設定します。

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

   

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

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

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

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

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

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

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

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

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

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

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

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

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