【VSCode】phpcsをインストール

2020年12月21日

Mac環境のVSCodeでphpcsがうまく入らなかったのでメモ。

その前にphpcsとは何ぞや、その他で入れておくと良いものも書いておく。

phpcs : PHP Code Sniffer

設定したルールに基づいて、指定ファイルのコーディングにダメ出ししてくれる

phpcbf : PHP Code Beautifier and Fixer

設定したルールに基づいて、指定したファイルのコーディングを整形してくれる

ESLint

JavaScript のための静的検証ツール
コードを実行する前に明らかなバグを見つけたり、括弧やスペースの使い方などのスタイルを統一したりするのに役立つ

手順

まずはVSCodeのExtensionでphpcsをインストール

VSCode Extention phpcs

Macのターミナルで

$ composer global require "squizlabs/php_codesniffer=*"

でphp_codesnifferをインストール(グローバルでローカルでもどっちでも良いと思われる)

$ echo 'export PATH=$HOME/.composer/vendor/bin:$PATH' >> ~/.bash_profile

でパスを通す。すぐに適用させるので、

$ source ~/.bash_profile

で実行。(source コマンド:ファイルに書かれたコマンドを即時実行)

$ phpcs --version

でphpcsのバージョン確認と生存確認。

で、VSCodeを再起動して立ち上げて、適当にphpファイルを開いてみる・・・phpcsが見つからないというエラーがでる。

phpcs: Request workspace/configuration failed with message: Unable to locate phpcs. Please add phpcs to your global path or use composer dependency manager to install it in your project locally.

なんでや。

globalでインストールもやってるっちゅうに。ここで結構悩んだ。

Executable Pathを追加

VSCode→Preference→Settingに進み「Executable Path」で検索

VSCode Preference Setting Executable Path

でphpcsのパスを通す。

$ which phpcs

でパスを確認してセットすればOK。

setting.jsonだと下記のようにすればOK。

setting.json

良きCode Snifferライフを。