PHP 代码规范报告以及自动修复工具

两款代码规范报告和修复工具 PHP Coding Standards Fixer、PHP_CodeSniffer 的简单安装和使用说明。

PHP Coding Standards Fixer

PHP 版本需要大于等于 5.6.0

对 Atom、NetBeans、PhpStorm、Sublime Text、Vim 等编辑器有插件

PHP Coding Standards Fixer 官网

安装

wget http://cs.sensiolabs.org/download/php-cs-fixer-v2.phar -O php-cs-fixer
chmod a+x php-cs-fixer
mv php-cs-fixer /usr/local/bin/php-cs-fixer

composer 方式可查看官网

升级

php php-cs-fixer self-update

composer 方式可查看官网

使用

直接修复指定文件

php php-cs-fixer fix /tmp/ArticlesController.php

修复目录下的所有文件

php php-cs-fixer fix /tmp

指定修复规范规则。默认 PSR1、PSR2

# 指定 PSR2 规则
php php-cs-fixer fix /tmp/ArticlesController.php --rules=@PSR2
# 指定多个规则
php php-cs-fixer fix /tmp/ArticlesController.php --rules=@Symfony,@PSR1,@PSR2

缓存。默认使用缓存

# 不使用缓存
php php-cs-fixer fix /tmp/ArticlesController.php --using-cache no

不实际修复文件,只查看要修复的报告差异

php php-cs-fixer fix /tmp/ArticlesController.php --dry-run --diff

PHP_CodeSniffer

PHP 版本需要大于等于 5.4.0

命令的使用可以通过 -h 参数进行查看帮助。

PHP_CodeSniffer 除了下面我所罗列的安装、查看报告、设置编码标准、文件修复等,还可以设置设置报告的级别、编码,并且通过设置可以检查 JavaScript、CSS 问题。详情可查看 PHP_CodeSniffer WIKI

安装

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

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

composer 方式可以查看 PHP_CodeSniffer 安装官方文档

查看报告

# 指定单个文件
phpcs /tmp/ArticlesController.php
# 指定目录
phpcs /path/to/code 

打印差异报告

打印差异报告

phpcs --report=diff /tmp/Controllers/ArticlesController.php

输出差异报告到指定文件

phpcs --report-diff=/tmp/changes.diff /tmp/ArticlesController.php

查看已经安装的编码标准

phpcs -i

指定编码标准

phpcs --standard=PEAR /tmp/ArticlesController.php
phpcs --standard=PEAR,Squiz /tmp/ArticlesController.php

使用 PSR2 编码标准对文件进行修复

phpcbf -w --standard=PSR2 /tmp/ArticlesController.php
知识共享许可协议
本作品采用知识共享署名-非商业性使用-禁止演绎 4.0 国际许可协议进行许可。
随喜
支付宝随喜
微信随喜

😄

不错不错

后三排

😄

引用

😁

后三排

不错不错

引用

😄