Laravel Pint

Laravel Pint を Composer と一緒にインストールする

Laravel Pint は Laravel フレームワークの 最近のリリースに含まれている(英語)ため、通常、プロジェクト内の composer.json ファイルには laravel/pint 依存関係レコードが追加されます。 そうでない場合は、レコードを手動で追加します。

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

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

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

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

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

PhpStorm で Laravel Pint を構成する

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

設定 （Ctrl+Alt+S） | PHP | 品質ツール | Laravel Pint で、デフォルトの PHP インタープリターを変更したり、Laravel Pint 実行可能ファイルへのカスタムパスを設定したり、PhpStorm で実行するときに Laravel Pint に渡す追加オプションを設定したりできます。

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

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

  2. Laravel Pint 実行可能ファイルへのパスを設定するには、 構成 リストの横にある をクリックして Laravel Pint ダイアログを開き、 Laravel Pint ダイアログ リファレンスページの説明に従ってフィールドを編集します。

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

• オプション ：この領域で、 Laravel Pint を PhpStorm インスペクションとして実行するためのオプションを追加します。

  • コミットされていないファイルのみを整形する: コミットされていない変更が含まれるファイルのみを変更するには、チェックボックスをオンにします。

  • pint.json へのパス： pint.json 構成ファイルへのパスを指定します。 pint.json ファイルはオプションです。Laravel Pint のプリセットに含まれる特定のルールの有効化または無効化、あるいは PHP CS Fixer のカスタムルールセットの再利用に使用されます。

  • ルールセット: コード内のコードスタイルの問題を修正するために使用する、Laravel Pint の 事前定義されたルールグループ(英語)の 1 つを選択します。

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

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

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

   

3. ページ右側のペインで、PhpStorm が Laravel Pint インスペクション出力をどう処理するか設定します：

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

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

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

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

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

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

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

   

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

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

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

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

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

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

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

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

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

   

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

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

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

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

2. Laravel Pint を PhpStorm インスペクションとして構成します。

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

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

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

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

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

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

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

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