引言

在多人开发协作中,每个人的开发风格都不一样,遵循标准的代码规范有利于多人协作,日后的维护成本也低。

PHP_CodeSniffer

基础

这是一个代码风格检测工具,包含两个脚本:phpcs和phpcbf

phpcs

检测代码风格

phpcbf

修正代码风格

安装

composer global require "squizlabs/php_codesniffer=*"

安装完成后会在全局依赖包目录生成phpcbf 和 phpcs 文件

window下 是.bat

image-20190724233041850

查看composer全局依赖包路径

composer global config bin-dir --absolute

PhpStorm

配置

位置:file->setting->Tools->External Tools

添加 phpcs

image-20190724233326358

添加phpcbf

image-20190724233429626

参数说明

Program:全局composer依赖包phpcs/phpcbf路径

例如我的安装路径为:

/Users/mac/.composer/vendor/bin/phpcs

Program:/Users/mac/.composer/vendor/bin/phpcs

Arguments::是$FileDir$/$FileName$

Working directory:是$ProjectFileDir$

使用方法

image-20190724234143661

git提交时对代码进行检查

Php-cc

PHP code check 利用git hook、phplint、phpcs,在code commit的时候对php代码进行语法检测、代码风格检查,如果有问题,不允许提交。github

安装

composer require zhenggui/php-cc

安装成功后执行

composer exec phpcc install

该命令会检查phplint、phpcs的安装情况,并将git原有的pre-commit钩子备份,再将php-cc的pre-commit钩子拷贝至.git/hooks中。

这样,在git commit之前,就会执行phplint和phpcs检查待提交的文件,如果不满足要求,则会阻止代码提交。

开启phplint

composer exec -v phpcc config phplint/phpcs true/false

true开启, false 关闭

卸载

composer exec -v phpcc remote