あるSEのつぶやき・改

ITやシステム開発などの技術に関する話題を、SEとしての経験から取り上げたり解説したりしています。

VSCodeとPHP CS Fixerでファイル保存時にPHPコードを自動整形する方法

Laravel + VS Code のプロジェクトで、PHPコードをファイル保存時に自動的に整形(Lint)する方法が分かったので、その方法を残しておきます。

環境は、Mac になります。

まず、PHP CS Fixer というコマンドラインで PHP コードを自動整形するツールを導入します。

github.com

Homebrew でインストールするのが一番簡単です。

$ brew install php-cs-fixer

他にも、composer を使ったり、ファイルを直接ダウンロードしたりする方法がありますが、詳しくはリンク先を参考にしてください。注意点としては、インストール後にパスを通しておくといくことですね。

これで、Laravel のプロジェクトであれば、以下のコマンドで一気にコード整形できます。

$ php-cs-fixer fix app

次は、VS Code の拡張機能の「PHP CS Fixer」をインストールします。拡張機能の検索画面で、「php cs fixer」と入力して最初に出てくるものですね。

f:id:fnyablog:20200711103009p:plain:w320

インストールが済んだら、User settingsで、「Onsave」の「Execute PHP CS Fixer on save」にチェックを入れます。

f:id:fnyablog:20200711103643p:plain:w320

VS Code で User settings を表示するには、F1キーを押して、コマンドパレット「user settings」と検索します。Windows では、Ctrl+Shift+P でコマンドパレットを開くようですね。

これで、ファイル保存時に、PHPコードを自動でコード整形できるようになりました。

Windowsでは、以下の記事が参考になるかと思います。

https://monoxa.net/2018/03/%E3%80%90%E5%88%9D%E5%BF%83%E8%80%85%E5%90%91%E3%80%91visual-studio-code%E3%81%A7php-cs-fixer%E3%82%92%E8%A8%AD%E5%AE%9A%E3%81%99%E3%82%8B%E6%96%B9%E6%B3%95/?doing_wp_cron=1594397798.0578880310058593750000