- 团队开发中, 我们尽量要保持风格一致的代码
phpstorm
设置统一的风格PSR12
File -> Settings -> Editor-> Code Style -> Set from -> select PSR12
使用PHP_CodeSniffer检查修复代码风格
-
在根目录新建
phpcs.xml
文件,团队统一使用 -
关于配置文件(官方的文档说明太少太少)
-
当你运行
phpcs
,得到错误消息之后, 然后把错误消息的标准文本拿去搜源码,定位到调用的函数,然后再去修改配置文件 -
比如我很不喜欢每个函数后面都有
end xxx()
(因为这个功能IDE
已经提供) -
然后我搜索源码中的
//end
定位到PHP_CodeSniffer\Standards\Squiz\Sniffs\Commenting::ClosingDeclarationCommentSniff
-
之后把
php.cs
配置文件中的<rule ref="Squiz.Commenting.ClosingDeclarationComment"/>
移除就可以了
使用phpstan静态分析
- 在根目录新建
phpstan.neon
配置文件,团队统一使用
实践
- 团队成员在各自的分支开发
- 合并到
dev
分支的时候,使用git hook
通知stage
机器 stage
机器进行代码phpunit
测试、phpcs
代码风格检测(phpcbf
修复)、phpstan
静态检测- 如果以上步骤都通过,则合并到
master
推送到仓库. 否则发送失败通知
注意事项
- 在容器内跑测试, 需要配置好
git
账号 - 然后配置的公钥,可以直接使用宿主机的(记得配置宿主机 .ssh 目录的权限让容器读取公钥)
volumes:
# 共享 git 公钥
-/root/.ssh:/home/laradock/.ssh