關於PHP_CodeSniffer程式碼檢測引數學習記錄

echo_dump發表於2020-08-05
PHP

PHP程式碼檢測工具 CodeSniffer

  • 使用composer安裝 composer require squizlabs/php_codesniffer

  • git拉取下載 https://github.com/squizlabs/PHP_CodeSniffer.git

  • 最主要的是兩個檔案：

|-- squizlabs
    |-- php_codesniffer
        |-- bin
            |-- phpcbf //程式碼修正指令碼
            |-- phpcbf.bat
            |-- phpcs //程式碼檢測指令碼
            |-- phpcs.bat

  • 執行檢測檔案的引數檢視 ./bin/phpcs -h | --help

  • 執行程式碼修復指令碼引數參看 ./bin/phpcbf -h | --help

  • 檢視版本資訊 ./bin/phpcs --version

  • 比如檢測一個檔案可以直接執行 ./bin/phpcs ./test 檢測當前目錄下的test目錄，也可以檢測一個檔案，把目錄換為具體的檔名

  • 執行時設定編碼格式 ./bin/phpcs --encoding=utf-8

  • 檢測結果不列印warning資訊 ./bin/phpcs -n ./test

  • 動態顯示檢測進度 ./bin/phpcs -p ./test

  • 列印錯誤和警告資訊，預設配置，不需要修改 ./bin/phpcs -w ./test

  • 引數 -l 無遞迴的檢查，僅檢查當前目錄 ./bin/phpcs -l ./test

  • 引數 -s 詳細的顯示每個檔案的具體問題 ./bin/phpcs -s ./test

  • 引數 -a 互動式執行，一般有三個選項 重新檢測，跳過，退出 ./bin/phpcs -a ./test

  • 引數 -i 顯示已安裝的編碼標準 ./bin/phpcs -i ./test

The installed coding standards are MySource, PEAR, PSR1, PSR12, PSR2, Squiz and Zend

  • 引數 --colors 設定輸出的顏色

  • 引數 --no-colors 不設定輸出的顏色，預設配置

  • 引數 --cache 快取輸出結果

  • 引數 --no-cache 不快取輸出結果，預設配置

  • 引數 --ignore-annotations 忽略程式碼註釋

  • 引數 --report=summary 僅顯示每個檔案的錯誤和警告數量的摘要報告

  • 引數 --report=souurce 列印源報告

  • 引數 --report=info 列印詳細資訊報告

  • 引數 --report=ocde 列印程式碼報告

  • 更多 --report引數 Checkstyle,csv, Emacs, git, json, JUnit, svn, xml

  • 講檢測結果寫入檔案 --report-full= 後面是檔案路徑

  • 引數 --standard 設定檢測檔案時使用的編碼標準 ./bin/phpcs --standard=psr2 ./test

  • 引數 -e 和引數 --standard=psr2 配合使用，可以列印出當前檔案需要做那些標磚的檢查

  • 引數 --extensions 只檢查當前列出的檔案字尾的檔案 ./bin/phpcs --extensions=php --standard=psr2 ./test

  • 引數 --severity 顯示列印訊息的等級，預設為5 ./bin/phpcs --severity=2 ./test

  • 引數 --config-set修改配置選項

本作品採用《CC 協議》，轉載必須註明作者和本文連結
LIYi ---- github地址

相關文章