PHP工具篇:PHPStorm IDE使用CodeSniffer代碼規範化管理

PHPStorm IDE使用CodeSniffer進行代碼規範化管理

PHP_CodeSniffer是一個優秀的代碼風格檢測工具,定義了一系列的代碼規範(一般使用官方的代碼規範標準，好比PHP的PSR2),可以檢測出不符合代碼規範的代碼併發出警告或報錯(可設置報錯等級),常被用做團隊開發時維護編碼風格以及標準。

安裝

---

• mac安裝:

brew install php-code-sniffer
//檢測安裝是否成功
phpcs --h
//安裝完成後的路徑
/usr/local/Cellar/php-code-sniffer

phpcs的配置

---

1. 查看詳細配置。使用命令:phpcs --config-show
2. 設置默認的編碼標準。（這個很重要，建議使用 PSR2 的標準)

# 查看配置
$ phpcs -i
The installed coding standards are MySource, PEAR, PHPCS, PSR1, PSR2, Squiz and Zend

# 設置編碼標準爲 PSR2
$ phpcs --config-set default_standard PSR2

1. 隱藏警告。（固然，對於強迫症來講，警告都是不容許的，非強迫症患者能夠使用此配置項）

# 隱藏警告提醒
$ phpcs --config-set show_warnings 0
# 開啓警告提醒
$ phpcs --config-set show_warnings 1

1. 顯示檢查進程。（若是項目須要檢查的文件較多能夠開啓這個）

# 顯示檢查進程
$ phpcs --config-set show_progress 1
# 關閉進程顯示
$ phpcs --config-set show_progress 0

1. 顯示顏色

# 顯示顏色
$ phpcs --config-set colors 1
# 關閉顏色顯示
$ phpcs --config-set colors 0

1. 修改錯誤和警告等級

# 顯示全部的錯誤和警告
$ phpcs --config-set severity 1
# 顯示全部的錯誤，部分警告 注意等級可有從 5-8 5 的警告顯示會更多，8 的更少
$ phpcs --config-set severity 1
$ phpcs --config-set warning_severity 5

1. 設置默認編碼

# 設置 utf-8
$ phpcs --config-set encoding utf-8

1. 設置 tab 的寬度

# tab 爲 4 個空格
$ phpcs --config-set tab_width 4
# 也能夠對單獨文件生效
$ phpcs --tab-width=0 /path/to/code

1. 代碼驗證

# 校驗單個文件
$ phpcs filename
＃ 校驗目錄 注意這個時候別由於 linux 學的太好加個 -R 哈。
$ phpcs /path/dir

代碼規範檢測,命令行使用

---

$ phpcs /home/www/init.php
FILE: /home/www/init.php
-------------------------------------------------------------
FOUND 2 ERROR(S) AFFECTING 2 LINE(S)
-------------------------------------------------------------
  1 | ERROR | Extra newline found after the open tag
 13 | ERROR | Missing function doc comment
-------------------------------------------------------------

設置PHPStorm整合CodeSniffer

1. 配置 Code Sniffer

---

在 「Preferences」->「Languages & Frameworks」->「PHP」->「Quality Tools」 ->「Code Sniffer」 配置中，「Configuration」 項後點擊...並輸入 phpcs 路徑，能夠使用 「Validate」 按鈕驗證phpcs路徑是否正確。

1. 開啓驗證

---

在 「Preferences」->「Editor」->「Inspections」->「Quality Tools」配置中，勾選上 「PHP Code Sniffer validation」。

具體參數中,
Show warnings as: Warnning，標示提示級別
Coding standard PSR2 表明執行的規範若是找不到這個選項，點一下緊挨着的刷新按鈕。

更多精彩內容，請關注做者博客，https://studytime.xin