PHP 不像Java和C++一样有工业级的行业标准,所以代码很容易就freeStyle了。近些年,随着PSR规范被广大PHPer接受,代码逐渐走向规范化,本文就是教你怎么使用PHP-CS-Fixer进行代码格式化。

PSR 规范

具体中文文档 https://laravel-china.org/docs/psr 在编码中我们一般严格遵守PSR-2规范即可

  1. PSR-0 自动加载规范(已弃用)
  2. PSR-1 基础编码规范
  3. PSR-2 编码风格规范
  4. PSR-3 日志接口规范
  5. PSR-4 自动加载规范
  6. PSR-5 PHPDoc 标准(未通过)
  7. PSR-6 缓存接口规范
  8. PSR-7 HTTP 消息接口规范
  9. PSR-8 Huggable 接口(未通过)
  10. PSR-9 项目安全问题公示(未通过)
  11. PSR-10 项目安全上报方法(未通过)
  12. PSR-11 容器接口
  13. PSR-12 编码规范扩充(审阅中)
  14. PSR-13 超媒体链接 已完成
  15. PSR-14 事件分发器(未通过)
  16. PSR-15 HTTP 请求处理器 已完成
  17. PSR-16 缓存接口
PHP-CS-Fixer 格式校验

项目地址:https://github.com/FriendsOfPHP/PHP-CS-Fixer 这个工具是phar包,可以以命令行的方式使用,也可以结合IDE(PhpStorm)使用

获取方式

  1. 直接下载:https://cs.sensiolabs.org/download/php-cs-fixer-v2.phar
  2. [推荐] Composer安装:composer global require friendsofphp/php-cs-fixer

记得全局安装global

直接使用

更多使用参照官方文档,多个规则可以用“,”隔开

  1. php php-cs-fixer fix /path/to/dir 对某个目录下面的php文件格式化
  2. php php-cs-fixer fix /path/to/file 对单个php文件格式化
  3. php-cs-fixer fix /path/to/project [email protected] 采用PSR2规范进行格式化

结合PhpStorm使用

Setting->Tools->External Tools
PHPStorm利用 PHP-CS-Fixer进行代码格式化
PHPStorm利用 PHP-CS-Fixer进行代码格式化

具体配置
  1. 上图中Program填php-cs-fixer.bat的位置:C:\Users\XXX\AppData\Roaming\Composer\vendor\bin\php-cs-fixer.bat

如果通过Composer安装php-cs-fixer后不知道文件位置,可通过下面这种方式查找:

windows下 查看php-cs-fixer路径 :git bash :which php-cs-fixer
PHPStorm利用 PHP-CS-Fixer进行代码格式化
2. Arguments 填写参数配置
可以直接使用官方提供的规则($FileDir$ 这种格式的变量是PHPstorm的宏指令(Macros)).php_cs.dist 是官方提供的格式化标准,其实就是php文件,自己可以从官方github仓库中下载,–config后面是这个文件的存放地址,根据你的实际环境来

fix $FileDir$/$FileName$ --config=C:\Users\XXX\AppData\Roaming\Composer\vendor\php-cs-fixer\diff\src\.php_cs.dist

PHPStorm利用 PHP-CS-Fixer进行代码格式化
PHPStorm利用 PHP-CS-Fixer进行代码格式化
3.Working directory 填写工作目录
PHPStorm利用 PHP-CS-Fixer进行代码格式化

使用

手动执行

Tools->External Tools -> PHP-CS_FIXER(这个是你在添加扩展工具时的名称)
PHPStorm利用 PHP-CS-Fixer进行代码格式化

快捷键设置

Setting->Keymap->External Tools 选择你添加的扩展工具
我一般习惯设置为 Alt+S,方便操作也不会与本身快捷键冲突
PHPStorm利用 PHP-CS-Fixer进行代码格式化

结果

PHPStorm利用 PHP-CS-Fixer进行代码格式化

总结

特意没用贴出格式化后的代码效果,试了就知道,用过的都说好!
采用PHP-CS-Fixer格式化代码 可以让你的代码更加规范,可读性安全性更高,推荐广大PHPer使用

相关文章:

  • 2022-12-23
  • 2021-09-15
  • 2021-12-25
  • 2021-08-25
  • 2022-12-23
  • 2021-06-09
  • 2022-02-08
猜你喜欢
  • 2022-12-23
  • 2022-12-23
  • 2021-10-20
  • 2022-12-23
  • 2021-07-24
  • 2021-07-02
  • 2022-12-23
相关资源
相似解决方案