溫馨提示×

溫馨提示×

您好,登錄后才能下訂單哦!

密碼登錄×
登錄注冊×
其他方式登錄
點擊 登錄注冊 即表示同意《億速云用戶服務條款》

PHP_CodeSniffer怎么安裝使用

發布時間:2022-01-13 09:53:06 來源:億速云 閱讀:193 作者:iii 欄目:編程語言

這篇文章主要介紹了PHP_CodeSniffer怎么安裝使用的相關知識,內容詳細易懂,操作簡單快捷,具有一定借鑒價值,相信大家閱讀完這篇PHP_CodeSniffer怎么安裝使用文章都會有所收獲,下面我們一起來看看吧。

PHP_CodeSniffer是一款自動化的PHP代碼規范檢查工具。

CodeSniffer內置MySource、PEAR、PHPCS、PSR1、PSR2、SquizZend等幾套代碼規范。

當然,你也可以新增自己的代碼規范。

  • 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命令下載(或直接下載)倉庫源碼,然后直接執行:

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下載之后解壓,執行的命令是:

php scripts/phpcs -h
php scripts/phpcbf -h

與 githuh 下載不同的是,執行文件在scripts目錄。

1.2 phar文件安裝方式

phar也就是php archive,把php文件打包成一個文件供服務。

Linux系統用命令下載phar文件:

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

Windows系統用瀏覽器訪問上面的兩個鏈接,下載這兩個phar文件。

然后在phar文件的目錄里面執行:

php phpcs.phar -h
php phpcbf.phar -h

能看到phpcs和phpcbf的幫助信息,說明安裝成功。

說明:

  • 這種方式要保證php可執行文件已經添加到PATH環境,不然就得指定絕對目錄

  • 每次執行必須把這兩個.phar文件放到對應目錄,然后在那個目錄下運php phpcs.phar xxx行命令

1.3 pear安裝方式

如果本地安裝了pear(pear安裝方法),也可以通過pear來安裝PHP_CodeSniffer,命令:

pear install PHP_CodeSniffer

通過pear安裝后,CodeSniffer的規范文件會安裝在:/path/to/pear/PHP/CodeSniffer/src/Standards。

1.4 composer安裝方式

composer安裝也很方便,一個命令:

composer global require "squizlabs/php_codesniffer=*"

說明:這里需要composer命令已經在PATH環境變量中。

也可以在composer.json文件中使用:

{
    "require-dev": {
        "squizlabs/php_codesniffer": "3.*"
    }
}

完成后執行命令:

./vendor/bin/phpcs -h
./vendor/bin/phpcbf -h

1.5 配置phpcs直接在命令行中執行

以上的方式中,除了pear安裝方式,其他方式要執行phpcs命令,都需要在前面加上php。

如果是Linux提供,因為php執行文件路徑已經在環境PATH中,所以把bin(或scripts) 的路徑加入PATH,就可以在終端執行phpcs命令了。

但是在Windows系統中,實際是執行phpcs.bat文件,這個文件又引用了同目錄下的phpcs文件。

在phpcs.bat中,我們需要配置兩個變量,才能在CMD中正確執行phpcs命令。

如下,需指定php.exephpcs文件的絕對位置:

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中執行phpcs了。

說明:phpcbf也需要這樣的修改。

2 使用

上面我們看到 PHP_CodeSniffer 有兩個命令。

默認情況下,PHP_CodeSniffer 使用PEAR規范檢查代碼。

2.1 使用命令

以下命令用默認規范來來檢查文件和目錄。

$ 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   # 檢查文件和目錄

2.2 檢查結果

默認情況下,檢查結果包含錯誤和警告,如下:

$ 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
--------------------------------------------------------------------------------

如果不要顯示警告,加個-n參數:

$ phpcs -n /path/to/code/myfile.php

僅顯示檢查結果概要:

$ phpcs --report=summary /path/to/code

2.3 指定規范

可以使用 -- standard參數指定一個或多個規范來檢查。

$ phpcs --standard=PEAR /path/to/code/myfile.inc                      # 使用內置規范
$ phpcs --standard=/path/to/MyStandard /path/to/code/myfile.inc       # 使用指定路徑下的規范
$ phpcs --standard=PEAR,PHPCS,/path/to/MyStandard file.php            # 使用多個規范

$ phpcs --config-set default_standard Squiz                           # 修改默認規范為Squiz(原本是PEAR)

查看現有規范:

$ phpcs -i

2.4 查看幫助

$ phpcs -h

關于“PHP_CodeSniffer怎么安裝使用”這篇文章的內容就介紹到這里,感謝各位的閱讀!相信大家對“PHP_CodeSniffer怎么安裝使用”知識都有一定的了解,大家如果還想學習更多知識,歡迎關注億速云行業資訊頻道。

向AI問一下細節

免責聲明:本站發布的內容(圖片、視頻和文字)以原創、轉載和分享為主,文章觀點不代表本網站立場,如果涉及侵權請聯系站長郵箱:is@yisu.com進行舉報,并提供相關證據,一經查實,將立刻刪除涉嫌侵權內容。

AI

亚洲午夜精品一区二区_中文无码日韩欧免_久久香蕉精品视频_欧美主播一区二区三区美女