在PhpStorm中使用PSR2编码规范phpcbf脚本自动修正代码格式

PSR 规范是个好东西 😀 

团队开发约定使用 PSR-2 的编码风格规范,但是并不是所有人都严格按照 PSR-2 来提交代码的

最大的原因就是口头的约束力极为有限,而团队中大家使用的编辑器不统一,有使用PhpStorm,也有使用VS Code的等等,而各种编辑器都有自己的格式化规则,因此代码风格统一是个问题

之前的文章使用 phpcbf 脚本自动修正代码格式,很少有开发者只使用终端开发代码,通常都会用到编辑器,这篇文章介绍一下在 PhpStorm 中集成phpcbfphpcs

让编辑器使用 PSR-2 标准

1、打开PhpStorm的设置页(File->Setting或者Ctrl+Alt+s),到Code StylePHP中选择风格为 PSR1/2

选择风格为 psr1/2

2、到Code Sniffer页,路径是Setting->Languages and Frameworks->PHP->Code Sniffer,设置phpcs的路径

设置 phpcs 的路径

3、到Inspections页,路径Setting->Editor->Inspections,右侧的 PHP,勾选下面的两个 PHP,选择使用 PSR2

选择使用 PSR2

下面还有一处,也要选中

phpstorm-mess-detector 格式化

现在使用PhpStorm的格式化,将会自动格式化成 psr-2 的风格

经过上面的操作,PhpStorm代码格式化的规则基本与phpcs的规则基本一致了,但也有一小部分不一致,所以后面还要用到phpcsphpcbf

如果每次都在终端去执行花费时间可不少,为了提高工作效率,可以在PhpStorm集成phpcbf、phpcs检测规范的功能

设置路径:Tools -> External Tools

集成 phpcs

集成 phpcs

集成 phpcbf集成 phpcbf

Program是你的 PHP 根目录下的文件,windows 是.bat文件

Arguments$FileDir$/$FileName$,可以直接填

Working directory$ProjectFileDir$,也可以直接填

下面的Open console for tool output是指打印检测的信息到控制台上,phpcs检测的我们要看,phpcbf就不用了,所以不用勾选

怎么使用呢?

工具栏的Tools->External Tools就可以看到我们刚才添加的两个小工具,直接点击就可以用了

3 条评论

发表评论

*