引言
在多人开发协作中,每个人的开发风格都不一样,遵循标准的代码规范有利于多人协作,日后的维护成本也低。
PHP_CodeSniffer
基础
这是一个代码风格检测工具,包含两个脚本:phpcs 和 phpcbf
phpcs
检测代码风格
phpcbf
修正代码风格
安装
1 | composer global require "squizlabs/php_codesniffer=*" |
安装完成后会在全局依赖包目录生成 phpcbf 和 phpcs 文件
window 下 是.bat
查看 composer 全局依赖包路径
1 | composer global config bin-dir --absolute |
PhpStorm
配置
位置:file->setting->Tools->External Tools
添加 phpcs
添加 phpcbf
参数说明
Program:全局 composer 依赖包 phpcs/phpcbf 路径
例如我的安装路径为:
1 | /Users/mac/.composer/vendor/bin/phpcs |
Arguments::是$FileDir$/$FileName$
Working directory:是$ProjectFileDir$
使用方法
git 提交时对代码进行检查
Php-cc
PHP code check 利用 git hook、phplint、phpcs,在 code commit 的时候对 php 代码进行语法检测、代码风格检查,如果有问题,不允许提交。github
安装
1 | composer require zhenggui/php-cc |
安装成功后执行
1 | composer exec phpcc install |
该命令会检查 phplint、phpcs 的安装情况,并将 git 原有的 pre-commit 钩子备份,再将 php-cc 的 pre-commit 钩子拷贝至.git/hooks
中。
这样,在 git commit 之前,就会执行 phplint 和 phpcs 检查待提交的文件,如果不满足要求,则会阻止代码提交。
开启 phplint
1 | composer exec -v phpcc config phplint/phpcs true/false |
true 开启, false 关闭
卸载
1 | composer exec -v phpcc remote |