团队代码风格和质量管理上,即便有代码风格文档推荐时也难以去更改大家的习惯,所以需要使用工具来规范化,php 一半使用 php-cs-fixer 来管理
安装
全局安装 friendsofphp/php-cs-fixer 包
$ composer global require friendsofphp/php-cs-fixer
PHPSTORM 配置
配置 php-cs-fixer
image.png上图参数说明(图片显示不了可能太大,可以复制链接查看):
参数 | 参考值 | 备注 |
---|---|---|
NAME | php-cs-fixer |
任意填写 |
Description | 规范代码 | 描述内容,任意填写 |
Program | /Users/me/.composer/vendor/friendsofphp/php-cs-fixer/php-cs-fixer |
composer 安装的php-cs-fixer 路径,win 上是 的php-cs-fixer.bat |
Arguments | fix $FileDir$ --rules=@PSR12 |
此处采用 PSR12 的规范,规则可以自己编写 |
Working Directory | $ProjectFileDir$ |
填写 phpstorm 的变量宏指令就可以 |
关于 Arguments
可以根据团队规范,去写对应的规则文件
配置快捷键
image.png后续按快捷键接可以自动规范代码了
规则文件
规则文件可以是「团队规则」,整个团队统一使用,放到 git 进行同步管理;
也可以「项目规则」,不同项目使用不同规范,放到项目根目录下,跟随项目;
团队规则
任意地方
Arguments :fix $FileDir$/$FileName$ --config=/Users/me/phpRules/.php-cs-fixer.php
项目规则
将规则文件 .php-cs-fixer.php 放到项目根目录
Arguments :fix $FileDir$/$FileName$ --config=$ProjectFileDir$/.php-cs-fixer.php
常见配置说明:
https://xiaoteng.vip/archives/changyong-de-php-cs-fixer-de-guize.html
https://qiita.com/ucan-lab/items/7d4180462347a42009d5
参考
https://laravelacademy.org/post/21908
网友评论