PHP CodeSniffer
CodeSnifferとは
phpにおいて広く普及しているlinter
以下のツールで構成される
・PHP Code Sniffer
phpcsスクリプトを実行し、設定したコーディング規約に基づいてコードをチェックする
・PHP Code Beautifier and Fixer
phpcbfスクリプトを実行し、設定したコーディング規約に基づいてコードを整形する
linter
ソースコードを読み込んで内容を分析し、問題点を指摘してくれる静的解析ツール
インストール
composer require squizlabs/php_codesniffer
phpcsコマンド
コマンド | 機能 | 備考 |
---|---|---|
phpcs --version | バージョン表示 | |
phpcs | カレントディレクトリ配下のチェック | |
phpcs 〜.php | 特定ファイルのチェック | |
phpcs --standard=PSR2 | PSR-2の規約でチェック | |
phpcs --standard=〜/ruleset.xml | コーディングる規約ファイルの設定 |
phpcbfコマンド
コマンド | 機能 | 備考 |
---|---|---|
phpcbf | カレントディレクトリ配下の整形 | |
phpcbf 〜.php | 特定ファイルの整形 | |
phpcbf --standard=〜/ruleset.xml | コーディングる規約ファイルの設定 |