以 Composer 的方式在 PhpStorm 中添加代碼審查工具 Code Sniffer


一、前提條件

  1. Windows 操作系統
  2. 可以在本地運行的 PHP 環境,個人用的是 laragon
  3. PhpStorm
  4. Composer

 

二、設置步驟

  (一)下載 Code Sniffer

  主要使用 PHP 包管理工具 Composer 來獲取 Code Sniffer。只要本地安裝好了 Composer 並且已經將 Composer 執行文件加入了 PATH 目錄,那么就可以在任意目錄下運行 Composer 命令。這里強烈推薦 laragon,它幾乎包含了現代 PHP 開發所需的大部分工具。以下所涉及到的工具都集成在 laragon 了。

 

  操作過程:

  1. Ctrl + Alt + T 打開 cmder

  2. 進入項目目錄:cd C:\laragon\www\basic

  3. 安裝 Code Sniffer:composer require spryker/code-sniffer

 

  建議在通過 composer 安裝軟件包的時候,請到 https://packagist.org 查詢一下這個包,然后根據提示命令安裝:

  

 

  在輸入紅線框里面的命令后,如果當前項目目錄中沒有 composer.json 文件,那么 composer 會自動將所有涉及到的包安裝到當前項目的 vendor 目錄,當然這個目錄也是自動創建的。

 

  (二)設置 PHP 本地執行環境

  打開phpstorm,點擊 file --> Settings --> Languages & Frameworks --> PHP 進入以下界面並設置:

 

  PHP language level 我選擇的是 PHP 7.0,目前最多選擇 PHP 7.1。其次是選擇 Interpreter 的文件目錄,點擊那“三個小點”按鈕,然后選擇 PHP 執行目錄。

  

 

 

  選擇左上角的綠色加號按鈕即可添加:

  

 

  最后點擊 Apply 讓設置生效。

 

  (三)設置 Code Sniffer

    在 Settings 設置界面的搜索框中輸入:Code Sniffer

   

  

  PHP Code Sniffer (phpcs) 目錄為:C:\laragon\www\basic\vendor\bin\phpcs.bat。如果點擊 Validate 按鈕后沒有彈出校驗成功的信息,那么請確認 PHP 的 PATH目錄是否安裝到位了。

   

 

其實有很多通過 composer 安裝的軟件包都可以通過這種方式來運行。比如我還想安裝 Mess Detector 那么依舊通過這種安裝方式來運行相應的軟件包。

 

  那么 Code Sniffer 就安裝完畢了,具體操作請參考 Code Sniffer 的官方文檔,或搜索其他相關教程。

 

  

 

  

 

  

 

  


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM