PhpStormでCodeSnifferを設定し使ってみる（Windows版)

最近WordPressのプラグインを作成し始めました。
最終的にはWordPressの公式ディレクトリに登録しようと思うので、WordPress コーディング規約を守らないといけません。

そこでCodeSnifferをインストールし、普段使っているPhpStormで使用できるように設定を行いました。

調べてみると、PHP CodeSnifferをインストールするには、Composerが必要なようです。

まじかー

Windowsではあまり使わないので入れたくないのですが、仕方がありません。
入れます。

ComposerのWindowsへのインストールは、長くなるので、こちらの記事に分けました。

ではサクッと、CodeSnifferをインストールしてみましょう。

コマンドプロンプトから、次のコマンドを実行します。

squizlabs/PHP_CodeSniffer | GitHubにある、Composerでのインストール方法をそのまま実行します。

少し時間がかかります…

CodeSnifferどこにダウンロードされた？

どうやら、C:\Users\ユーザーフォルダ\AppData\Roaming\Composer\vendorにダウンロードされたようです。

実際に動作するか確認してみましょう。

バージョン情報が表示されれば、インストールされています。

WordPressは独自のコーディング規約があるので、CodeSnifferもそれに合わせたチェックをする必要があります。

そのために、Wordpressのコーディング規約をインストールします。
WordPress Coding Standards for PHP_CodeSniffer

(1) コマンドプロンプトを開く

(2) ダウンロードするフォルダを作成して、その中に移動する。

(3) composerでダウンロードする

Created project in D:\wpcs\wpcs

wpcsフォルダの中に、wpcsフォルダができてしまった…

ダウンロードしただけだと思うので、 D:\wpcs\wpcsの中身を、 D:\wpcsに移動しました。

(4) CodeSnifferに、Wordpressのコーディング規約を認識させる。

(5) 確認

WordPressが追加されていればOK

(1) 設定画面から、言語フレームワーク > PHP > 品質ツール を選択する。

(2) Code Sniffer欄の...をクリックし、Code Sniffer設定画面を開く

(3) PHP Code Sniffer pathに、「phpcs.bat」を入力

(4) 検証を押し、次のように表示されたらOK

表示されない場合、phpcs.batへのパスが通っていない可能性が高い。
パスを通すか、フルパスで指定する。

フルパス：
C:\Users\ユーザーフォルダ\AppData\Roaming\Composer\vendor\bin\phpcs.bat

(5) Path to phpcbfに、「phpcbf.bat」または、phpcbf.batへのフルパスを指定する。

(6) 設定画面から、エディター > インスペクション を選択する。

(7) 中央の選択欄から、PHP > Quality Tools を開き、「PHP Code Sniffer 検証」にチェックを入れる。

(8) オプションのCoding stabdardから、WordPressを選択する。（Wordpressの規約チェックを行う場合）

ここまでの設定を行うと、Code Snifferが自動で検証してくれます。

そして表示された、悲しいメッセージ…

phpcs:Too many messages per file,only first 50 errors/warnings are shown

ファイルごとのメッセージが多すぎる、最初の50個のエラー/警告のみが表示されます

自動で修正する

手作業での修正は時間がかかってしまうので、Code Snifferのphpcbfを使って、自動整形を行います。

phpcbfコマンドは、Code Sniffer設定画面で、設定してあります。
確認してみてください。

自動整形は、コードのクリーンアップで行います。

メニュー：コード(C) > コードのクリーンアップ(C)

どの範囲でクリーンアップするか指定する画面がでるので、指定してOKを押します。

これで自動整形される…はずです。

OneDrive管理下のフォルダはNG

私の場合、ソースをOneDrive管理下のフォルダに置き、自動でバックアップできるようにしています。

しかしPHPは、OneDrive管理下のフォルダにアクセスできないようです。

回避策として、一度別のフォルダにコピーしてからphpcbfコマンドを実行し、終わったらもとに戻します。

(1) 作業用のフォルダを作成

OneDrive外で、確実にアクセスできるフォルダを作成する

(2) 次のファイルを、パスの通っているComposer\vendor\binフォルダに作成します。

ファイル名：pre_phpcbf.bat

(2) 外部ツールに登録

1.設定画面 > ツール > 外部ツール

2.+で追加

3. ツールの編集画面

名前、説明：適当に！

プログラム： pre_phpcbf.bat

引数：--standard=WordPress --encoding=utf-8 --extensions=php,js,css,inc "$FilePath$"

作業ディレクトーリー：作成した作業フォルダ

(3) メニュー：ツール > External Tools > 作成したツールを実行

(4) phpcbf.batが実行されます。

ただし、作成したバッチファイルはCode Snifferの終了コードなどをチェックしていないので、なんらかの問題がでるかもしれません。

実行後はソースを確認してください。

Code Sniffer設定画面のPHP Code Sniffer pathをpre_phpcbf.batに変更ししてもいいのですが、PhpStormが他にも何か作業をしているようで、時々めちゃくちゃ遅くなります。

外部ツールとして使用したほうが、良さそうです。

蛇足ですが、先ほどのバッチファイルの解説をしておきます。

コマンドのメッセージ出力をオフにします

コマンドが呼び出された時の、全てのパラメーターを変数に保存しています。

phpcbf.bat --standard=WordPress --encoding=utf-8 --extensions=php,js,css,inc c:/user/aaa/OneDrive/xxx.php
青文字部分が保存されます。

作業フォルダを変数に保存しています。
適宜、変更してください。
（最後の\必須）

保存した全てのパラメーターから、最後のパラメータを取り出すサブルーチンを呼び出しています。

遅延環境変数（!)を有効にしています。

実行時に受け取ったパラメータ列を置換しています。

変数の置換：
!環境変数:置換する文字=置換後の文字!

FULLPARAM：PhpStormから受け取った、全パラメータ
PHPFILEFULL：最後のパラメーター（c:/user/aaa/OneDrive/xxx.php）
BACHTMPDIR：作業フォルダ（d:\temp\)
PHPFILE：最後のパラメータからファイル名を抽出したもの（xxx.php）

つまり、
--standard=WordPress --encoding=utf-8 --extensions=php,js,css,inc c:/user/aaa/OneDrive/xxx.php
を
--standard=WordPress --encoding=utf-8 --extensions=php,js,css,inc d:\temp\xxx.php
に置換しています。

c:/user/aaa/OneDrive/xxx.php
を
c:\user\aaa\OneDrive\xxx.php
に置換しています。

ここから、コマンドのメッセージを出力する。
必要なければ削除

PhpStorm上のファイルを、作業フォルダにコピー

作業フォルダにコピーしたファイルに対して、phpcbf.batを実行

phpcbf.batでecho offされているので、onしておく。

処理後のファイルを、PhpStorm上にコピー

処理終了

サブルーチンの開始

一番目のパラメータをセット

一番目のファイル名をセット。

一番目のパスをセット。
/は、\で取得される

パラメーターをずらす。
（2番目のパラメーターが一番目にずれる。）

パラメーターが残っていたら、サブルーチンの最初に戻る

処理終了。
呼び出し元に戻る。