MacOS Sublime Text 3 安裝使用 Sublime-phpcs 外掛

lianglunzhong發表於2018-11-29
MacPHP

參考
https://www.uedbox.com/macos-install-subli...
部落格：手把手教你如何構建一個優秀的開源專案

安裝 PHPCS

PHPCS 是 PHP Code Sniffer，一款程式碼規範檢查工具，可以根據你的設定來檢查程式碼規範性問題。直接在系統終端中執行下面的命令安裝。

$ brew install php-code-sniffer

如果提示你需要先安裝編譯器，請按提示依次安裝即可。我安裝時的命令為：

$ xcode-select --install
$ brew install gcc
$ brew install php-code-sniffer

安裝 PHPCBF

PHPCBF 是 PHPCS 內建的程式碼規範修復工具，無需單獨安裝，大部分的程式碼規範問題它都可以自動修掉。

安裝 PHPMD

PHPMD 是 PHP Mess Detector ，程式碼複雜度檢測工具，能夠很方便的檢查你的程式碼是不是寫得複雜度過高。安裝命令如下：

$ wget -c http://static.phpmd.org/php/latest/phpmd.phar
$ chmod a+x phpmd.phar
$ mv phpmd.phar /usr/local/bin/phpmd

網上說可以透過 Homebrew 安裝，但我試了 brew install php-mess-detector 和 brew install phpmd 都提示沒有對應的包。

檢視安裝路徑

PHPCS 和 PHPMD 都安裝成功之後，可透過下面命令分別檢視 php、phpcs、phpcbf、phpmd 的路徑，後面配置 Sublime Text 的外掛時會用到。

$ which php
$ which phpcs
$ which phpcbf
$ which phpmd

安裝 sublime-phpcs 外掛

外掛本身的安裝步驟不在贅述，使用sublime的Package安裝即可：

Preferences -> Package Control -> Install Package -> 搜尋phpcs

外掛安裝好後（在Preferences -> Package Setting 選單中可看到PHP Code Sniffer）要配置要用到的功能的phar包的執行檔案路徑，這時候如果你直接去開啟Preferences -> Package Setting -> PHP Code Sniffer -> Setting – Default 並且儲存，可能會有檔案不存在的錯誤提示，這時候需要手動建立一個Phpcs包的配置資料夾。參見 http://theaveragedev.com/making-php-code-s...
按提示在終端執行下面命令，建資料夾。然後再儲存該檔案即可。

$ mkdir ~/Library/Application\ Support/Sublime\ Text\ 3/Packages/Phpcs

配置外掛

開啟 Sublime Text 3

Preferences -> Package Setting -> PHP Code Sniffer -> Setting – User

在開啟的檔案中，寫入下面的配置。配置的路由為上面使用 which 檢視的路徑結果。

{
    "phpcs_php_path": "/usr/bin/php",
    "phpcs_executable_path": "/usr/local/bin/phpcs",
    "phpmd_executable_path": "/usr/local/bin/phpmd",
    "phpcbf_executable_path": "/usr/local/bin/phpcbf",
    // 開啟phpmd
    "phpmd_run": true
}

使用

配置成功後，用 Sublime Text 3 編輯 PHP 檔案，儲存時，會自動提示不符合規範的需要修改的地方。

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

相關文章