PHPStorm中使用phpcs和php-cs-fixer进行代码格式化PSR-2(转发+修改)
in PHP with 0 条评论

PHPStorm中使用phpcs和php-cs-fixer进行代码格式化PSR-2(转发+修改)

in PHP with 0 comment

前言:良好的代码规范可以提高代码可读性,减少团队沟通维护成本,所以本文尝试PSR-2代码规范进行代码格式化。

图片描述...

!!! 转发至:https://blog.csdn.net/m0_38092942/article/details/80006144

正文:

(1)使用环境:

IDE:phpstorm2017.3.6
插件:phpcs和php-cs-fixer

(2)安装phpcs

composer global require 'squizlabs/php_codesniffer=*'

(3)安装php-cs-fixer

composer require friendsofphp/php-cs-fixer

注意:如果按照网上旧的教程,上面的命令会变成

composer global require fabpot/php-cs-fixer

fabpot/php-cs-fixer 这个包在Packagist上已经被Abandon了,可以使用,但是在使用过程中会报Warning,并且提示让你使用friendsofphp/php-cs-fixer,所以看到这篇文章的同志们可以直接安装friendsofphp/php-cs-fixer

如果已经安装了fabpot/php-cs-fixer,有强迫症想改成friendsofphp/php-cs-fixer,可以使用如下命令去掉composer依赖

composer remove fabpot/php-cs-fixer

`
!! 这里使用 composer global require friendsofphp/php-cs-fixer 安装

(4)设置PHPStorm--phpcs

图片描述...

图片描述...

如果找不到 Code sniffer 见如下图

图片描述...

配置 local 地址也非常简单, 你安装完成 php-cs-fixer 后, 会有一个目录地址给你, 如图,

图片描述...

选择其中的 phpcs.bat 即可

PhpStorm设置
● 步骤1:打开PhpStorm点击 File->Settings
● 步骤2:接着点击Languages & Frameworks->PHP->Code Sniffer点击Configuration右侧的按钮,
● 步骤3:选择PHP Code Sniffer (phpcs) path:的路径,就是刚才composer之后生成的那个phpcs.bat的路径。
● 步骤4:选择之后点击Validate验证成功
● 步骤5:节点点击Editor->Inspections展开点击右侧的PHP
● 步骤6:勾选PHP Code Sniffer Validation 选择右侧的PSR2

● 步骤7:点击验证成功 大功告成!!

!! 步骤六这一步, 我也没有找到,暂时忽略掉

效果:

(5)设置PHPStorm--php-cs-fixer

图片描述...
图片描述...

namedescription可自行填写

program需要填写php-cs-fixer的可执行文件地址
Windows上是用户目录\Roaming\Composer\composer\vendor\bin\php-cs-fixer.bat,linux和mac上是~/.composer/vendor/bin/php-cs-fixer

!! 上面这个地址,可以在你全局安装相关文件的时候找到

Arguments/parameters--rules=@Symfony --verbose fix "$FileDir$/$FileName$",其中 rules 字段具体可以查看 php-cs-fixer 的官方文档,但是由于 Windows 的 cmd 有诸多限制,所以只能传入一些简单的规则,如果需要配置复杂规则建议使用配置文件来完成。

working directory$ProjectFileDir$

插件配置好以后,到Keymap中设置一个快捷键,就可以使用了

图片描述...

使用效果如下图

图片描述...

Responses