🔄

Laravel Pintを使用してコードを自動整形する方法

2023/07/05に公開

Laravel Pintとは

PHP-CS-Fixerをベースに構築されているLaravelのコードを自動整形するツールです。

Laravel Pintをインストールするには、PHP 8.0以上が必要です。
Laravel のバージョン 9.3からはLaravel Pintが標準インストールされているのでインストールは不要となっています！

Composer経由でインストールできます。

composer require laravel/pint --dev

インストールできたか確認します。

composer show | grep pint

Laravel Pintがインストールされている場合はパッケージの情報が表示され、インストールされていない場合は表示されないか、エラーメッセージが表示されます。

Dockerコンテナ内にシェルセッションを開きます。

シェルセッションとは、コマンドラインインターフェース（CLI）上でユーザーとシステムが対話的にやり取りするための環境のことです。

docker exec -it <コンテナ名> bash

# sail環境
sail shell

Composerを使用してインストールされたパッケージの一覧を表示し、その中から「pint」というキーワードを検索します。

composer show | grep "laravel-pint"

インストールされており、以下のように表示されました。

composer.jsonのrequire-devセクションを確認する方法があります。

require-devセクションとは、開発環境でのみ必要な依存関係（パッケージ）を定義するためのセクションです。このセクションに指定された依存関係は、本番環境では必要なく、主に開発やテストに使用されるので、Laravel Pinもここに定義されています。

./vendor/bin/pint

# sail環境
sail pint

修正箇所があった場合は、このように✅が表示されます。

修正箇所がない場合

./vendor/bin/pint -v

# sail環境
sail pint -v

以下のように指定して自動整形を実行することができます。

./vendor/bin/pint app/Models

./vendor/bin/pint app/Models/User.php

何かありましたらお気軽にコメント等いただけると助かります。
ここまでお読みいただきありがとうございます🎉