PHP CodeSnifferを利用して規約遵守のコードを書く

コードが汚い

現在はプログラミング学習中という名目で、自分の書くコードはとにかく汚い。しかし、人間の能力で書き方をチェックしていては時間がかかるし、何よりこのエネルギーがあれば、学習そのものに使いたい。

これを何とかしなければと思い、今回PHP CodeSniffer(PHPCS)というコード規約のチェックツールを導入することにした。

PHPCSのインストール

現在、自分の使用しているエディターはVisual Studio Code(VSCode)だ。一時期Atomを使用していたが、画面内のターミナルの表示が上手くいかず、最近乗り換えた。

VSCodeも拡張機能でPHPCSを使用することができる。しかし、事前に自分の開発環境に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.

phpとcomposerはインストール済みなので、単純なインストール作業だけで良いだろう。Homebrewのinstallコマンドで実行することにした。

$ brew install php-code-sniffer

バージョン確認は-vでは出来ない。--versionと記述する。

$ phpcs --version
PHP_CodeSniffer version 3.2.3 (stable) by Squiz (http://www.squiz.net)

この後、VSCode内で拡張機能であるPHPCSをインストールする。これは、VSCodeの拡張機能メニューから簡単に作業ができる。

コード規約の適用

今回使用する規約はPSR-2だ。Laravelでも採用されているらしい。PHPの規約に関するあれこれは、こちらの記事がわかりやすい。

PHPコーディング規約まとめ

⌘（コマンド）＋,（カンマ）でユーザー設定の編集が可能だ。右側のユーザー設定欄に以下のコードを追記する。

"phpcs.standard": "PSR2"

ちなみに以下のサイト様は、自分の記事よりずっとわかりやすい。図入りで丁寧に解説されている。

[PHP]Visual Studio Codeを使ってphpcsによるPSR-2規約チェックを行う方法

VSCodeを再起動すれば、設定が適用される。

そして、コードを記述して規約違反があれば、赤い波線が現れる。その波線にカーソルを合わせると、違反内容が表示される仕組みだ。

このツールを使用し、少しでも整ったコードを書けるように努めよう。

今回はここまで。