PHP代码风格检查

1.本地检查及修复工具

# 工具名为PHP_CodeSniffer,项目地址为https://github.com/squizlabs/PHP_CodeSniffer,其中phpcs.phar为检查工具,phpcbf.phar为修复工具

2.安装

1.curl安装
curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar
curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcbf.phar
2.wget安装
wget https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar
wget https://squizlabs.github.io/PHP_CodeSniffer/phpcbf.phar
3.composer安装
composer global require "squizlabs/php_codesniffer=*"
4.phive安装
phive install phpcs
phive install phpcbf
5.pear安装
pear install PHP_CodeSniffer
6.git clone
git clone https://github.com/squizlabs/PHP_CodeSniffer.git

3.设置

1.设置标准(一般采用PSR2)
php phpcs.phar --config-set default_standard PSR2
# 查看已经安装的标准
php phpcs.phar -i
2.设置字符集
php phpcs.phar --config-set encoding utf-8

4.使用

1.默认检测
php phpcs.phar /path/to/file.php
php phpcs.phar /path/to/directory
2.PSR2检测
# 默认不指定standard参数,则PSR1生效,而PSR1很多规则已经废弃不再适用,我们一般采用PSR2检测风格
php phpcs.phar --standard=PSR2 /path/to/file.php
php phpcs.phar --standard=PSR2 /path/to/direcotry
3.修复
# 检测出的问题可通过自带工具自动修复,不过我一般手动,原因你懂的
php phpcbf.phar /path/to/file.php
php phpcbf.phar /path/to/directory

5.与git集成

# 通过与git集成可以达到若检测不通过,将无法提交代码的效果
1.编辑pre-commit钩子
# 打开当前项目的.git/hooks目录,里面有很多xxx.sample文件,其中一个就是pre-commit.sample
cp pre-commit.sample pre-commit && vim pre-commit
2.将pre-commit的内容替换如下
wget https://evernote-1258366890.cos.ap-guangzhou.myqcloud.com/1911061541.sh