VisualStudioCodeでPHPを自動整形したい
WordPressのカスタマイズでphpのコードを修正していると、段々とコードが汚くなってくるため、
自動整形機能を設定する方法を試してみました。
使用したのは、「php cs fixer」です。Windows10で実行しているVisual Studio Codeに設定します。
設定方法
① 「PHP CS Fixer」のExtensionを追加
Visual Sutdio Codeにて、php cs fixerを追加します。
ViewにあるCommand Paletteを選択し、Extensions: Install Extensions をタイプし、PHP CS Fixerを探して、Installします。
② 「PHP CS Fixer」をダウンロード
①のエクステンションだけでは使用可能にならずに executablePath not foundのエラーがでます。
php cs fixerを使用PCのOS上にも入れておかないといけません。
導入方法は色々あるようですが、ここではシンプルにWindowsにダウンロードしてみます。
リンクは以下の導入ガイドから。
https://github.com/FriendsOfPHP/PHP-CS-Fixer#installation
③ 「PHP CS Fixer」のエクステンションの設定
Visual Studio Code上で、エクステンションのパスを設定します。
File→Preferences→Setting→ExtensionsからPHP CS Fixerを選択し、以下の二つのパラメーターに②でダウンロードしたパスを指定。
php-cs-fixer.executablePath
php-cs-fixer.executablePathWindows
パスを設定しVisual Sutdio Codeを再度開いたものの、「executablePath not found」のエラーがまだ出ています。
調べたところ、PHPのパスが通っていないせいかも！ということで、
WindowsにPHPが導入されていませんでした・・
WindowsにPHPをダウンロードし、システムのプロパティの環境変数のPATHに、PHPを置いた場所を追加します。
コマンドプロンプトで、「php -v」 を入力し、正常に表示されるか確認し、正常に表示されたらOK。
これでエラーが解消されたはずと思い、再度Visual Sutdio CodeでPHPのファイルで右クリックし、Format Documentを実行してみたところ、今度は、「php general error」が発生。
原因を調査するために、「Help」→「Toggle Developer Tool」を実行し、Consoleタブからエラー内容を確認。
確認したところphp-cs-fixer.pharファイルが開けないとエラーが出ていました。
ここで気付きました。エクステンションの設定パラメーターはデフォルトで、php-cs-fixer.pharとなっていますが、ダウンロードしたファイル名は、php-cs-fixer-v2.pharでした。
パラメーターを修正したところ、エラーが解消され、ファイルを自動保存すると整形ができるようになりました。
