phpcs

PHP_CodeSniffer (略称phpcs) は、コーディング規約チェックツールです。

// phpcsのルール
/phpcs.xml

前作業

Connect-CMSの最新版にアップデートする

Download the latest library using composer(composerで利用ライブラリの最新をダウンロード)

php -d allow_url_fopen=1 composer.phar install
// or 
composer install

PHP_CodeSniffer実行

// プロジェクトルートへ移動
cd /path/to/laravel

// PHP_CodeSniffer実行
./vendor/bin/phpcs --standard=phpcs.xml ./

// composerコマンドでPHP_CodeSniffer実行（上記と同等）
composer phpcs
// or
php composer.phar phpcs

// composerコマンドで任意のファイル or ディレクトリでPHP_CodeSniffer実行（下記パス指定は例です。任意に変更してください）
composer phpcs-any -- app/Plugins/User/Blogs/BlogsPlugin.php

Options

// 要約レポート
./vendor/bin/phpcs --standard=phpcs.xml -s --report=summary ./

// ソース（指摘要約）レポート
// PHP_CodeSnifferは、ファイルで検出された最も一般的なエラーを示す概要レポートを出力できるため、改善のためにコーディング標準の特定の部分を対象にすることができます。
./vendor/bin/phpcs --standard=phpcs.xml --report=source ./

// コードレポート
// PHP_CodeSnifferは、各エラーと警告のコードスニペットを示し、違反が発生したコンテキストを示すレポートを出力できます。
./vendor/bin/phpcs --standard=phpcs.xml -s --report=code ./

// 色付き(Only Linux)
./vendor/bin/phpcs --standard=phpcs.xml -s --report=code --colors ./

// composerコマンドで色付き(Only Linux)
composer phpcs -- --colors

PHP_CodeSnifferの指摘内容を自動的に修正する

PHP_CodeSnifferでPHPCBF CAN FIX THE x MARKED SNIFF VIOLATIONS AUTOMATICALLY と表示された部分は、自動修正可能です。

// プロジェクトルートへ移動
cd /path/to/laravel

// phpcbf で自動修正
./vendor/bin/phpcbf --standard=phpcs.xml ./

// composerコマンドでphpcbf 実行（上記と同等）
composer phpcbf
// or
php composer.phar phpcbf

// composerコマンドで任意のファイル or ディレクトリでphpcbf実行（下記パス指定は例です。任意に変更してください）
composer phpcbf-any -- app/Plugins/User/Blogs/BlogsPlugin.php

参考リンク

• LaravelにPHP_CodeSnifferを導入しコーディング規約（PSR）に沿った記述を行う
  
• PHPCS Reporting
  • PHP_CodeSniffer/wiki/Reporting (Reportingオプションの公式ドキュメント)
• phpcs.xml
  • PHP_CodeSniffer/wiki/Annotated-Ruleset (phpcs.xmlの書き方の公式ドキュメント)
  • PHP_CodeSniffer/wiki/Customisable-Sniff-Properties (phpcsチェックルール一覧の公式ドキュメント)
  • phpcs.xml.dist (phpcs.xmlサンプル)
• PHPCS 除外
  • Ignoring Parts of a File - Advanced Usage - squizlabs/PHP_CodeSniffer Wiki
• Scripts - Composer