小编给大家分享一下PHP_CodeSniffer安装和使用方法,相信大部分人都还不怎么了解,因此分享这篇文章给大家参考一下,希望大家阅读完这篇文章后大有收获、下面让我们一起去了解一下吧!
,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
在我们开发中都会讲究代码规范,若是个人开发者,代码规范与否,只要自己看得懂便可以了,但是在团队协作中,代码规定尤为重要,下面,我们介绍一款PHP_CodeSniffer,自动检查代码规范的工具。
PHP_CodeSniffer是一款<强>自动化的PHP代码规范检查工具。
CodeSniffer内置MySource,梨,PHPCS, PSR1, PSR2,好奇的一瞥和Zend等几套代码规范。
当然,你也可以<强>新增自己的代码规范。
PHP_CodeSniffer仓库地址:https://github.com/squizlabs/PHP_CodeSniffer
PHP_CodeSniffer版本发布地址:http://pear.php.net/package/PHP_CodeSniffer
PHP_CodeSniffer包含两个工具,PHPCS用来<>强检查代码规范强,phpcbf用来<强>纠正代码规范。
1安装
PHP_CodeSniffer有好几种安装方式。
<强> 1.1可执行文件方式安装
用git命令下载(或直接下载)仓库源码,然后直接执行:
cd PHP_CodeSniffer
PHP bin/PHPCS PHP bin/phpcbf - h - h
要使用非最新版本,可以到梨树下载,地址:http://pear.php.net/package/PHP_CodeSniffer/download
例如,要用2.9.1,梨下载之后解压,执行的命令是:
PHP脚本/phpcbf - h
与githuh下载不同的是,执行文件在脚本目录。
<强> 1.2 phar文件安装方式
phar也就是PHP存档,把PHP文件打包成一个文件供服务。
Linux系统用命令下载phar文件:
curl https://squizlabs.github.io/PHP_CodeSniffer/phpcbf ol。phar
Windows系统用浏览器访问上面的两个链接,下载这两个phar文件。
然后在phar文件的目录里面执行:
。phar - h
能看到phpcs和phpcbf的帮助信息,说明安装成功。
说明:
这种方式要保证php可执行文件已经添加到路径环境,不然就得指定绝对目录
每次执行必须把这两个。phar文件放到对应目录,然后在那个目录下运php phpcs。phar xxx行命令
<强> 1.3梨安装方式
如果本地安装了梨(梨安装方法),也可以通过梨来安装PHP_CodeSniffer,命令:
通过梨安装后,CodeSniffer的规范文件会安装在:/道路//梨/php/CodeSniffer/src/标准。
<强> 1.4作曲家安装方式
作曲家安装也很方便,一个命令:
说明:这里需要作曲家命令已经在道路环境变量中。
也可以在作曲家。json文件中使用:
“require-dev": {
“squizlabs/php_codesniffer":“3。*“
}
}
完成后执行命令:
。/供应商/bin/phpcbf - h
<强> 1.5配置phpcs直接在命令行中执行
以上的方式中,除了梨安装方式,其他方式要执行phpcs命令,都需要在前面加php上。
如果是Linux提供,因为php执行文件路径已经在环境路径中,所以把本(或脚本)的路径加入路径,就可以在终端执行phpcs命令了。
但是在Windows系统中,实际是执行phpcs.bat文件,这个文件又引用了同目录下的phpcs文件。
在phpcs.bat中,我们需要配置两个变量,才能在CMD中正确执行phpcs命令。
如下,需指定php。exe和phpcs文件的绝对位置:
如果不存在“% PHPBIN %,如果“% PHP_PEAR_PHP_BIN %,neq”;“goto USE_PEAR_PATH
goto运行
: USE_PEAR_PATH
设置PHPBIN=% PHP_PEAR_PHP_BIN %
:
“运行;% PHPBIN %,“D: \ www \ PHP_CodeSniffer-2.9.1 \ \ phpcs"脚本;% *
然后把路径D: \ \ www \ PHP_CodeSniffer-2.9.1 \脚本加入到路径中,就可以在CMD中执行phpcs了。
说明:phpcbf也需要这样的修改。
2使用
上面我们看到PHP_CodeSniffer有两个命令。
默认情况下,PHP_CodeSniffer使用梨规范检查代码。
<强> 2.1使用命令
