🗒️
VS Code + Mac でPHPのコードフォーマッター PHP CS Fixer を使う
PHPのコードフォーマッター PHP CS Fixer をVisual Studio Codeにインストールする手順と使い方をシェアします。
PHP CS Fixer とは
PHP Coding Standards Fixer (PHP CS Fixer) は、コーディング規約に沿ってコードを自動で整形します。 設定によりチームでスタイルを定義することもできます。
PHP CS Fixer を Mac にインストール
複数の方法がありますが、Homebrew が簡単です。
php-cs-fixer のインストール
brew install php-cs-fixer
インストールされたことを確認
php-cs-fixer -V
// PHP CS Fixer 3.14.3 (b418036) Oliva by Fabien Potencier and Dariusz Ruminski.
// PHP runtime: 8.1.14
VS Codeへ拡張機能をインストール
- 左メニューの
拡張機能を選択 -
PHP CS Fixerを検索しインストールボタンを押下
拡張機能の設定画面から、PHP-cs-fixer: Executable Path を見つけ、php-cs-fixerと入力します。これでVSCODEから、php-cs-fixerコマンドを呼び出せるようになります。
使い方
設定画面で、Onsave にチェックを入れると、ファイル保存と同時に、フォーマットが実行されます。
手動でコード整形したい場合、対象ファイルを開いた状態で、F1キーでコマンドパレットを開き、以下のコマンドを用途に応じて実行します。
//整形する（ファイル保存しない）
php-cs-fixer: fix this file
//整形してファイル保存
php-cs-fixer: fix
//整形する前と後の差分を確認
php-cs-fixer: diff
以上、参考になりましたらうれしいです。
参考
PHP CS Fixer 公式ページ
リポジトリ
Discussion