PHP_CodeSnifferは、コードスタイル検出ツールです。2つのPHPスクリプトで構成されています。
-
phpcsスクリプトは、PHP、JavaScript、およびCSSファイルの一連のコード仕様(通常はPHPのPSR2などの公式コード仕様を使用)を定義します。これにより、コード仕様に準拠していないコードを検出し、警告またはエラー(エラーレベル)を発行できます。設定可能)。
-
phpcbfスクリプトは、コード形式の非準拠部分を自動的に修正できます。たとえば、PSR2仕様では、すべてのPHPファイルの最後に空白行が必要であるため、このスクリプトを実行すると、最後に空白行が自動的に追加されます。
-
PHP_CodeSnifferは、コードをクリーンで一貫性のある状態に保つために不可欠な開発ツールです。
請求
PHP_CodeSnifferにはPHP5.4.0以降が必要ですが、単一のスニフには外部アプリケーションやスクリプトなどの他の要件がある場合があります。これらの要件のリストについては、「構成オプション」のマニュアルページを参照してください。
チームの一部としてPHP_CodeSnifferを使用する場合、またはCIサーバーで実行している場合は、構成ファイルを使用してプロジェクトの設定を構成する必要がある場合があります。
インストール
#curlcurl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcbf.phar#を使用してダウンロードするか、wgetwget https:// squizlabsを使用してダウンロードします。 github.io/PHP_CodeSniffer/phpcs.phar wget https://squizlabs.github.io/PHP_CodeSniffer/phpcbf.phar#次に、ダウンロードしたPHARsphp phpcs.phar -h php phpcbf.phar- h1234567891011をテストします。
作曲
Composerを使用している場合は、次のコマンドを使用してシステム全体にPHP_CodeSnifferをインストールできます。composer global require "squizlabs/php_codesniffer=*"
コンポーザーのbinディレクトリがPATHに含まれていることを確認してください。デフォルト値は〜/ .composer / vendor / bin /ですが、実行することで使用する必要のある値を確認できます。composer global config bin-dir --absolute。
または、squizlabs / php_codesnifferはcomposer.jsonファイルに依存関係を含めます。例えば:
{ “ require-dev”:{ “ squizlabs / php_codesniffer”:“ 3. *” }} 12345
次に、ベンダーのbinディレクトリからPHP_CodeSnifferを実行できるようになります。
./vendor/bin/phpcs -h./vendor/bin/phpcbf -h12
ギット
PHP_CodeSnifferソースコード、phpcs、phpcbfをダウンロードして実行し、Gitクローンから直接コマンドを実行することもできます。
git clone https://github.com/squizlabs/PHP_CodeSniffer.git cd PHP_CodeSniffer php bin / phpcs -h php bin / phpcbf -h