首页 PHP小记正文

团队中使用PHP_CodeSniffer插件 统一团队代码风格

   每个都有自己的代码风格,这里没有什么绝对的对和错。但是在多人团队协作开发中,会造成团队成员之间代码互相不可读,提高项目复杂度,也增加了新人不好接收代码,最终导致项目不可维护。通过一些规范可以规定项目统一成一种风格。新进的人员只需要学习和遵循这一规范,就可以理清整个项目。

  但是规范是死的,人是活的,团队成员在开发的过程中,总会因为各种原因不去遵守约定好的规范。为了解决这个问题,首先,先让团队的成员统一编辑器,一部分选择了phpstorm,大部分则选用了vs code,本着少数服从多数的原则,我们团队统一使用了vs code这款编辑器(配置后,我觉得真的好用啊!强烈推荐!)。

  接下来便是一些插件的安装,具体的推荐可以看 我的vs code 的一些插件整理 这篇文章,里面都是我整理的vs code插件名字和基本介绍,大家可以按需安装。在安装基础的PHP代码提示和美化后就开始了PHP代码格式化检测插件的配置。


git 方式

squizlabs/php_codesniffer

首先,我们先去github上下载插件到本地,PHP_CodeSniffer需要PHP 5.4.0或更高版本才能支持。具体使用,可以通过百度来了解。

composer方式(推荐)

如果使用Composer,则可以使用以下命令在系统范围内安装PHP_CodeSniffer:

composer global require "squizlabs/php_codesniffer=*"

确保PATH中有composer bin目录。默认值为~/.composer/vendor/bin/

但您可以通过运行检查需要使用的值

composer global config bin-dir --absolute

或者,squizlabs/php_codesniffer在您的composer.json文件中包含依赖项例如:

{
      require-dev :{
          squizlabs / php_codesniffer  3. * 
    }
}

然后,您将能够从供应商bin目录运行PHP_CodeSniffer:

./vendor/bin/phpcs  代码格式检测
./vendor/bin/phpcbf 代码格式修复

phpcs默认的编码格式并不是php-cs,所以当不指定标准的时候,检测的结果并不准确,但每次都手动指定也挺麻烦,所以一个默认标准为PHP的PSR2,命令如下:

phpcs --config-set default_standard PSR2
phpcbf --config-set default_standard PSR2

这样 就大功告成了!

版权声明

本文仅代表作者观点,不代表本站立场。
本文系作者授权发表,未经许可,不得转载。

评论