如何正确覆盖 PHP Code嗅探器规则集中的规则/嗅探器,并避免重复检查代码


How to override a rule/sniff in a PHP CodeSniffer ruleset correctly and to avoid doublechecking of code?

我已经扩展了PSR-2嗅探集的一个类。现在检查执行两次 - 即使我的 chid 类是空的。

为什么?以及如何正确做到这一点?


编辑:

我现在知道为什么:嗅探器可能自下而上地处理规则集 - 从实际调用的标准的规则集到最高(直接或间接包含)父标准。它显然完全执行它们。(是这样吗?好吧,但是该怎么办?如何覆盖父规则集 - 替换它们的类但自定义的类并停用单个规则?


法典:

[CodeSniffer]/Standards/ZF/ruleset.xml

<?xml version="1.0"?>
<ruleset name="ZF">
    <description>...</description>
    <!-- Include the whole PSR-2 standard -->
    <rule ref="PSR2"/>
    <!-- Argument lists MAY be split across multiple lines, where each subsequent line is indented once. When doing so, the first item in the list MUST be on the next line, and there MUST be only one argument per line. When the argument list is split across multiple lines, the closing parenthesis and opening brace MUST be placed together on their own line with one space between them. -->
    <rule ref="ZF.Functions.MultiLineFunctionDeclaration"/>
    ... just comments yet
    <!-- 5.7.2. Closure Definitions -->
    <!-- TODO: Revome unwished check: Space after the function keyword is required. -->
    <!-- 5.7.3. Function and Method Usage -->
    <!-- TODO: Revome unwished check: one argument per line in a multi-line function call is required. -->
    ... just comments yet
</ruleset>

[CodeSniffer]/Standards/ZF/Sniffs/Functions/MultiLineFunctionDeclarationSniff.php

<?php
if (class_exists('PEAR_Sniffs_Functions_FunctionDeclarationSniff', true) === false) {
    $error = 'Class PEAR_Sniffs_Functions_FunctionDeclarationSniff not found';
    throw new PHP_CodeSniffer_Exception($error);
}
class ZF_Sniffs_Functions_MultiLineFunctionDeclarationSniff extends PEAR_Sniffs_Functions_FunctionDeclarationSniff
{
    public function processMultiLineDeclaration(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $tokens)
    {
    }
    public function processBracket(PHP_CodeSniffer_File $phpcsFile, $openBracket, $tokens, $type='function')
    {
    }
}
?>

叫:

$ phpcs --standard=ZF -sw /path/to/Test.php
FILE: /path/to/Test.php
--------------------------------------------------------------------------------
FOUND 2 ERROR(S) AFFECTING 1 LINE(S)
--------------------------------------------------------------------------------
 106 | ERROR | Expected 1 space after FUNCTION keyword; 0 found
     |       | (ZF.Functions.MultiLineFunctionDeclaration.SpaceAfterFunction)
 106 | ERROR | Expected 1 space after FUNCTION keyword; 0 found
     |       | (Squiz.Functions.MultiLineFunctionDeclaration.SpaceAfterFunction)
--------------------------------------------------------------------------------

背景资料:

我想为 Zend Framework 2 项目编写一个 PHP CodeSniffer 规则集。大约一半的 Zend Framework 2 编码标准已经在 PSR-2 嗅探文件夹中实现。

现在的目标不是实现整个 Zend 标准。我想从PSR-2开始,也许可以逐步添加/实现其他Zend规则。

问题是,PSR-2嗅探还包含一些检查,这些检查违反了Zend标准。所以我必须覆盖这些嗅探。示例:/path/to/php/PHP/CodeSniffer/Standards/Squiz/Sniffs/Functions/MultiLineFunctionDeclarationSniff.php(闭包中 function 关键字后需要空格)。PSR-2基于PSR-1,它使用这种嗅探。所以我必须覆盖它们。

使用exclude方向很容易排除单个嗅探,例如:

<?xml version="1.0"?>
<ruleset name="ZF">
    <description>...</description>
    <!-- Include the whole PSR-2 standard -->
    <rule ref="PSR2">
        <!-- to disable a single error -->
        <exclude name="Squiz.Functions.MultiLineFunctionDeclaration.SpaceAfterFunction"/>
        <!-- or to disable the whole sniff -->
        <exclude name="Squiz.Functions.MultiLineFunctionDeclaration"/>
    </rule>
    ...
</ruleset>

而不是

<?xml version="1.0"?>
<ruleset name="ZF">
    <description>...</description>
    <!-- Include the whole PSR-2 standard -->
    <rule ref="PSR2"/>
    ...
</ruleset>

覆盖 = 排除嗅探 + 创建替代嗅探。

另请参阅 PHP CodeSniffer 手册中的注释示例ruleset.xml