phpstorm 配置使用代码质量工具PHP CodeSniffer

Phpstorm 支持基于phpcs的质量检查工具PHP CodeSniffer,稍加配置就可以轻松实现代码规范化,代码规范化在多人协作的项目管理中尤为重要。

使用 Composer 安装 PHP_CodeSniffer

在开始之前,使用ComposerPHP CodeSniffer安装到计算机中,当然你也可以直接将依赖项直接安装到项目中。

composer require squizlabs/php_codesniffer

配置 Quality Tools

定位到Settings | PHP | Quality Tools,在Quality Tools 页面上,展开PHP_CodeSniffer 并单击 Configuration 列表旁边... 添加如下配置。

Quality Tools

其中PHP_CodeSniffer pathPHP CodeBeautifier and Fixer Settings中的Path to papcbf路径都指向上面安装的composer的目录下vendor/bin对应的phpcsphpcbf脚本即可,这里windows系统需要使用bat脚本。

配置 PHP CodeSniffer inspection

点击上一步表单底部的PHP CodeSniffer inspection,配置审查验证标准:

PHP_CodeSniffer validation

  • 勾选PHP_CodeSniffer validation
  • Coding standard中选择需要你代码规范标准比如PSR2,我这边默认支持的有PEAR, PSR1, PSR2, PSR12, Squiz and Zend
  • 保存;

至此phpstorm中的PHP CodeSniffer代码检查和代码修复就配置好了,在编辑器中将会看到提示,在提示上可以直接快速Fix代码。

配置 External Tools 命令

我们来配置两个phpcbf的快捷命令方便指定文件或目录格式化代码;

指定文件 Fix 代码

指定文件 Fix 代码

运行参数Arguments--standard=PSR12 FileDir/FileName

指定目录递归 Fix 代码

指定目录递归 Fix 代码

运行参数Arguments--standard=PSR12 --extensions=php FileDir

这样配置完之后在左侧文件目录或者编辑器打开的文件上直接右键就可以直接运行Fix代码了。

External Tools phpcbf

这里用到的命令参数:

–standard: 使用的规范的路径或者规范名

–extensions: 指定需要规范化代码的文件后缀

phpcbf脚本命令更多的参数支持可以参考phpcbf -h

phpstorm 配置使用代码质量工具PHP CodeSniffer

原文链接:https://beltxman.com/3891.html,若无特殊说明本站内容为 行星带 原创,未经同意禁止转载。

发表评论

您的电子邮箱地址不会被公开。

Scroll to top