php - PHPCS - 嗅探以在关闭之后和返回之前强制执行新行？

Question

我们正在运行各种嗅探以帮助保持一致性，同时使用 eslint - 所以我们正在尝试统一一些规则。我们可以在 eslint 中做到这一点，但无法弄清楚如何在 phpcs 中做到这一点。

关闭后的新行，例如

tap(function () {
    return true;
});

$cake = 'yes please';

阻止

tap(function () {
    return true;
});
$cake = 'yes please';

在 return 语句之前强制空行（不是方法中的唯一语句）

getSomething()
{
    $something = 'something';

    return $something;
}

或者

getSomething()
{
    return 'something';
}

而不是

getSomething()
{
    $something = 'something';
    return $something;
}

谢谢 ：）

Answer 1

对于之前的空行return，您可以使用PHP CS Fixerblank_line_before_statement中的规则

要将它与 PHP_CodeSniffer 一起使用，最好的方法是使用EasyCodingStandard。

1.安装它

composer require --dev symplify\easy-coding-standard

2.配置它

# easy-coding-standard.neon
checkers:
    - PhpCsFixer\Fixer\ReturnNotation\BlankLineBeforeReturnFixer

3. 在你的代码上运行它

vendor/bin/ecs check src

4.修复你的代码

vendor/bin/ecs check src --fix

对于闭包，您还必须调整原始规则以包含闭包令牌。

如果出现任何问题，只需在此处创建问题即可。我很高兴尽可能地改进这个工具。