使用PHPCodeSniffer规范项目代码

PHP_CodeSniffer 是什么

PHP_CodeSniffer 是一个代码风格检测工具,是确保代码简洁一致的必不可少的开发工具,甚至还可以帮助程序员减少一些语义错误。它包含有两类脚本 phpcs 和 phpcbf。

PHPCS

phpcs 脚本对 PHP、JavaScript、CSS 文件定义了一系列的代码规范(通常使用官方的代码规范标准,比如 PHP 的 PSR2),能够检测出不符合代码规范的代码并发出警告或报错(可设置报错等级)。

PHPCBF

phpcbf 脚本能自动修正代码格式上不符合规范的部分,比如 PSR2 规范中对每一个 PHP 文件的结尾都需要有一行空行,那么运行这个脚本后就能自动在结尾处加上一行空行。

PHPCodeSniffer 安装

全局安装

1
composer global require "squizlabs/php_codesniffer=*"

安装完毕后,在全局的 Vendor 目录下的 bin 目录中,会生成两个软连接。

查看全局 Vendor 目录位置

1
composer global config bin-dir --absolute

PHPStorm 配置

让编辑器使用 PSR 标准(以下以 PSR12 为例)

CodeStyle

PHP_CodeSniffer

集成到 PHPStormTools

点击运行 PHPCS,进行代码规范检查

点击运行 PHPCBF,进行代码修复。PHPCBF 只能修复代码风格产生的问题,并不能完全修复所有问题,部分问题需自身进行解决。

快捷键配置

每次都需要从 Tools -> External Tools 中点击,太过于繁琐,我们可以通过设置快捷键来简化操作。

相关文章