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

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

使用 Composer 安装 PHP_CodeSniffer

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

composer require squizlabs/php_codesniffer

配置 Quality Tools

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

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

配置 PHP CodeSniffer inspection

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

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

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

配置 External Tools 命令

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

指定文件 Fix 代码

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

指定目录递归 Fix 代码

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

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

这里用到的命令参数：

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

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

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