PHP_CodeSnifferとは何ですか?インストール方法と使用方法は?

この記事では、PHP_CodeSniffer とそのインストールおよび使用方法のチュートリアルを紹介します。一定の参考値があるので、困っている友達が参考になれば幸いです。

PHP_CodeSniffer は、自動化された PHP コード仕様チェック ツール です。

CodeSniffer 組み込み MySource、PEAR、PHPCS、PSR1、PSR2、 Squiz や Zend などのコード仕様のいくつかのセット。

もちろん、 独自のコード仕様を追加することもできます。

PHP_CodeSniffer ウェアハウス アドレス:
• https://github.com/squizlabs/PHP_CodeSniffer
PHP_CodeSniffer バージョン リリース アドレス:
• http://pear. php.net/package/PHP_CodeSniffer

PHP_CodeSniffer には 2 つのツールが含まれています。

phpcs は コード仕様のチェックに使用されます、 phpcbf は、コード仕様を修正するために使用されます。

1 インストール

PHP_CodeSniffer をインストールするにはいくつかの方法があります。

1.1 実行可能ファイルによるインストール

git コマンドを使用してウェアハウスのソース コードをダウンロード (または直接ダウンロード) し、直接実行します:

git clone https://github.com/squizlabs/PHP_CodeSniffer.git
cd PHP_CodeSniffer
php bin/phpcs -h
php bin/phpcbf -h

非を使用するには- 最新バージョンは、アドレス http://pear.php.net/package/PHP_CodeSniffer/download

の PEAR からダウンロードできます。たとえば、

2.9.1# を使用します。 ## PEAR をダウンロードした後、解凍します。実行されたコマンドは: <div class="code" style="position:relative; padding:0px; margin:0px;"><pre class="brush:php;toolbar:false">php scripts/phpcs -h php scripts/phpcbf -h</pre><div class="contentsignin">ログイン後にコピー</div></div> githuh ダウンロードとは異なり、実行ファイルは

scripts

ディレクトリにあります。

1.2 phar ファイルのインストール方法

phar は、サービス用に php ファイルを 1 つのファイルにパッケージ化する

php archive

でもあります。 Linux システムでは、次のコマンドを使用して phar ファイルをダウンロードします。

curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar
curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcbf.phar

Windows システムの場合は、ブラウザを使用して上記の 2 つのリンクにアクセスし、2 つの phar ファイルをダウンロードします。

次に、phar ファイルのディレクトリで実行します:

php phpcs.phar -h
php phpcbf.phar -h

phpcs と phpcbf のヘルプ情報が表示され、インストールが成功したことがわかります。

注:

このメソッドでは、php 実行可能ファイルが PATH 環境に追加されていることを確認する必要があります。それ以外の場合は、絶対ディレクトリを指定する必要があります。
実行するたびに、これら 2 つの
• .phar ファイルを対応するディレクトリに配置してから、## を実行する必要があります。そのディレクトリ内の #php phpcs.phar xxxラインコマンド
1.3 pear のインストール方法

pear がローカルにインストールされている場合(pear インストール方法

)、pear を使用して PHP_CodeSniffer をインストールすることもできます。コマンド:

pear install PHP_CodeSniffer

pear を使用してインストールした後、CodeSniffer 仕様ファイルは次の場所にインストールされます: /path/to /pear/PHP/CodeSniffer /src/Standards。

1.4 Composer のインストール方法

composer のインストールも非常に便利です。コマンド 1 つで実行できます:

composer global require "squizlabs/php_codesniffer=*"

手順:

composer コマンドは、PATH 環境変数に指定する必要があります。 は、composer.json ファイルでも使用できます:

{
    "require-dev": {
        "squizlabs/php_codesniffer": "3.*"
    }
}

完了後にコマンドを実行します:

./vendor/bin/phpcs -h
./vendor/bin/phpcbf -h

1.5 phpcs を設定し、直接実行します。コマンドラインで

上記の方法のうち、pear インストール方法を除き、他の方法で phpcs

コマンドを実行したい場合は、先頭に php を追加する必要があります。

Linux によって提供されている場合、php 実行ファイルのパスはすでに環境 PATH

にあるため、

bin (または scripts) のパスを追加します。 ) PATH を使用すると、ターミナルで phpcs コマンドを実行できます。 しかし、Windows システムでは、phpcs.bat

ファイルが実際に実行され、このファイルは同じディレクトリ内の

phpcs ファイルを参照します。 CMD で phpcs コマンドを正しく実行するには、phpcs.bat で 2 つの変数を構成する必要があります。

次のように、

php.exe

および

phpcs ファイルの絶対場所を指定する必要があります:

if "%PHPBIN%" == "" set PHPBIN=D:\php56n\php.exe
if not exist "%PHPBIN%" if "%PHP_PEAR_PHP_BIN%" neq "" goto USE_PEAR_PATH
GOTO RUN
:USE_PEAR_PATH
set PHPBIN=%PHP_PEAR_PHP_BIN%
:RUN
"%PHPBIN%" "D:\www\PHP_CodeSniffer-2.9.1\scripts\phpcs" %*

次に、パス D を変更します。 \www\PHP_CodeSniffer-2.9 PATH に .1\scripts\ を追加すると、CMD で phpcs が実行できるようになります。

注: phpcbf にもそのような変更が必要です。

2

の使用 上記では、PHP_CodeSniffer に 2 つのコマンドがあることがわかります。

デフォルトでは、PHP_CodeSniffer は PEAR 仕様を使用してコードをチェックします。

2.1 コマンドを使用する

次のコマンドは、デフォルトの仕様を使用してファイルとディレクトリをチェックします。

$ phpcs /path/to/code/myfile.php                        # 检查文件
$ phpcs /path/to/code                                   # 检查目录和子目录下的所有文件
$ phpcs -l /path/to/code                                # 检查目录下的所有文件，不包括子目录
$ phpcs /path/to/code/myfile.inc /path/to/code/my_dir   # 检查文件和目录

2.2 チェック結果

デフォルトでは、チェック結果には次のようなエラーと警告が含まれます:

$ phpcs /path/to/code/myfile.php

FILE: /path/to/code/myfile.php
--------------------------------------------------------------------------------
FOUND 5 ERROR(S) AND 1 WARNING(S) AFFECTING 5 LINE(S)
--------------------------------------------------------------------------------
  2 | ERROR   | Missing file doc comment
 20 | ERROR   | PHP keywords must be lowercase; expected "false" but found
    |         | "FALSE"
 47 | ERROR   | Line not indented correctly; expected 4 spaces but found 1
 47 | WARNING | Equals sign not aligned with surrounding assignments
 51 | ERROR   | Missing function doc comment
 88 | ERROR   | Line not indented correctly; expected 9 spaces but found 6
--------------------------------------------------------------------------------

如果不要显示警告，加个-n参数：

$ phpcs -n /path/to/code/myfile.php

仅显示检查结果概要：

$ phpcs --report=summary /path/to/code

2.3 指定规范

可以使用 -- standard参数指定一个或多个规范来检查。

$ phpcs --standard=PEAR /path/to/code/myfile.inc                      # 使用内置规范
$ phpcs --standard=/path/to/MyStandard /path/to/code/myfile.inc       # 使用指定路径下的规范
$ phpcs --standard=PEAR,PHPCS,/path/to/MyStandard file.php            # 使用多个规范

$ phpcs --config-set default_standard Squiz                           # 修改默认规范为Squiz（原本是PEAR）

查看现有规范：

$ phpcs -i

2.4 查看帮助

$ phpcs -h

推荐学习：《PHP视频教程》

以上がPHP_CodeSnifferとは何ですか?インストール方法と使用方法は?の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。