PHP_CodeSniffer
3.7.2
警告
このリポジトリは放棄されました。その後継者はPHPCSSTANDARDS/PHP_CODESNIFFERです
詳細については、問題＃3932を参照してください。
PHP_CODESNIFFERは、2つのPHPスクリプトのセットです。 PHP、JavaScript、およびCSSファイルをトークン化して定義されたコーディング標準の違反を検出するメインphpcsスクリプトと、コーディング標準違反を自動的に修正する2番目のphpcbfスクリプトを検出します。 PHP_CODESNIFFERは、コードが清潔で一貫性を保つことを保証する重要な開発ツールです。
PHP_CODESNIFFERにはPHPバージョン5.4.0以上が必要ですが、個々のスニフには外部アプリケーションやスクリプトなどの追加要件がある場合があります。これらの要件のリストについては、構成オプションマニュアルページを参照してください。
Php_codesnifferをチームの一部として使用している場合、またはCIサーバーで実行している場合は、構成ファイルを使用してプロジェクトの設定を構成することをお勧めします。
php_codesnifferを開始する最も簡単な方法は、各コマンドのPHARファイルをダウンロードすることです。
# Download using curl curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcbf.phar # Or download using wget wget https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar wget https://squizlabs.github.io/PHP_CodeSniffer/phpcbf.phar # Then test the downloaded PHARs php phpcs.phar -h php phpcbf.phar -h
Composerを使用する場合、次のコマンドでPHP_CodesNifferシステム全体をインストールできます。
作曲家グローバルには「squizlabs/php_codesniffer =*」が必要です
あなたの道に作曲家のビン・ディールがあることを確認してください。デフォルト値は~/.composer/vendor/bin/ですが、 composer global config bin-dir --absoluteを実行して使用する必要がある値を確認できます。
または、 squizlabs/php_codesnifferの依存関係をcomposer.jsonファイルに含めます。例えば：
{"require-dev"：{"squizlabs/php_codesniffer"： "3.*"}
}その後、ベンダービンディレクトリからphp_codesnifferを実行できます。
./vendor/bin/phpcs -h ./vendor/bin/phpcbf -h
Phiveを使用する場合、次のコマンドを使用してPHP_CodesNifferをプロジェクトツールとしてインストールできます。
Phive Install PHPCS Phiveインストールphpcbf
その後、ツールディレクトリからphp_codesnifferを実行できます。
./tools/phpcs -h ./tools/phpcbf -h
Pearを使用する場合は、Pear Installerを使用してphp_codesnifferをインストールできます。これにより、 phpcsとphpcbfコマンドがすぐに使用可能になります。 PEARインストーラーを使用してphp_codesnifferをインストールするには、最初に梨をインストールしてから次のコマンドを実行してください。
梨インストールphp_codesniffer
PHP_CODESNIFFERソースをダウンロードして、Gitクローンからphpcsおよびphpcbfコマンドを直接実行することもできます。
git clone https://github.com/squizlabs/php_codesniffer.gitcd php_codesniffer php bin/phpcs -h php bin/phpcbf -h
PHP_CODESNIFFERで使用されるデフォルトのコーディング標準は、PEAR CODING標準です。梨コーディング標準に対してファイルを確認するには、ファイルの場所を指定するだけです。
phpcs/path/to/code/myfile.php
または、ディレクトリ全体を確認する場合は、ファイルの代わりにディレクトリの場所を指定できます。
phpcs/path/to/code-directory
PSR-12コーディング標準に対してコードを確認する場合は、 --standardコマンドライン引数を使用します。
phpcs -standard = psr12/path/to/code-directory
php_codesnifferがコーディング標準エラーを見つけた場合、コマンドを実行した後にレポートが表示されます。
完全な使用情報とサンプルレポートは、使用ページで入手できます。
php_codesnifferのドキュメントは、github wikiで入手できます。
GitHub Issueトラッカーでバグレポートと機能リクエストを提出できます。
情報については、converting.mdを参照してください。
PHP_CODESNIFFERは、 MAJOR.MINOR.PATCHバージョン番号形式を使用します。
MAJORバージョンは次の場合に増加します。
phpcsまたはphpcbfコマンドの使用方法に対して、逆方向に不可能な変更が行われます。
後方互換性のない変更は、 ruleset.xml形式に行われます
Sniff開発者が使用するAPIに対して、後方に不可能な変更が行われます。
カスタムPHP_CODESNIFFERトークンタイプが削除されます
既存のスニフは、php_codesnifferから完全に削除されます
MINORバージョンは次の場合に増加します
新しい後方互換性のある機能がphpcsおよびphpcbfコマンドに追加されます。
後方互換性のある変更は、 ruleset.xml形式に行われます
Sniff Developersが使用するAPIに対して、後方互換の変更が行われます。
新しいスニフが含まれている標準に追加されます
既存のスニフは、含まれている標準から削除されます
注：Sniff開発者が使用するAPIの後方互換の変更により、既存のSniffが致命的なエラーを生成せずに実行を続けることができますが、Sniffが以前に変更されなかったのと同じエラーを報告することができない場合があります。
PATCHバージョンは次の場合にインクリメントされます。
後方互換のバグ修正が行われます
注：PHP_CODESNIFFERが問題を報告および修正するために存在するため、ほとんどのバグは、標準エラーが誤って報告されているか、標準エラーが報告されていない場合に報告されていないコーディングの結果です。これは、php_codesnifferによって作成されたメッセージとそれが作成する修正が、パッチバージョン間で異なる可能性が高いことを意味します。
