01月29, 2017

CodeSniffer的安装和使用

认识PHP_CodeSniffer

PHP_CodeSniffer是PEAR中的一个用PHP5写的用来检查嗅探PHP代码是否有违反一组预先设置好的编码标准的一个包,它是确保你的代码简洁一致的必不可少的开发工具,甚至还可以帮助程序员减少一些语义错误。包含两个工具,phpcs规范检查和phpcbf自动修复。

安装

官方网站 http://pear.php.net/package/PHP_CodeSniffer/redirected

可以通过pear install PHP_CodeSniffer-3.1.1安装,这个年代应该没几个人用pear安装了吧。

推荐从github下载源码。

我们可以有多种方式来使用CodeSniffer:

phar方式

curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar
php phpcs.phar -h

curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcbf.phar
php phpcbf.phar -h

Composer方式

composer global require "squizlabs/php_codesniffer=*"

或者加入composer.json
{
    "require-dev": {
        "squizlabs/php_codesniffer": "3.*"
    }
}

然后可以使用
./vendor/bin/phpcs -h
./vendor/bin/phpcbf -h

命令行方式

git clone https://github.com/squizlabs/PHP_CodeSniffer.git
cd PHP_CodeSniffer
php bin/phpcs -h
php bin/phpcbf -h

在Phpstorm中配置

下载CodeSniffer源码后,修改bin文件夹下phpcbf.bat和phpcs.bat文件(每个文件有两处修改)。 alt

这里两处需要修改,指定php路径和CodeSniffer路径(@符号要去掉) alt


打开Phpstorm设置 alt 点击validate按钮验证 alt


为了更方便的使用,我们来配置一个自定义工具。 alt 然后配置快捷键,我习惯用shift+o,shift+p (OOP?) alt

打开项目代码验证一下。 SHIFT+O提示,这里列出了所有有问题的地方,(当然了,团队也可以采用别的开发规范,这里只是CodeSniffer的建议) alt SHIFT+P自动修复,【x】这种提示是可以自动修复的。 alt

OK,大概就是这样了,更多用法请阅读git上的文档。

本文链接:https://blog.hijs.cc/post/CodeSniffer.html

-- EOF --

Comments