PHP_CodeSniffer 使用ガイド

ディレクトリ

PHP_CodeSniffer をインストールします

phpcs をインストールします

phpcs は、PHP コード仕様の検出ツールです。

# 下载$ curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar# 加入到命令目录$ mv phpcs.phar /usr/local/bin/phpcs# 赋予执行权限$ sudo chmod +x /usr/local/bin/phpcs# 检验是否成功$ phpcs -h

phpcbf をインストールします

phpcbf は、PHP コード仕様修復ツールです。

# 下载$ curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcbf.phar# 加入到命令目录$ mv phpcbf.phar /usr/local/bin/phpcbf# 赋予执行权限$ sudo chmod +x /usr/local/bin/phpcbf# 检验是否成功$ phpcbf -h

phpcs を使用する

phpcs 構成

1. 詳細な構成を表示します。コマンドを使用します: phpcs --config-show (以下は私の現在の設定です)

colors:                  1default_standard:        PSR2encoding:                utf-8error_severity:          1ignore_errors_on_exit:   1ignore_warnings_on_exit: 1report_format:           summaryreport_width:            autoseverity:                1show_progress:           1show_warnings:           1tab_width:               4warning_severity:        8

2. デフォルトのエンコード標準を設定します。 (これは非常に重要です。PSR2 標準を使用することをお勧めします)

# 查看配置$ phpcs -iThe installed coding standards are MySource, PEAR, PHPCS, PSR1, PSR2, Squiz and Zend# 设置编码标准为 PSR2$ phpcs --config-set default_standard PSR2

3. 警告を非表示にします。 (もちろん、強迫性障害の場合は警告はできません。強迫性障害以外の患者でもこの設定項目を使用できます)

# 隐藏警告提醒$ phpcs --config-set show_warnings 0# 开启警告提醒$ phpcs --config-set show_warnings 1

4. チェックの進捗状況を表示します。 (プロジェクトでさらに多くのファイルをチェックする必要がある場合は、これをオンにできます)

# 显示检查进程$ phpcs --config-set show_progress 1# 关闭进程显示$ phpcs --config-set show_progress 0

5. カラーを表示します。 (自分に色を付けてください)

# 显示颜色$ phpcs --config-set colors 1# 关闭颜色显示$ phpcs --config-set colors 0

6. エラーおよび警告レベルを変更します

# 显示所有的错误和警告$ phpcs --config-set severity 1# 显示所有的错误，部分警告 注意等级可有从 5-8 5 的警告显示会更多，8 的更少$ phpcs --config-set severity 1$ phpcs --config-set warning_severity 5 

7. デフォルトのエンコーディングを設定します。 >

# 设置 utf-8$ phpcs --config-set encoding utf-8

8. タブ幅を設定します

# tab 为 4 个空格$ phpcs --config-set tab_width 4# 也可以对单独文件生效$ phpcs --tab-width=0 /path/to/code

コード検証

1.

# 校验单个文件$ phpcs filename

2. 検証ディレクトリ (例: プロジェクト全体)

＃ 校验目录 注意这个时候别因为 linux 学的太好加个 -R 哈。$ phpcs /path/dir

結果分析

結果の表示形式:

full、xml、checkstyle、csv、json、emacs、source、summary、diff、svnblame、gitblame、hgblame、または Noticesend

表示フォームを指定します:

# 汇总的形式phpcs --report=summary test01.php# json 形式 （个人觉得这个形式更清晰）phpcs --report=json test01.php

コードを修正します

phpcbf を使用します

修正をオーバーライドします

# 直接覆盖$ phpcbf /path/code

中間ファイルを生成します

# 生成新文件$ phpcbf /path/to/code --suffix=.fixed

diff を使用する

# 以 test.php 为例 会生成 test.php.diff 文件$ phpcs --report-diff=test.php.diff test01.php

概要

覚えておいてください、これは単なるツールです。しかし、労働者が自分の仕事をうまくやりたいと思うなら、まず自分の道具を研ぐ必要があります。ここには小さな広告ツールを作成できます。そこには便利なツールがたくさんあります。

チームに適用する必要がある場合は、チームがどのようなフレームワークを使用しているかを確認する必要があります。次に、構成された

エラー レベル

と 警告レベル をフレームワークに従って適切に調整します。 参考リンク

1. PHP_CodeSniffer_wiki

2. 構成オプション