PHPに限らず複数人でコードを書いていくと統一感がなくなります。
個人で書き方が微妙に異なっているからです。
プロジェクトごとに「コーディング規約」なるものは用意されますが、チェックの緩いプロジェクトの場合は確実に書き方がバラバラになります。
if 分の条件カッコのスペースの入れ方、改行の入れ方・・・。
このばらばらの書き方をある程度解消してくれるのがフォーマッターです。
設定したルールに従ってスペースの入れ方、改行の仕方などを統一することができるようになります。
VSCodeでもこのフォーマッターがあるのでそれを導入します。
インストールするフォーマッターは「PHP CS Fixer」です。
目次
PHP CS FixerのPharファイルをダウンロードする
まずはPharファイルをダウンロードします。
このページにある「INSTALL NOW」から php-cs-fixer-v3.phar ファイルをダウンロードします。
ダウンロードしたら「C:\Users\ユーザー名\.vscode」にコピーしましょう。
VSCode拡張機能のPHP CS Fixerをインストールする
次にVSCode拡張機能版PHP CS Fixerをインストールします。
VSCodeを開いて左下の歯車ボタンから拡張機能を選びます。
検索欄に「php cs fixer」と入れてphp cs fixerをインストールします。
いくつか出てきますが「junstyle」のものを選びます。
インストールできたら左下の歯車ボタンから設定を選びます。
右上のドキュメントのアイコンを押します。（カーソルを合わせると「設定（UI）を開く」と出るやつです）
settings.json ファイルが開くので次の内容を追加して保存します。
"[php]": {
"editor.defaultFormatter": "junstyle.php-cs-fixer"
},
"php-cs-fixer.executablePath": "C:\\Users\\laidback\\.vscode\\php-cs-fixer-v3.phar",
フォーマッターを実行する
PHPのソースを開いて「Alt + Shit + F」を実行するだけです。
ソースを開いて・・・
「Alt + Shift + F」を実行するだけ。
整形されました！
保存時にフォーマットを自動実行するように設定する
「Alt + Shift + F」を毎回実行するのは正直めんどくさいです。
保存時に自動で整形するようにします。
settings.json ファイルに次の行を追加するだけでOKです。
"php-cs-fixer.onsave": true,これで保存したときに自動的にフォーマットされます。