美文网首页
团队代码风格控制 PHP-CS-Fixer

团队代码风格控制 PHP-CS-Fixer

作者: fourn熊能 | 来源:发表于2020-01-19 11:44 被阅读0次

项目链接:https://github.com/FriendsOfPHP/PHP-CS-Fixer

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

在项目中安装:

./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}

配置文件

你可以在项目的根目录放置 .php_cs.dist 文件。文件必须返回一个 PhpCsFixer\ConfigInterface 实例,它可以让你自定义规则,需要分析的目录。

你也可以创建 .php_cs 文件,它是本地配置,会覆盖项目配置。使用 --config 选项,你可以指定 .php_cs 的路径。

下面是一个例子:

<?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 会作用于目录,所以如果你需要排除文件,使用 noPath。上述方法只能接收相对路径,相对于在 in 方法中定义的那个。

你可以使用排除法设定规则,下面代码使用了全部 Symfony 规则,但排除了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)
;

示例规则

<?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

到目录执行(有 .php_cs 的目录):

php-cs-fixer fix

相关文章

网友评论

      本文标题:团队代码风格控制 PHP-CS-Fixer

      本文链接:https://www.haomeiwen.com/subject/tflrzctx.html