PHP_CodeSniffer

squizlabs/PHP_CodeSniffer: PHP_CodeSniffer tokenizes PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

• 作業の流れ
  • インストール
  • コーディングスタイル一覧
  • 実行
• 新規コーディングスタイル追加
  • 例) WordPress-Coding-Standard
• PhpStormでPHP_CodeSniffer使用

作業はホームディレクトリ実行すると仮定します。

作業の流れ

1. PHP_CodeSnifferインストール
2. コーティング規約インストール(追加)
3. 実行

1 PHP_CodeSnifferインストール

$ composer global require 'squizlabs/php_codesniffer=*'

phpcsコマンドのパスを通す

~/.bash_profileへ下記を記載します。

export PATH=~/.composer/vendor/bin:$PATH

2 インストール済 コーディング規約一覧

$ phpcs -i
// デフォルトでインストール済みのコーディング規約一覧
// The installed coding standards are MySource, PEAR, PSR1, PSR2, Squiz and Zend

3 実行

$phpcs --standard=コーディング規約 ファイルリスト
// 例
$phpcs --standard=WordPress ファイルリスト

より細かく設定するためXMLでルールセットを記載したphpcs.xmlを作成して指定することができます。

$phpcs --standard=phpcs.xml ファイルリスト

コーティング規約インストール(追加)

例としてWordPress-Coding-Standarsをインストールします。

1. WordPress-Coding-Standardsインストール

$ git clone git@github.com:WordPress-Coding-Standards/WordPress-Coding-Standards.git \
      ~/.composer/vendor/squizlabs/php_codesniffer/CodeSniffer/Standards/WordPress

2. WordPress-Conding-Standards登録

$ phpcs --config-set installed_paths ~/.composer/vendor/squizlabs/php_codesniffer/CodeSniffer/Standards/WordPress

3. Appendix エリアス作成(オプション)

~/.bash_profileへ下記を記載します。

alias wpcs="phpcs -p -s -v --standard=WordPress"
alias wpcs="phpcs -p -s -v --standard=WordPress-Core"  // こちらの方が緩い?

4 実行

$ wpcs example.php

PhpStormでPHP_CodeSniffer使用

Languages And Frameworks > PHP > Code Sniffer > ConfigurationでインストールしたPHP_CodeSnifferを指定。

// Composerでグローバルへインストールしたときの例
/Users/shiroshi/.composer/vendor/bin/phpcs

Editor > inspectionsで PHP Code Sniffer Validationをチェックします。