使用PHPCS+GIT钩子保障团队开发中代码风格一致性实践

最新推荐文章于 2021-03-29 05:56:33 发布

sreio

最新推荐文章于 2021-03-29 05:56:33 发布

阅读量512

点赞数 2

分类专栏： PHP git 文章标签： PHPCS PHPCBF php代码规范

个人博客：https://blog.sreio.com

本文链接：https://blog.csdn.net/weialemon/article/details/92764361

版权

本文介绍了如何使用PHP CodeSniffer (PHPCS) 和 PHP Coding Standards Fixer (PHPCBF) 结合 Git 钩子来确保团队开发过程中代码风格的一致性。首先，详细讲解了安装和配置 PHPCS 和 PHPCBF 的步骤，包括设置默认编码标准。然后，通过示例展示了如何使用 PHPCS 检测代码风格问题，以及 PHPCBF 自动修复部分问题。最后，讨论了如何在 Git 的 pre-commit 钩子中添加策略，以阻止不符合编码风格的代码提交。

摘要由CSDN通过智能技术生成

实现:

php-cs可以用来检测代码是否符合PSR-2规范，同时支持对不符合规范的代码自动格式化，让其转成PSR-2的编码风格。

安装：

安装composer

php-cs依赖于composer，所以笔者需要先安装composer，安装的方法有很多种，这里提供mac操作系统和手动安装方法

brew install composer

手动安装composer命令为：

wget https://getcomposer.org/download/1.7.1/composer.phar && chmod 777 composer.phar && mv composer.phar /usr/local/bin/composer

安装PHP-CS

安装好composer之后，可以用composer快速安装php-cs，安装命令如下

composer global require "squizlabs/php_codesniffer=*"

当命令执行完成之后，会在笔者当前用户的主目录下创建一个 .composer 目录，在目录中包含了需要的php-cs，此时可以执行下方命令来验证是否安装成功

~/.composer/vendor/bin/phpcs  --help

当命令执行后，如果能看到下方的一些信息，那么就代表安装成功

 -     Check STDIN instead of local files and directories
 -n    Do not print warnings (shortcut for --warning-severity=0)
 -w    Print both warnings and errors (this is the default)
 -l    Local directory only, no recursion
 -s    Show sniff codes in all reports
 -a    Run interactively
 -e    Explain a standard by showing the sniffs it includes
 -p    Show progress of the run
 -q    Quiet mode; disables progress and verbose output
 -m    Stop error messages from being recorded
       (saves a lot of memory, but stops many reports from being used)
 -v    Print processed files
 -vv   Print ruleset and token output
 -vvv  Print sniff processing information
 -i    Show a list of installed coding standards
 -d    Set the [key] php.ini value to [value] or [true] if value is omitted