推薦12-PhpStorm 使用 PHPCS 檢查程式碼規範及自動修正和Git提交檢查
- 2019 年 10 月 5 日
- 筆記
在團隊開發中，每個人的程式碼風格都不一樣，為了日後方便更新和維護，必須考慮協作和編碼規範。
本文就介紹如何在 PhpStorm 中配置 PSR2 程式碼規範檢查和保存自動格式化修復，以及利用 Git Hook 對提交的程式碼進行檢查。
正文
安裝PHP-CS
composer global require "squizlabs/php_codesniffer=*"
安裝完成後會在全局依賴包目錄生成 phpcbf 和 phpcs 文件
查看 composer 全局依賴包路徑，下面會用到
composer global config bin-dir --absolute
配置 PhpStorm 使用 PSR-2 標準
1. 程式碼風格
2. 設置 PHP-CS 路徑
3. 程式碼檢查
如果沒有下拉選項，可以點擊旁邊的刷新按鈕
還有這個
配置到這裡後，打開一個 PHP 文件，就會在不符合 PSR-2 的程式碼下邊加一條波浪線
使用 Ctrl + Alt + L 將會自動格式化成 PSR-2 的風格
集成 PHP-CS
經過上面的操作，Phpstorm 程式碼格式化的規則基本與 PHP-CS 的規則基本一致了，但也有一小部分不一致，所以後面還要用到 phpcs 和 phpcbf
參數說明
Program： phpcs/phpcbf 路徑
Arguments：
--standard=PSR2 $FileDir$/$FileName$ ## 當前文件 --standard=PSR2 $FileDir$ ## 當前文件夾
Working directory： $ProjectFileDir$
使用方法
配置保存自動格式化和修復
1. 為 phpcbf 添加快捷鍵
2. 錄製宏
步驟：
Ctrl + Alt + L Ctrl + Alt + Shift + P Ctrl + S
3. 為宏配置快捷鍵
先刪除默認的保存快捷鍵 Ctrl + S ，另外配置一個別的快捷鍵 Ctrl + Alt + Shift + S
為宏配置快捷鍵
利用 Git Hook 對提交的程式碼進行檢查
安裝 GrumPHP
composer require --dev phpro/grumphp
安裝完後會自動生成一個 grumphp.yml
請修改成：
parameters: git_dir: . bin_dir: vendor/bin tasks: phpcs: standard: PSR2 ignore_patterns: - ./database/* - ./vendor/*
這樣 git commit 的時候就會對提交的程式碼進行檢查，只有符合 PSR-2 規範的程式碼才能通過。
原文鏈接：https://4ark.me/post/6959bf0.html