前言:良好的代碼規(guī)范可以提高代碼可讀性,減少團(tuán)隊(duì)溝通維護(hù)成本坝疼,所以本文嘗試PSR-2代碼規(guī)范進(jìn)行代碼格式化搜贤。
正文:
(1)使用環(huán)境:
????? ? ? ? ????????IDE:phpstorm2017.3.6
? ? ? ? ? ? ????????插件:phpcs和php-cs-fixer
(2)安裝phpcs
composer global require 'squizlabs/php_codesniffer=*'
(3)安裝php-cs-fixer
composer require friendsofphp/php-cs-fixer
注意:如果按照網(wǎng)上舊的教程,上面的命令會變成
composer global require fabpot/php-cs-fixer
fabpot/php-cs-fixer?這個(gè)包在Packagist上已經(jīng)被Abandon了钝凶,可以使用仪芒,但是在使用過程中會報(bào)Warning,并且提示讓你使用friendsofphp/php-cs-fixer耕陷,所以看到這篇文章的同志們可以直接安裝friendsofphp/php-cs-fixer
如果已經(jīng)安裝了fabpot/php-cs-fixer掂名,有強(qiáng)迫癥想改成friendsofphp/php-cs-fixer,可以使用如下命令去掉composer依賴
composer remove fabpot/php-cs-fixer
(4)設(shè)置PHPStorm--phpcs
PhpStorm設(shè)置
● 步驟1:打開PhpStorm點(diǎn)擊 File->Settings
● 步驟2:接著點(diǎn)擊Languages & Frameworks->PHP->Code Sniffer點(diǎn)擊Configuration右側(cè)的按鈕哟沫,
● 步驟3:選擇PHP Code Sniffer (phpcs) path:的路徑饺蔑,就是剛才composer之后生成的那個(gè)phpcs.bat的路徑。
● 步驟4:選擇之后點(diǎn)擊Validate驗(yàn)證成功
● 步驟5:節(jié)點(diǎn)點(diǎn)擊Editor->Inspections展開點(diǎn)擊右側(cè)的PHP
● 步驟6:勾選PHP Code Sniffer Validation 選擇右側(cè)的PSR2
● 步驟7:點(diǎn)擊驗(yàn)證成功 大功告成J染鳌猾警!
效果:
(5)設(shè)置PHPStorm--php-cs-fixer
name和description可自行填寫
program需要填寫php-cs-fixer的可執(zhí)行文件地址孔祸,Windows上是用戶目錄\Roaming\Composer\composer\vendor\bin\php-cs-fixer.bat,linux和mac上是~/.composer/vendor/bin/php-cs-fixer
Arguments/parameters填--rules=@Symfony --verbose fix "$FileDir$/$FileName$"发皿,其中rules字段具體可以查看 php-cs-fixer 的官方文檔崔慧,但是由于 Windows 的 cmd 有諸多限制,所以只能傳入一些簡單的規(guī)則穴墅,如果需要配置復(fù)雜規(guī)則建議使用配置文件來完成惶室。
working directory填$ProjectFileDir$
插件配置好以后,到Keymap中設(shè)置一個(gè)快捷鍵封救,就可以使用了
使用效果如下圖
由于我開啟了Xdebug拇涤,這邊會有Warning,意思是會影響效率誉结,可以忽略鹅士,至此,PHPStorm中成功使用phpcs和php-cs-fixer進(jìn)行代碼格式化PSR-2
本文參考了:
1.PHPStorm中使用php-cs-fixer進(jìn)行自動代碼格式化
4.Package fabpot/php-cs-fixer is abandoned message in Magento 2