PhpStorm で CakePHP のコーディングスタイルを自動チェックする
MacBook Pro Retina Displayモデルが快適です。3年前に買った MacBook Pro より、キーボードが熱くなりにくいと思います。(底面の熱くなりやすさは相変わらずなので、膝にのせての作業は無理ですが…)
本日はCakePHP のコーディングスタイルを PhpStorm で自動チェックする方法をご紹介します。
ツールのインストール
必要なライブラリはすべて PEAR でインストールすることができます。今回MacPortsを使ってPHP5.4をインストールしました。PHPのインストールはうまくいきましたが、PEARがうまくインストールできなかったので、pear.php.netのインストールスクリプトからインストールしました。(Installing PHP 5.4 and 5.3 side by side on Max OSX via MacPorts — Gistが参考になりました)
sudo pear install pear install PHP_CodeSniffer
sudo pear channel-discover pear.cakephp.org
sudo pear install cakephp/CakePHP_CodeSniffer
phpcs -i
# "The installed coding standards are CakePHP, MySource, PEAR, PHPCS, Squiz and Zend"
# などと表示されたらインストール成功ですPhpStorm の設定
Preferences を開いて、「(Project Settings内の)Inspections」を選択し、PHP Code Sniffer varidation をチェックしてください。 PHP Code Sniffer pathを「/opt/local/bin/phpcs」に設定し、Coding standard で「CakePHP」を選択して「OK」で閉じます。phpcs -i では表示されたのにプルダウンにない場合は、すぐ右の再読み込みボタンを押します。
効能
保存操作をしなくても、スクリプトを書きながらでも、上の図のようにスタイル違反を指摘してくれます。
課題?
ビューテンプレートファイル(.ctp)でもファイルの最後にPHPの閉じタグを書いてはいけない (A closing tag is not permitted at the end of a PHP file) と指摘されるのですが、ビューテンプレートはPHPコードのみではないので、書いていいと思うんですよね。
まとめ
PhpStorm でも CakePHP のコーディングスタイルをチェックできるよ！
PhpStorm で今回と同じことをやってみた記事はWeb検索でも見つかりませんでした。Eclipse, NetBeans, Vimとかなら、すでにやっていらっしゃる方がいると思いますが、個人的に調査してまとめていきたいと思います。
