這篇文章主要介紹了PHP_CodeSniffer怎么安裝使用的相關(guān)知識(shí),內(nèi)容詳細(xì)易懂,操作簡(jiǎn)單快捷,具有一定借鑒價(jià)值,相信大家閱讀完這篇PHP_CodeSniffer怎么安裝使用文章都會(huì)有所收獲,下面我們一起來(lái)看看吧。
創(chuàng)新互聯(lián)是一家專業(yè)提供扎賚諾爾企業(yè)網(wǎng)站建設(shè),專注與網(wǎng)站建設(shè)、成都網(wǎng)站設(shè)計(jì)、H5網(wǎng)站設(shè)計(jì)、小程序制作等業(yè)務(wù)。10年已為扎賚諾爾眾多企業(yè)、政府機(jī)構(gòu)等服務(wù)。創(chuàng)新互聯(lián)專業(yè)網(wǎng)站制作公司優(yōu)惠進(jìn)行中。
PHP_CodeSniffer是一款自動(dòng)化的PHP代碼規(guī)范檢查工具。
CodeSniffer內(nèi)置MySource
、PEAR
、PHPCS
、PSR1
、PSR2
、Squiz
和Zend
等幾套代碼規(guī)范。
當(dāng)然,你也可以新增自己的代碼規(guī)范。
PHP_CodeSniffer 倉(cāng)庫(kù)地址:https://github.com/squizlabs/PHP_CodeSniffer
PHP_CodeSniffer 版本發(fā)布地址:http://pear.php.net/package/PHP_CodeSniffer
PHP_CodeSniffer包含兩個(gè)工具,phpcs
用來(lái)檢查代碼規(guī)范,phpcbf
用來(lái)糾正代碼規(guī)范。
PHP_CodeSniffer 有好幾種安裝方式。
用git命令下載(或直接下載)倉(cāng)庫(kù)源碼,然后直接執(zhí)行:
git clone https://github.com/squizlabs/PHP_CodeSniffer.git cd PHP_CodeSniffer php bin/phpcs -h php bin/phpcbf -h
要使用非最新版本,可以到PEAR下載,地址:http://pear.php.net/package/PHP_CodeSniffer/download
例如,要用2.9.1
,PEAR下載之后解壓,執(zhí)行的命令是:
php scripts/phpcs -h php scripts/phpcbf -h
與 githuh 下載不同的是,執(zhí)行文件在scripts
目錄。
phar也就是php archive,把php文件打包成一個(gè)文件供服務(wù)。
Linux系統(tǒng)用命令下載phar文件:
curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcbf.phar
Windows系統(tǒng)用瀏覽器訪問(wèn)上面的兩個(gè)鏈接,下載這兩個(gè)phar文件。
然后在phar文件的目錄里面執(zhí)行:
php phpcs.phar -h php phpcbf.phar -h
能看到phpcs和phpcbf的幫助信息,說(shuō)明安裝成功。
說(shuō)明:
這種方式要保證php可執(zhí)行文件已經(jīng)添加到PATH環(huán)境,不然就得指定絕對(duì)目錄
每次執(zhí)行必須把這兩個(gè).phar
文件放到對(duì)應(yīng)目錄,然后在那個(gè)目錄下運(yùn)php phpcs.phar xxx
行命令
如果本地安裝了pear(pear安裝方法),也可以通過(guò)pear來(lái)安裝PHP_CodeSniffer,命令:
pear install PHP_CodeSniffer
通過(guò)pear安裝后,CodeSniffer的規(guī)范文件會(huì)安裝在:/path/to/pear/PHP/CodeSniffer/src/Standards
。
composer安裝也很方便,一個(gè)命令:
composer global require "squizlabs/php_codesniffer=*"
說(shuō)明:這里需要composer
命令已經(jīng)在PATH
環(huán)境變量中。
也可以在composer.json文件中使用:
{ "require-dev": { "squizlabs/php_codesniffer": "3.*" } }
完成后執(zhí)行命令:
./vendor/bin/phpcs -h ./vendor/bin/phpcbf -h
以上的方式中,除了pear安裝方式,其他方式要執(zhí)行phpcs
命令,都需要在前面加上php。
如果是Linux提供,因?yàn)閜hp執(zhí)行文件路徑已經(jīng)在環(huán)境PATH
中,所以把bin
(或scripts
) 的路徑加入PATH
,就可以在終端執(zhí)行phpcs
命令了。
但是在Windows系統(tǒng)中,實(shí)際是執(zhí)行phpcs.bat文件,這個(gè)文件又引用了同目錄下的phpcs文件。
在phpcs.bat中,我們需要配置兩個(gè)變量,才能在CMD中正確執(zhí)行phpcs命令。
如下,需指定php.exe
和phpcs
文件的絕對(duì)位置:
if "%PHPBIN%" == "" set PHPBIN=D:\php56n\php.exe if not exist "%PHPBIN%" if "%PHP_PEAR_PHP_BIN%" neq "" goto USE_PEAR_PATH GOTO RUN :USE_PEAR_PATH set PHPBIN=%PHP_PEAR_PHP_BIN% :RUN "%PHPBIN%" "D:\www\PHP_CodeSniffer-2.9.1\scripts\phpcs" %*
然后把路徑D:\www\PHP_CodeSniffer-2.9.1\scripts\加入到PATH中,就可以在CMD中執(zhí)行phpcs了。
說(shuō)明:phpcbf也需要這樣的修改。
上面我們看到 PHP_CodeSniffer 有兩個(gè)命令。
默認(rèn)情況下,PHP_CodeSniffer 使用PEAR規(guī)范檢查代碼。
以下命令用默認(rèn)規(guī)范來(lái)來(lái)檢查文件和目錄。
$ phpcs /path/to/code/myfile.php # 檢查文件 $ phpcs /path/to/code # 檢查目錄和子目錄下的所有文件 $ phpcs -l /path/to/code # 檢查目錄下的所有文件,不包括子目錄 $ phpcs /path/to/code/myfile.inc /path/to/code/my_dir # 檢查文件和目錄
默認(rèn)情況下,檢查結(jié)果包含錯(cuò)誤和警告,如下:
$ phpcs /path/to/code/myfile.php FILE: /path/to/code/myfile.php -------------------------------------------------------------------------------- FOUND 5 ERROR(S) AND 1 WARNING(S) AFFECTING 5 LINE(S) -------------------------------------------------------------------------------- 2 | ERROR | Missing file doc comment 20 | ERROR | PHP keywords must be lowercase; expected "false" but found | | "FALSE" 47 | ERROR | Line not indented correctly; expected 4 spaces but found 1 47 | WARNING | Equals sign not aligned with surrounding assignments 51 | ERROR | Missing function doc comment 88 | ERROR | Line not indented correctly; expected 9 spaces but found 6 --------------------------------------------------------------------------------
如果不要顯示警告,加個(gè)-n
參數(shù):
$ phpcs -n /path/to/code/myfile.php
僅顯示檢查結(jié)果概要:
$ phpcs --report=summary /path/to/code
可以使用 -- standard
參數(shù)指定一個(gè)或多個(gè)規(guī)范來(lái)檢查。
$ phpcs --standard=PEAR /path/to/code/myfile.inc # 使用內(nèi)置規(guī)范 $ phpcs --standard=/path/to/MyStandard /path/to/code/myfile.inc # 使用指定路徑下的規(guī)范 $ phpcs --standard=PEAR,PHPCS,/path/to/MyStandard file.php # 使用多個(gè)規(guī)范 $ phpcs --config-set default_standard Squiz # 修改默認(rèn)規(guī)范為Squiz(原本是PEAR)
查看現(xiàn)有規(guī)范:
$ phpcs -i
$ phpcs -h
關(guān)于“PHP_CodeSniffer怎么安裝使用”這篇文章的內(nèi)容就介紹到這里,感謝各位的閱讀!相信大家對(duì)“PHP_CodeSniffer怎么安裝使用”知識(shí)都有一定的了解,大家如果還想學(xué)習(xí)更多知識(shí),歡迎關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道。
文章題目:PHP_CodeSniffer怎么安裝使用
分享網(wǎng)址:http://chinadenli.net/article38/gpccsp.html
成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián),為您提供定制網(wǎng)站、標(biāo)簽優(yōu)化、搜索引擎優(yōu)化、網(wǎng)站維護(hù)、服務(wù)器托管、網(wǎng)站營(yíng)銷
聲明:本網(wǎng)站發(fā)布的內(nèi)容(圖片、視頻和文字)以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主,如果涉及侵權(quán)請(qǐng)盡快告知,我們將會(huì)在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng),如需處理請(qǐng)聯(lián)系客服。電話:028-86922220;郵箱:631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載,或轉(zhuǎn)載時(shí)需注明來(lái)源: 創(chuàng)新互聯(lián)