VsCode插件phpcs安裝執行過程中遇到的問題及解決方法

VsCode插件phpcs安裝執行過程中遇到的問題及解決方法，相信很多沒有經驗的人對此束手無策，為此本文總結了問題出現的原因和解決方法，通過這篇文章希望你能解決這個問題。

我們希望規范項目開發中PHP代碼的編碼規范，鎖定了php-code-sniffer這款插件，在安裝執行過程中遇到的問題及理解分享如下

認識PHP_CodeSniffer

https://github.com/squizlabs/PHP_CodeSniffer/是一個代碼規范工具，用于規范團隊開發中的類名，注釋，參數的等方面寫法，幫助團隊成員形成統一的編碼風格。

有多種安裝方式，mac下采用以下命令安裝，最為方便

brew install php-code-sniffer

安裝路徑 /usr/local/Cellar/php-code-sniffer

/usr/local/Cellar/php-code-sniffer/3.4.1/binlsphpcbf  phpcs

composer方式

composer global require squizlabs/php_codesniffer

安裝路徑

/Users/name/.composer/vendor/squizlabs/php_codesniffer/

lsphpcbf    phpcbf.bat  phpcs    phpcs.bat

兩種安裝方式，mac下推薦使用brew安裝

其它安裝方式參考github庫[PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer/)

VsCode中啟用PHP_CodeSniffer

VsCode中啟用PHP_CodeSniffer需要安裝phpcs插件。

phpcs與PHP sniffer關系

Before using this plugin, you must ensure that phpcs is installed on your system,The preferred method is using [composer](https://getcomposer.org/) for both system-wide and project-wide installations.

也就是說在VsCode中使用phpcs插件之前，需要首先在系統上安裝有phpcs，安裝方法是依賴于composer方式，并且可以從系統級和項目級兩個緯度選擇安裝。

如果只是在vscode中安裝插件，系統級中不安裝phpcs。會出現以下錯誤

phpcs: Request workspace/configuration failed with message: Unable to locate phpcs. Please add phpcs to your global path or use composer dependency manager to install it in your project locally.

系統級全局安裝

composer global require squizlabs/php_codesniffer

Changed current directory to /Users/wmm/.composer

Using version ^3.4 for squizlabs/php_codesniffer

./composer.json has been updated

Loading composer repositories with package information

Updating dependencies (including require-dev)

Package operations: 1 install, 0 updates, 0 removals

  - Installing squizlabs/php_codesniffer (3.4.0): Downloading (100%)         

Writing lock file

Generating autoload files

項目級別的安裝

以下是VScode 對于插件 phpcs 的介紹說明，更多參考 https://marketplace.visualstudio.com/items?itemName=ikappas.phpcs 

Project-wide Installation

The `phpcs` linter can be installed in your project using the Composer Dependency Manager for PHP.

1.  Install [composer](https://getcomposer.org/doc/00-intro.md "https://getcomposer.org/doc/00-intro.md").

2.  Require `phpcs` package by typing the following at the root of your project in a terminal:

composer require --dev squizlabs/php_codesniffer

在沒有配置完成時，又發現了另外一個插件 PHP Sniffer。在特性中寫著兩條

Runs phpcs to lint PHP code.

Runs phpcbf to format fixable PHP code validation errors.

顯然可以推斷 PHP Sniffer 是對phpcs的封裝。驗證后發現，這個插件可以不使用，PHP_CodeSniffer也能夠正常啟用。

![VsCode插件巡禮-phpcs-圖南科技]

如果同時安裝 PHP Sniffer 和 phpcs插件，但是沒有安裝PHP_CodeSniffer會出現以下錯誤

phpcs: Unable to locate phpcs. Invalid version string encountered!

PHP_CodeSniffer典型使用

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

使用規范

1 方法注釋 參數，返回值三項用空行分割

![phpcs.png]

2 參數必須有注釋，也識別空格，多個參數縱向需要對齊。

3 每一行的代碼長度不能超過一定的長度。

>Line exceeds 85 characters; contains 98 characters

4 私有方法使用下劃線開始。

>Private method name " " must be prefixed with an underscore

總結

VsCode中對于插件phpcs安裝方式的介紹，實際上更多是PHP_CodeSniffer工具的安裝介紹，插件的作用就是幫助項目與PHP_CodeSniffer做關聯。要體驗到完善的phpcs使用體驗，還需要PHP智能注釋這個插件，自動為方法提供注釋，再手動做細節調整。

Code Review是保證團隊代碼質量的重要措施之一，而代碼規范是Code Review的重要一環，而代碼規范又要借助于有效的工具，phpcs就是這樣的工具，推動代碼整潔，高效開發，培養工程師對于代碼整潔度的潔癖和質量交付的嚴格約束。

看完上述內容，你們掌握VsCode插件phpcs安裝執行過程中遇到的問題及解決方法的方法了嗎？如果還想學到更多技能或想了解更多相關內容，歡迎關注億速云行業資訊頻道，感謝各位的閱讀！