VsCodeにphpcs(PHP Code Sniffer)を導入する手順

phpcsとは

本記事では、PHP Code SnifferをVsCodeに導入して、統一感のあるコーディング環境を構築する手順について紹介します。

phpcsはPHP Code Snifferの略で、設定したルールに基づき、指定したファイルのコーディングスタイルを判定してくれる仕組みです。

導入手順

※事前に、ご自身の端末にcomposerをインストールしておいてください。

composerでPHP Code Snifferをインストールする

composer global require "squizlabs/php_codesniffer=*"

VsCodeのsetting.jsonに以下を追記する

"phpcs.standard": "PSR2", 
"phpcs.executablePath": ""C:\\Users\\ユーザー名\\AppData\\Roaming\\Composer\\vendor\\bin\\phpcs",

以上で設定完了です。

画面イメージ

図のようにインデントの数が誤っている等のコーディング規約に違反した記述をすると、phpcsのエラーが表示され、保存すると自動で規約に即した形で整形してくれます。

まとめ

いかがでしたでしょうか。本記事では、PHP Code SnifferをVsCodeに導入して、統一感のあるコーディング環境を構築する手順について紹介します。phpcsはPHP Code Snifferの略で、設定したルールに基づき、指定したファイルのコーディングスタイルを判定してくれる仕組みです。