MacでWordPressのコーディング規約違反を自動で検出する方法

WordPressのコーディング規約は割と特殊だ。

例えばif文の書き方一つにしても

↑は正しく、

↑はコーディング規約違反である。()の中は前後一文字のスペースを入れるのが規約だからだ。

こういう細かいのをレビュー時に人出で潰すのは馬鹿げている。

エディターで書いている途中で自動で検出できるようにする。

環境

Macが前提です。UbuntuやWIndowsは適宜読み替えてくれ。

コーディング規約違反をすると、下記のようにエラーが出る。

エラー文に従い直していけば、自然と規約を守ったコーディングができるようになる。レビュー時に規約について気にする必要がなくなり、ロジックのレビューに集中できるのが良い。

Command + Shift + Xで拡張機能画面を開く。

phpcs と検索し、Ioannis Kappas の方をインストール。

Command + , で設定を開く。

「設定の検索」フィールドに、phpcsと入力。ユーザーに設定すると全てのコードに適用されてしまうため、ワークスペース単位で設定するのを推奨する。

「settings.jsonで編集」をクリック。

settings の項目に下記を入力。ユーザー名は各々の環境で置き換える。

phpcs.standardの部分をPSR2などに変更すると、別の規約に変更できる。

問題タブにエラー内容が出るようになる。

チーム開発でphpcsを必須にすれば、一定の品質を維持できる。コーディング規約なんてだいたい守れないので、ツールで自動化した方が良い。

phpcsを使うと

おすすめ。チーム開発時に是非導入してくれ。