phpcs：如何修改PSR2来检查大括号是否与方法在同一行上？

php phpcs codesniffer rules

2022-08-30 23:24:18

我现在花了2个多小时试图弄清楚如何要求与方法声明在同一行中，而不是默认要求是下一行。我该如何完成此操作？我已将PSR2标准复制到一个名为PSR2的新文件夹中，以便根据自己的喜好对其进行修改。因此，我正在研究的基础基本上是我想修改的PSR2标准。{

我已经尝试了规则集.xml并且我尝试直接在代码中修改它，但没有成功。

<rule ref="PEAR.Classes.ClassDeclaration">
    <properties>
        <property name="eolChar" value="{"/>
    </properties>
</rule>
<rule ref="PSR2R.Classes.ClassDeclaration">
    <properties>
        <property name="eolChar" value="{"/>
    </properties>
</rule>

我已经发现这是错误的。EOL 由 phpcs 设置。但是我无法确定是否有可以通过规则配置的值。

到目前为止，这对我来说很好（搞砸了愚蠢的空间!!!）：

<?xml version="1.0"?>
<ruleset name="PSR2R">
    <description>PSR2 with tabs instead of spaces.</description>
    <arg name="tab-width" value="4"/>
    <rule ref="PSR2">
        <exclude name="Generic.WhiteSpace.DisallowTabIndent"/>
    </rule>
    <rule ref="Generic.WhiteSpace.DisallowSpaceIndent"/>
    <rule ref="Generic.WhiteSpace.ScopeIndent">
        <properties>
            <property name="indent" value="4"/>
            <property name="tabIndent" value="true"/>
        </properties>
    </rule>
</ruleset>

但我想添加上面的规则。

答案 1

将此代码放在规则集.xml文件中：

<rule ref="PSR2">
    <exclude name="Squiz.Functions.MultiLineFunctionDeclaration.BraceOnSameLine" />
</rule>
<rule ref="Generic.Functions.OpeningFunctionBraceKernighanRitchie" />

这将包括 PSR2 标准，但不包括有关需要在同一行上的大括号的特定消息。然后，它包括强制方法和函数大括号位于下一行的通用嗅探。

进行此更改后，此代码：

<?php
namespace Test;

class Foo
{
    public function bar() {
    }
}

不会产生任何错误，但直接在其上运行 PSR2 会产生一个错误：

FILE: temp.php
----------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
----------------------------------------------------------------------
 6 | ERROR | [x] Opening brace should be on a new line
----------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------

答案 2

除了Greg的答案之外，如果您使用的是PHPStorm，请转到，您将看到一个选项。Settings -> Editor -> Inspections -> PHP -> Code SnifferShow sniff name

这将为您提供违规规则的名称（首先，在中配置 PHP 代码嗅探器可执行路径）。然后在源代码文件中的警告工具提示上，小心地移动光标，选择文本，在不松开按钮的情况下，按下以复制它。Settings -> Languages and frameworks -> PHP -> Code snifferControl C

然后将其粘贴到规则中：

<?xml version="1.0"?>
<ruleset name="PSR2R">
    <rule ref="PSR2">
        <exclude name="Squiz.Functions.MultiLineFunctionDeclaration.BraceOnSameLine" />
        <exclude name="PSR2.Classes.ClassDeclaration.OpenBraceNewLine" />
    </rule>
    <rule ref="Generic.Functions.OpeningFunctionBraceKernighanRitchie" />
</ruleset>

我在这里添加了排除的规则。PSR2.Classes.ClassDeclaration.OpenBraceNewLine