[忘備録]Laravel Pintについて＆ルールの確認方法

Laravel Pint

Laravel専用のコード整形ツール

公式サイトがわかりやすく説明しているので、本記事で説明は省略

• Laravelのバージョンによっては標準搭載されているのでインストールは不要
• 搭載されていない場合は、composer require laravel/pint --devでインストールする

使い方

コード整形

./vendor/bin/pint -v

コードスタイルチェック（整形はしない)

./vendor/bin/pint  --test

Pintルールの定義

Laravelデフォルトのルールが準備されているので、定義しなくても使える。
ルールをカスタマイズする場合は、pint.jsonを作成してルールを記載する。

pint.jsonの形式

pint.json

{
    "preset": "xxxxxx",
    "rules": {
        "xxxxxx1": true,
        "xxxxxx2": false,
    },
}

• preset(プリセット)：あらかじめ定義されたルールのグループ
• rules(ルール)：個々のルール設定
• 特定のファイル／フォルダをルールの対象外にすることも可能（こちらを参照)

Preset(プリセット)

Laravel公式ページによるとPintが現在サポートしているプリセットは、laravel、psr12、symfony とのこと。
プリセットで定義したルールはGitHubから確認できる。

Preset:laravelのpintルール

Preset:PSR12のpintルール

Pintのルール

ルールの定義やどのようにコード整形されるか以下のサイトから確認できる

各ルールのExampleからBefor→Afterが確認できて、ルールの選定がしやすい