PHP_CodeSniffer の使い方

PHP_CodeSniffer は、2つのコマンドで構成されています。

PHP_CodeSniffer をインストールする方法はいろいろありますが、Composer を使っている場合は Composer を使ってインストールするのが楽だと思います。 Composer を使って PHP_CodeSniffer をインストールするには、下記のコマンドを実行するだけです。 基本的には開発環境で使うツールだと思うので、--dev オプションを付けておきましょう。 Composer の使い方がわからないという方は、まずは「Composer の使い方（その１：概要）」を参考にしてください。

php composer.phar require --dev "squizlabs/php_codesniffer"

.\vendor\bin\phpcs -h

.\vendor\bin\phpcbf -h

1つのファイルを検査する場合は、検査したいファイル名を指定します。 検査したいファイル名はスペース区切りで複数指定できます。

.\vendor\bin\phpcs .\src\hoge.php

.\vendor\bin\phpcs .\src\hoge.php .\src\fuga.php

複数のファイルを検査する場合は、検査したいディレクトリ名を指定します。 検査したいディレクトリ名はスペース区切りで複数指定できます。

.\vendor\bin\phpcs .\src

.\vendor\bin\phpcs .\src .\tests

PHP_CodeSniffer を実行した際に表示される指摘点には、その内容によって ERROR と WARNING の2種類があります。 指摘点が大量に出る場合など、ERROR だけを表示して、WARNING を非表示にしたい場合もあると思います。 その場合は、-n オプションを付けます。

.\vendor\bin\phpcs -n .\src

デフォルトでは出力内容には色が付いていないので白黒な画面になってしまうと思われますが、この出力内容に色を付けることができます。 色が付いていると ERROR や WARNING などが発生した場合にわかりやすくなります。 色を付けるには --colors オプションを付けます。

.\vendor\bin\phpcs --colors .\src

   2 | ERROR   | [ ] Missing file doc comment
   4 | WARNING | [ ] Line exceeds 85 characters; contains 95
     |         |     characters

大量のファイルがある場合などでは、進捗状況が表示されていた方が便利かもしれません。 その場合は、-p オプションを付けます。 -p オプションを付けるとコマンドの出力の最初に実行結果が表示されます。

.\vendor\bin\phpcs -p .\src

E.E.EEWEE.EEWEEEEE.EEEEESEEEEEEEEEEE......EEEEEEEEEEEEEEE..E 60 / 76 (79%)
........E.......                                             76 / 76 (100%)

E は ERROR、W は WARNING、S は SKIP の意味です。

PHP_CodeSniffer で使用できるコーディング規約の一覧を表示するには -i オプションを使用します。

.\vendor\bin\phpcs -i

The installed coding standards are MySource, PEAR, PSR1, PSR12, PSR2, Squiz and Zend

コーディング規約を変更する場合は、--standard オプションを使用します。

.\vendor\bin\phpcs --standard=PSR12 .\src

ruleset.xml を使用する方法は2つあります。

.\vendor\bin\phpcs --standard=.\custom_ruleset.xml .\src

ruleset.xml は拡張子を見ればわかるとおりXMLファイルです。 ruleset タグをルートとし、その中に設定内容のタグを記述していきます。 rule タグの ref 属性で使うルールの名前を指定し、そのタグの中にそのルールの設定を記述していく感じです。 XMLなのでコメントも書けます。

どんなルールがあるか、どんな設定が使えるかは、ここでは記載しません。 あまりにも大量にありますので、英語ですが公式のドキュメントを見てもらった方が良いと思います。

• Annotated Ruleset · squizlabs/PHP_CodeSniffer Wiki · GitHub
• Customisable Sniff Properties · squizlabs/PHP_CodeSniffer Wiki · GitHub

ちなみにですが、公式のドキュメントに全てのルールが書かれているわけではないので注意してください。 もし全て知りたければ、PHP_CodeSniffer のソースコードを見てください。

ここでは簡単な例だけ記載しておきます。

<?xml version="1.0"?>
<ruleset name="CustomStandard">

	<!-- PSR-12のルールを全て適用 -->
	<rule ref="PSR12">

		<!-- 但し、タブでのインデントを禁止するルールは適用しない -->
		<!-- ※ つまり、タブでのインデントを許可する -->
		<exclude name="Generic.WhiteSpace.DisallowTabIndent"/>

	</rule>

	<!-- 1行の文字数が120文字以上で警告、160文字以上でエラー -->
	<rule ref="Generic.Files.LineLength">
		<properties>
			<property name="lineLimit" value="120" />
			<property name="absoluteLineLimit" value="160" />
		</properties>
	</rule>

</ruleset>

phpcs コマンドに、-s オプションを付けると、メッセージの後に違反したルールの名前を表示してくれます。 どのルールが動作したのかが確認しやすくなりますので、独自のコーディング規約を使用する際には便利でしょう。

.\vendor\bin\phpcs -s .\src

  4 | ERROR | [x] Header blocks must be separated by a single blank
    |       |     line (PSR12.Files.FileHeader.SpacingAfterBlock)
 26 | ERROR | [x] Blank line found at start of control structure
    |       |     (Squiz.WhiteSpace.ControlStructureSpacing.SpacingAfterOpen)