版权声明：欢迎转载，请附上原文链接 https://blog.csdn.net/hfut_wowo/article/details/86304342
问题
最近遇到一件事很苦恼。在走读同事的代码时，经常看到不符合代码风格的代码，由于自己对代码有轻微的强迫症，所以看到这些代码就很难受。但是觉得仅仅因为风格就给同事提issue，也不太合适。所以就想，如果有开发流程能自动帮我们做【代码风格检查】这件事就好了。
思路
我们是使用git进行代码管理的。所以很容易想到是否可以在git的work flow中加入该流程。简单了解了下，还真有，那就是git本地的hooks。
git本地的hooks可以帮助我们在代码管理的过程中加入一些自己的动作。而这些都是通过在.git/hooks中加入各种钩子文件来实现的。例如常见的钩子文件有：
| 钩子文件名 | 作用 |
|---|---|
| pre-commit | 钩子在键入提交信息前运行。 它用于检查即将提交的快照，例如，检查是否有所遗漏，确保测试运行，以及核查代码。 如果该钩子以非零值退出，Git 将放弃此次提交 |
| pre-push | 钩子会在 git push 运行期间， 更新了远程引用但尚未传送对象时被调用。 它接受远程分支的名字和位置作为参数，同时从标准输入中读取一系列待更新的引用。 你可以在推送开始之前，用它验证对引用的更新操作（一个非零的退出码将终止推送过程） |
| … | … |
一开始的时候我准备用pre-push钩子，但后来一想，如果用pre-push的话，那么有问题的代码都已经提交到代码仓库里了。这样会造成很多的‘无用’的用来修正代码风格的commit，不太好。所以不如使用pre-commit。这样一看，pre-commit再合适不过了。
语法检查
遵循不重复造轮子的思想，使用[email protected]:overtrue/phplint.git
代码风格检查
遵循不重复造轮子的思想，使用[email protected]:squizlabs/PHP_CodeSniffer.git
钩子文件
钩子文件pre-commit中的主要流程如下：
- 使用
git status -s获取本次提交的差异文件； - 检查文件格式，如果是非php格式，则略过；
- 对差异文件进行phplint语法检查，如果报错，则输出报错内容，退出检查，commit中断；
- 对差异文件进行phpcs风格检查，如果有报错，则输出报错内容，退出检查，commit中断；
- 如果没有报错，返回成功，继续提交；
最终，pre-commit如下所示：
#!/bin/sh
a=`git status -s`
array=(${a//,/ })
for var in ${array[@]}
do
if [ "$var" = "M" ] || [ "$var" = "A" ] || [ "$var" = "D" ]; then
continue
fi
# check php file
if [[ ! $var =~ ".php" ]]; then
echo "Check file $var: not php file, ignoring..."
fi
# phplint
phplintResult=`./vendor/bin/phplint $var | grep error`
if [ x"$phplintResult" != x ]; then
echo "-------------------------------------"
echo "Git commit error, get phplint errors:"
./vendor/bin/phplint $var | while read line
do
echo $line
done
echo "-------------------------------------"
exit 1
fi
# phpcs
phpcsResult=`phpcs --standard=psr2 $var | grep ERRORS | grep -v "0 ERRORS"`
if [ x"$phpcsResult" != x ]; then
echo "-------------------------------------"
echo "Git commit error, get phpcs errors:"
phpcs $var | while read line
do
echo $line
done
echo "-------------------------------------"
exit 1
fi
done
echo "Congratulations! Code check success!"
exit 0
后续
composer工具包已经整理出来了，移步：https://blog.csdn.net/hfut_wowo/article/details/88650749
后续会将整个工具的管理，制作成一个composer的包，方便大家使用。