在PhpStorm中安装使用PHP_CodeSniffer编码规范检查工具

入职两天了,继续研究 Swoole 的框架,新公司有内部 wiki,对于一些代码规范还是很重视的

大部分基本都是 PSR 的规范,详见以前的文章:PSR-各个框架遵循的统一编码规范现代 PHPer 的开发规范

这篇文章就介绍一下 PhpStorm 的一个插件吧,PHP Code Sniffer编码规范检查工具

PhpStorm

这款 IDE 是什么大概做 PHP 开发的人都知道吧?这是JetBrains公司开发的跨平台的 PHP IDE。在用PhpStorm编辑 PHP,HTML 和 JavaScript 的代码时,PhpStorm提供实施代码分析,错误提示和自动格式化等功能,一款便携又强大的 IDE,很多功能能够帮助你更好的进行开发

PHP_CodeSniffer

有些同学可能还没听过这东西,大概介绍一下

PHP_CodeSniffer是一个代码风格检测工具。它包含两类脚本phpcsphpcbf

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

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

PHP_CodeSniffer是确保代码简洁一致的必不可少的开发工具,甚至还可以帮助程序员减少一些语义错误

安装 PHP_CodeSniffer

我们用pear 安装PHP_CodeSniffer

1、下载pear文件,右键点击链接,选择“链接另存为”或者“目标另存为”,保存为go-pear.phar,放在 PHP 目录下

这里因为我的外部链接有一个跳转模式,所以不能直接另存为,网址是那个网址,我这里再放一个百度网盘的链接,可以直接下载:百度网盘

2、安装pear :打开命令行工具 DOS 窗口,切换到 PHP 的安装目录,比如我的是phpStudy,目录为:

D:\phpStudy\php\php-7.0.12-nts

3、然后运行下面命令进行安装:

php go-pear.phar

看窗口指示完成安装就行,一般都直接回车就可以,出错的话重新执行以下命令选择 local,或者多试几次,我在公司也折腾了几次,回家在自己笔记本上一次就好,下面是示例图

pear 安装成功

装好以后,你的 PHP 目录下会多出来一些文件夹,如wwwpear等等

4、安装PHP_CodeSniffer

在 CMD 中执行命令,Git 的 bash 窗口因为没加环境变量所以执行失败

pear install PHP_CodeSniffer

安装成功如下图,PHP 的目录也会有phpcbfphpcbf.batphpcsphpcs.bat文件

PHP_CodeSniffer 下载成功

安装到 PhpStorm 中

1、打开PhpStorm的设置页(File->Setting或者Ctrl+Alt+s),到Code Sniffer页,路径是Setting->Languages and Frameworks->PHP->Code Sniffer

2、点那个 3 个点的按钮,在PHP Code Sniffer (phpcs) Path选项挑选CodeSniffer的执行文件,在 PHP 安装目录下,我的是

D:\phpStudy\php\php-7.0.12-nts\phpcs.bat

按下Validate,如果下面出现绿色的字则表示成功,如下图

配置路径

3、Setting->Editor->Inspections->PHP Code Sniffer validation勾选上,然后在右边的Coding standard按下刷新按钮,成功的话点击下拉按钮就会有可供选择的标准

选择你需要的标准即可, 通常都是PSR2,如下图

安装成功

4、按下应用之后,我们就可以看到PHP_CodeSniffer开始及时帮我们检测了,有下划波浪线的就是不规范的代码,及时更正哦,但是框架的命名规范不一样,它也会提示波浪线,这个忽略就可以了

2 条评论

发表评论

*