團(tuán)隊(duì)代碼風(fēng)格和質(zhì)量管理上晶丘,即便有代碼風(fēng)格文檔推薦時(shí)也難以去更改大家的習(xí)慣浮梢,所以需要使用工具來(lái)規(guī)范化跛十,php 一半使用 php-cs-fixer 來(lái)管理
安裝
全局安裝 friendsofphp/php-cs-fixer 包
$ composer global require friendsofphp/php-cs-fixer
PHPSTORM 配置
配置 php-cs-fixer
上圖參數(shù)說(shuō)明(圖片顯示不了可能太大,可以復(fù)制鏈接查看):
參數(shù) | 參考值 | 備注 |
---|---|---|
NAME | php-cs-fixer |
任意填寫 |
Description | 規(guī)范代碼 | 描述內(nèi)容,任意填寫 |
Program | /Users/me/.composer/vendor/friendsofphp/php-cs-fixer/php-cs-fixer |
composer 安裝的php-cs-fixer 路徑秕硝,win 上是 的php-cs-fixer.bat |
Arguments | fix $FileDir$ --rules=@PSR12 |
此處采用 PSR12 的規(guī)范芥映,規(guī)則可以自己編寫 |
Working Directory | $ProjectFileDir$ |
填寫 phpstorm 的變量宏指令就可以 |
關(guān)于 Arguments
可以根據(jù)團(tuán)隊(duì)規(guī)范,去寫對(duì)應(yīng)的規(guī)則文件
配置快捷鍵
后續(xù)按快捷鍵接可以自動(dòng)規(guī)范代碼了
規(guī)則文件
規(guī)則文件可以是「團(tuán)隊(duì)規(guī)則」远豺,整個(gè)團(tuán)隊(duì)統(tǒng)一使用奈偏,放到 git 進(jìn)行同步管理;
也可以「項(xiàng)目規(guī)則」憋飞,不同項(xiàng)目使用不同規(guī)范霎苗,放到項(xiàng)目根目錄下,跟隨項(xiàng)目榛做;
團(tuán)隊(duì)規(guī)則
任意地方
Arguments :fix $FileDir$/$FileName$ --config=/Users/me/phpRules/.php-cs-fixer.php
項(xiàng)目規(guī)則
將規(guī)則文件 .php-cs-fixer.php 放到項(xiàng)目根目錄
Arguments :fix $FileDir$/$FileName$ --config=$ProjectFileDir$/.php-cs-fixer.php
常見配置說(shuō)明:
https://xiaoteng.vip/archives/changyong-de-php-cs-fixer-de-guize.html
https://qiita.com/ucan-lab/items/7d4180462347a42009d5
參考
https://laravelacademy.org/post/21908