Mac 版 PhpStorm 如何配置代码规范检查工具

关于 PSR#

PSR 是 PHP Standard Recommendations 的简写,由 PHP FIG 组织制定的 PHP 规范,是 PHP 开发的实践标准。

项目的目的在于:通过框架作者或者框架的代表之间讨论,以最低程度的限制,制定一个协作标准,各个框架遵循统一的编码规范,避免各家自行发展的风格阻碍了 PHP 的发展,解决这个程序设计师由来已久的困扰。

关于 PHPCS#

PHP_CodeSniffer 是一款自动化的 PHP 代码规范检查工具。它内置 MySource、PEAR、PHPCS、PSR1、PSR2、Squiz 和 Zend 等几套代码规范。

1)安装 PHPCS#

要想在 phpstorm 中使用代码规范检查,首先要安装 phpcs, 命令如下:

brew install php-code-sniffer

运气好的话一次就可以搞定,运气不好可能会因为网速或着墙的缘故安装失败。

luciusMBP:/ lucius$ brew install php-code-sniffer
Updating Homebrew...
==> Downloading https://github.com/squizlabs/PHP_CodeSniffer/releases/download/3.4.0/phpcs.phar
############################################################## 100.0%
curl: (7) Failed to connect to github-production-release-asset-2e65be.s3.amazonaws.com port 443: Operation timed out
Error: An exception occurred within a child process:
  DownloadError: Failed to download resource "php-code-sniffer"
Download failed: https://github.com/squizlabs/PHP_CodeSniffer/releases/download/3.4.0/phpcs.phar

遇到上述情况再次安装,成功后会提示:

/usr/local/Cellar/php-code-sniffer/3.4.0: 4 files, 2.2MB, built in 25 seconds

这个路径就是 phpcs 的安装路径了,cd 到这个目录下可以看到一个 bin 目录,该目录下就是我们要的东东了。

daibinhuadeMacBook-Pro:bin binhua$ ls
phpcbf  phpcs

2)在 PhpStorm 中设置 phpcs#

友情提示:PhpStorm 版本不同,设置里选项的位置稍有不同哦,我的版本是 2018.3。

Preferences -> Languages & Frameworks -> PHP -> Quality Tools -> Code Sniffer
phpstorm-phpcs

找到上面的选项后,点击下拉选择框后面的 按钮,然后修改原来的 local 标签下的 php code sniffer path。填写的路径就是第一步安装 phpcs 的路径,然后点击 validate 按钮进行验证,验证通过后这步就成功了。
phpstorm-phpcs2

这里有一点需要注意,路径不能只写到 bin 目录,要加上具体的命令 phpcs

3)在 phpstorm 中设置 PSR 提示#

Preferences -> Editor -> Inspections -> Quality Tools -> PHP Code Sniffer validation

在下图第三步中,勾选 PHP Code Sniffer validation,然后点击第四步的刷新按钮,选择 PSR2,最后 apply,保存即可。
phpstorm-phpcs3

接下来 PhpStorm 就可以时时检查你的代码,鼠标到达问题处时就会提示。尝试着让自己更规范吧~(^_^)
phpstorm-phpcs4

本作品采用《CC 协议》,转载必须注明作者和本文链接
代码是写给人看的,顺便给机器运行一下。
《L04 微信小程序从零到发布》
从小程序个人账户申请开始,带你一步步进行开发一个微信小程序,直到提交微信控制台上线发布。
《L01 基础入门》
我们将带你从零开发一个项目并部署到线上,本课程教授 Web 开发中专业、实用的技能,如 Git 工作流、Laravel Mix 前端工作流等。