安装使用 Composer

1
composer global require "squizlabs/php_codesniffer=*"

~/.composer/vendor/bin/ 添加到 PATH 环境变量中

使用

查看帮助

1
phpcs --help

添加标准:

1
phpcs --config-set installed_paths PATH_TO_SEARCH_STANDARDS

查看已经安装的标准

1
phpcs -i

查看配置

1
phpcs --config-show

检查代码规范

1
2
3
phpcs ./codes/Example.php
// or
phpcs ./codes/

指定标准

1
phpcs ./codes/Example.php --standard=PSR2

指定报告格式

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

可用的格式有(默认为: full):

1
2
3
full, xml, checkstyle, csv
json, emacs, source, summary, diff
svnblame, gitblame, hgblame or notifysend

修复代码

第一种:使用 diff 形式打补丁

1
2
3
phpcs --report-diff=/path/to/changes.diff /path/to/code
patch -p0 -ui /path/to/changes.diff
# patching file /path/to/code/file.php

第二种:使用 PHP Code Beautifier 和 Fixer

1
phpcbf /path/to/code

以上命令会自动修复原文件,如果不想直接覆盖原文件,可以使用 –suffix 指定修复后的代码后缀:

1
phpcs /path/to/code --suffix=.fixed