團(tuán)隊(duì)代碼風(fēng)格控制 PHP-CS-Fixer

項(xiàng)目鏈接:https://github.com/FriendsOfPHP/PHP-CS-Fixer

在 CI 中使用(末尾有本地使用辦法)

在項(xiàng)目中安裝:

./composer.phar require --dev friendsofphp/php-cs-fixer

添加命令:

IFS='
'
CHANGED_FILES=$(git diff --name-only --diff-filter=ACMRTUXB "${COMMIT_RANGE}")
if ! echo "${CHANGED_FILES}" | grep -qE "^(\\.php_cs(\\.dist)?|composer\\.lock)$"; then EXTRA_ARGS=$(printf -- '--path-mode=intersection\n--\n%s' "${CHANGED_FILES}"); else EXTRA_ARGS=''; fi
vendor/bin/php-cs-fixer fix --config=.php_cs.dist -v --dry-run --stop-on-violation --using-cache=no ${EXTRA_ARGS}

配置文件

你可以在項(xiàng)目的根目錄放置 .php_cs.dist 文件。文件必須返回一個(gè) PhpCsFixer\ConfigInterface 實(shí)例泼返,它可以讓你自定義規(guī)則,需要分析的目錄。

你也可以創(chuàng)建 .php_cs 文件,它是本地配置尽爆,會(huì)覆蓋項(xiàng)目配置孵运。使用 --config 選項(xiàng),你可以指定 .php_cs 的路徑桥胞。

下面是一個(gè)例子:

<?php

$finder = PhpCsFixer\Finder::create()
    ->exclude('somedir')
    ->notPath('src/Symfony/Component/Translation/Tests/fixtures/resources.php')
    ->in(__DIR__)
;

return PhpCsFixer\Config::create()
    ->setRules([
        '@PSR2' => true,
        'strict_param' => true,
        'array_syntax' => ['syntax' => 'short'],
    ])
    ->setFinder($finder)
;

注意exclude 會(huì)作用于目錄恳守,所以如果你需要排除文件,使用 noPath贩虾。上述方法只能接收相對路徑催烘,相對于在 in 方法中定義的那個(gè)。

你可以使用排除法設(shè)定規(guī)則缎罢,下面代碼使用了全部 Symfony 規(guī)則伊群,但排除了full_opening_tag

<?php

$finder = PhpCsFixer\Finder::create()
    ->exclude('somedir')
    ->in(__DIR__)
;

return PhpCsFixer\Config::create()
    ->setRules([
        '@Symfony' => true,
        'full_opening_tag' => false,
    ])
    ->setFinder($finder)
;

示例規(guī)則

<?php
$finder = PhpCsFixer\Finder::create()
    ->exclude([
        'vendor',
    ])
    ->in(__DIR__);

$header = <<<EOF
This file is part of wdshop.

(c) wdshop <http://ynwudian.com>

For the full copyright and license information, please view the LICENSE
file that was distributed with this source code.
EOF;
return PhpCsFixer\Config::create()
    ->setRules([
        '@Symfony' => true,
        'header_comment' => ['header' => $header],
        'array_syntax' => ['syntax' => 'short'],
        'ordered_imports' => true,
        'no_useless_else' => true,
        'no_useless_return' => true,
        'php_unit_construct' => true,
        'php_unit_strict' => true,
    ])
    ->setFinder($finder);

在本地使用

全局安裝:

composer require -g friendsofphp/php-cs-fixer

到目錄執(zhí)行(有 .php_cs 的目錄):

php-cs-fixer fix
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末策精,一起剝皮案震驚了整個(gè)濱河市舰始,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌咽袜,老刑警劉巖丸卷,帶你破解...
    沈念sama閱讀 216,402評論 6 499
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異询刹,居然都是意外死亡谜嫉,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,377評論 3 392
  • 文/潘曉璐 我一進(jìn)店門凹联,熙熙樓的掌柜王于貴愁眉苦臉地迎上來沐兰,“玉大人,你說我怎么就攤上這事蔽挠∩常” “怎么了?”我有些...
    開封第一講書人閱讀 162,483評論 0 353
  • 文/不壞的土叔 我叫張陵象泵,是天一觀的道長寞秃。 經(jīng)常有香客問我,道長偶惠,這世上最難降的妖魔是什么春寿? 我笑而不...
    開封第一講書人閱讀 58,165評論 1 292
  • 正文 為了忘掉前任,我火速辦了婚禮忽孽,結(jié)果婚禮上绑改,老公的妹妹穿的比我還像新娘。我一直安慰自己兄一,他們只是感情好厘线,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,176評論 6 388
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著出革,像睡著了一般造壮。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,146評論 1 297
  • 那天耳璧,我揣著相機(jī)與錄音成箫,去河邊找鬼。 笑死旨枯,一個(gè)胖子當(dāng)著我的面吹牛蹬昌,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播攀隔,決...
    沈念sama閱讀 40,032評論 3 417
  • 文/蒼蘭香墨 我猛地睜開眼皂贩,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了昆汹?” 一聲冷哼從身側(cè)響起明刷,我...
    開封第一講書人閱讀 38,896評論 0 274
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎筹煮,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體居夹,經(jīng)...
    沈念sama閱讀 45,311評論 1 310
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡败潦,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,536評論 2 332
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了准脂。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片劫扒。...
    茶點(diǎn)故事閱讀 39,696評論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖狸膏,靈堂內(nèi)的尸體忽然破棺而出沟饥,到底是詐尸還是另有隱情,我是刑警寧澤湾戳,帶...
    沈念sama閱讀 35,413評論 5 343
  • 正文 年R本政府宣布贤旷,位于F島的核電站,受9級特大地震影響砾脑,放射性物質(zhì)發(fā)生泄漏幼驶。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,008評論 3 325
  • 文/蒙蒙 一韧衣、第九天 我趴在偏房一處隱蔽的房頂上張望盅藻。 院中可真熱鬧,春花似錦畅铭、人聲如沸氏淑。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,659評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽假残。三九已至,卻和暖如春炉擅,著一層夾襖步出監(jiān)牢的瞬間守问,已是汗流浹背匀归。 一陣腳步聲響...
    開封第一講書人閱讀 32,815評論 1 269
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留耗帕,地道東北人穆端。 一個(gè)月前我還...
    沈念sama閱讀 47,698評論 2 368
  • 正文 我出身青樓,卻偏偏與公主長得像仿便,于是被迫代替她去往敵國和親体啰。 傳聞我的和親對象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,592評論 2 353

推薦閱讀更多精彩內(nèi)容