如何忽略行长度 PHP_CodeSniffer

Question

我一直在 jenkins 中使用 PHP_CodeSniffer，我的 build.xml 配置为 phpcs

<target name="phpcs">
    <exec executable="phpcs">
        <arg line="--report=checkstyle --report-file=${basedir}/build/logs/checkstyle.xml --standard=Zend ${source}"/>
    </exec>
</target> 

，如下所示 我想忽略以下警告

FOUND 0 ERROR(S) AND 1 WARNING(S) AFFECTING 1 LINE(S)
--------------------------------------------------------------------------------
 117 | WARNING | Line exceeds 80 characters; contains 85 characters
--------------------------------------------------------------------------------

如何忽略行长度警告？

Answer 1

您可以创建自己的标准。 Zend 非常简单（在使用 PEAR 安装后，它位于我的 Debian 安装中的 /usr/share/php/PHP/CodeSniffer/Standards/Zend/ruleset.xml 中）。基于它创建另一个，但忽略行长度位：

<?xml version="1.0"?>
<ruleset name="Custom">
 <description>Zend, but without linelength check.</description>
 <rule ref="Zend">
  <exclude name="Generic.Files.LineLength"/>
 </rule>
</ruleset>

并设置 --standard=/path/to/your/ruleset.xml。

或者，如果您只想在触发此操作之前增加字符计数，请重新定义规则：

 <!-- Lines can be N chars long (warnings), errors at M chars -->
 <rule ref="Generic.Files.LineLength">
  <properties>
   <property name="lineLimit" value="N"/>
   <property name="absoluteLineLimit" value="M"/>
  </properties>
 </rule>

Answer 2

忽略消息 行超过 x 个字符 的另一种方法是使用 --exclude 标志来排除规则。

vendor/bin/phpcs --standard=PSR2  --exclude=Generic.Files.LineLength app/

为了找到要排除的规则名称，请在以下目录中找到相应的规则集：

vendor/squizlabs/php_codesniffer/src/Standards//ruleset.xml

规则名称将位于ref 节点：

 <rule ref="Generic.Files.LineLength">
        <properties>
            <property name="lineLimit" value="120"/>
            <property name="absoluteLineLimit" value="0"/>
        </properties>
 </rule>

速度更快，而且速度更快。比创建单独的规则集更方便。

Answer 3

1. 查找文件 CodeSniffer/Standards/PEAR/ruleset.xml – 在 mac/linux 上您可以在终端中搜索：

   找到 PEAR/ruleset.xml 或 sudo find / -name "ruleset.xml"

2. 然后您需要找到以下几行在ruleset.xml中：

   
<规则引用=“Generic.Files.LineLength”>
<属性>
<属性名称=“lineLimit”值=“85”/>
<属性名称=“absoluteLineLimit”值=“0”/>



3. 只需将数字 85（行的最大长度）更改为您想要的即可。

请注意，phpc 的默认编码标准是 PEAR 标准。因此，您需要在此位置编辑ruleset.xml：CodeSniffer/Standards/PEAR/ruleset.xml

Answer 4

如果您不想每次都使用参数输入整个命令 --standard=PSR2 --exclude=Generic.Files.LineLength app/ 您可以创建文件 phpcs.xml > 在您的主目录中，并覆盖规则设置。

<?xml version="1.0"?>
<ruleset name="PHP_CodeSniffer">

    <rule ref="PSR2" /> <!-- ruleset standard -->
    <rule ref="Generic.Files.LineLength"> <!-- rule to override -->
        <properties>
            <property name="lineLimit" value="150"/> <!-- maximum line length -->
        </properties>
    </rule>
    <file>app</file> <!-- directory you want to analyze -->
    <arg name="encoding" value="utf-8"/>
</ruleset>

然后您只需键入以下命令：

vendor/bin/phpcs