PHP_CodeSniffer 是一组两个 PHP 脚本:主脚本 phpcs 对 PHP、JavaScript 和 CSS 文件进行标记,以检测是否违反定义的编码标准;第二个脚本 phpcbf 自动纠正违反编码标准的行为。PHP_CodeSniffer 是一个重要的开发工具,可以确保你的代码保持干净和一致。
安装
pear安装
pear install PHP_CodeSniffer
composer安装
composer global require --dev squizlabs/php_codesniffer
Windows上安装好之后,运行
phpcs --version
查看安装结果
Linux上安装好后,一般情况路径是/tmp/composer/vendor/bin/phpcs
,可以将该路径设置为环境变量
Linux设置环境变量可参考Centos 环境变量配置
检测
执行如下命令
phpcs --standard=PSR12 --report-checkstyle=/workpath/checkstyle-result.xml /workpath/app
可以去掉 --report-checkstyle指令,直接输出结果如下
–standard指定标准,推荐PSR12
可通过phpcs -i
命令查看支持哪些标准–report-checkstyle 将结果输出到文件
/workpath/app 要检测的代码路径
修复
执行如下命令,就会按照PSR12对代码规范化
phpcbf --standard=PSR12 /workpath/app