【VSCode】php cs fixerでの整形設定、備忘録

2021年10月11日

【VSCode】php cs fixerでの整形設定、備忘録

設定手順

VSCodeを起動し、拡張機能から「php cs fixer」を検索し、インストール。

以下のサイトからphp-cs-fixer-v3.pharをダウンロード。

https://cs.symfony.com/

ダウンロード直リンク

ダウンロードしたファイルを「/Users/ユーザ名/.vscode」に配置。

VSCodeに戻り、「Command + Shift + P」を押下。

Windowsの場合は、「Control + Shift + P」。

検索欄に「setting」と入力し、候補より「基本設定：設定（JSON）を開く」を選択。

開かれたSetting.Jsonに以下の内容を追記。

"php-cs-fixer.onsave": true,
"php-cs-fixer.executablePath": "~/.vscode/php-cs-fixer-v3.phar", 
"[php]": {
       "editor.defaultFormatter": "junstyle.php-cs-fixer"
}

これで設定が完了です。

ファイルを保存した際に、自動でフォーマットされるようになっているため、試してみてください。

エラーが出る場合

保存時、VSCode右下に以下のような表示があった場合、表示内容に従い、エラー詳細を確認します。

ヘッダメニューより「ヘルプ > 開発ツールの切り替え」を選択し、Consoleよりエラー内容を確認することができます。

パスが合っているのに、excutablePath not foundが表示される場合

この場合には、PCにphpがインストールされていない可能性があります。

Windowsの場合、公式サイトから。

Macの場合、brewでインストールが可能です。

【VSCode】php cs fixerでの整形設定、備忘録

設定手順

エラーが出る場合

パスが合っているのに、excutablePath not foundが表示される場合

関連する書籍