重用checkstyle检查来定义基于XML的自定义模块

Question

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE module PUBLIC
      "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
      "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
<module name="Checker">

    <!-- Disable this -->
    <module name="RegexpSingleline">
        ...
    </module>

    <!-- Disable that -->
    <module name="RegexpSingleline">
        ...
    </module>

    ...
</module>

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE module PUBLIC
      "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
      "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
<module name="Checker">

    <!-- Disable this -->
    <myCheck name="DisableNastyThing1">
        <module name="RegexpSingleline">
            ...
        </module>
    </myCheck>

    <!-- Disable that -->
    <myCheck name="DisableNastyThing2">
        <module name="RegexpSingleline">
            ...
        </module>
    </myCheck>

    ...
</module>

禁止DisableNastyThing1或DisableNastyThing2的工作方式与禁止模块完全相同。换句话说，myCheck XML元素名将表示这样一个事实，即该检查没有映射到实现AbstractCheck的实际Java类，而是映射到执行嵌套在其中的检查的一些通用检查。

是不是Checkstyle中已经有这样的概念，而我却没能找到它，还是怎么的？

Answer 1

您可以向每个检查添加id属性，如下所示：

<!-- Disable this -->
<module name="RegexpSingleline">
    <property name="id" value="DisableNastyThing1"/>
    ...
</module>

<!-- Disable that -->
<module name="RegexpSingleline">
    <property name="id" value="DisableNastyThing2"/>
    ...
</module>

然后可以在suppressons.xml中引用ID：

<suppress files="some/files/" id="DisableNastyThing1" />
<suppress files="some/other/files/" id="DisableNastyThing2" />

这样，您只抑制了一些RegexpSingleLine实例，而不是全部实例。