Laravel Pintでコード自動整形

Laravel Pint（ピント：PHP+lint）は、コードスタイルの自動整形ツール「PHP-CS-Fixer」をベースにしたツールです。
Laravel v9.3.0からLaravelに標準搭載されており、Laravelプロジェクトを作成するだけですぐ使えるようになります。デフォルトでPintは設定を必要とせず、Laravelのコーディングスタイルに従い、コードスタイルの問題を修正できます。

コマンド

Laravelプロジェクト直下で、以下コマンドを実行します。コードが整形されます。

./vendor/bin/pint

オプション

オプションをつけて、コードを整形することもできます。

-vオプション

修正されたファイルの詳細が確認できます。ファイル内の修正箇所が分かります。

./vendor/bin/pint -v

--testオプション

修正はせずに、チェックのみを行います。

./vendor/bin/pint --test

--dirtyオプション

Gitでコミットされてないコードのみを修正します。

./vendor/bin/pint --dirty

Laravel Pint - Laravel 10.x - The PHP Framework For Web Artisans

Laravel is a PHP web application framework with expressive, elegant syntax. We’ve already laid the foundation — freeing you to create without sweating the small...

laravel.com

お試し

環境

Laravel Pintを試してみた環境です。
Laravel10なので、Laravel Pintが標準搭載されています。

実行結果

-vオプションと修正するファイルを指定して、コマンドを実行します。

./vendor/bin/pint -v app/Http/Controllers/TodoController.php

実行結果が表示されます。
中かっこ「{」のインデントが修正されています。

Laravel Pintは、Laravelに標準搭載さえている、かつ、設定不要で使い始めることができるので、導入コストがとても低いです。
Gitでコミットする前に、Laravel Pintで整形することで、コードをきれいな状態に保つことができそうです。