Question

我在 java 项目中使用 Maven 3 和 Checkstyle 2.9.1 ，我有一个常用的checkstyle配置，我们正在使用在其他几个项目中也是如此。为避免将该配置文件复制和编辑到我自己的项目中，我使用抑制文件来禁用某些包中的所有检查（生成的代码）。

现在我要取消所有文件中的特定规则。

这是我的抑制文件：

<?xml version="1.0"?>
<!DOCTYPE suppressions PUBLIC "-//Puppy Crawl//DTD Suppressions 1.1//EN" "http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
<suppressions>
    <suppress files="my[\\/]generated[\\/]code[\\/]package" checks="."/>
    <suppress files=".*\\.java$" checks="IndentationCheck"/>
    <suppress files=".*\\.java$" checks="LineLengthCheck"/>
    <suppress files=".*\\.java$" checks="ExplicitInitializationCheck"/>
    <suppress files=".*\\.java$" checks="MemberNameCheck"/>
</suppressions>

这是我的POM：

...
<build>
    ...
    <plugins>
    ...
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-checkstyle-plugin</artifactId>
            <version>2.9.1</version>
            <configuration>
                <configLocation>${checkstyle.ruleset}</configLocation>
                <suppressionsLocation>${checkstyle.suppressions}</suppressionsLocation>
            </configuration>
        </plugin>
    </plugins>
</build>

我正在打电话

mvn checkstyle:checkstyle

生成报告，但抑制的警告仍在那里。

我在这里做错了什么？

Answer 1

好的，我终于设法为我的checkstyle配置构建一个工作的抑制文件。

我的原始问题与正则表达式有关，所以我现在使用files=".*\\.java$"代替files="."来禁止对所有文件进行特殊检查。我还禁止对某些文件进行所有检查。

以下是我的抑制文件中的一些示例：

<?xml version="1.0"?> suppressions PUBLIC "-//Puppy Crawl//DTD Suppressions 1.1//EN" "http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
<suppressions>
    <!-- suppress certain checks on all files in a package -->
    <suppress files="my[\\/]super[\\/]package[\\/]name" checks="ModifierOrderCheck|NeedBracesCheck|MagicNumberCheck"/>
    <!-- suppress all checks on all files in a package -->
    <suppress files="another[\\/]super[\\/]package[\\/]of[\\/]mine" checks=".*"/>
    <!-- suppress certain checks on all files -->
    <suppress files="." checks="IndentationCheck"/>
    <suppress files="." checks="LineLengthCheck"/>
    <suppress files="." checks="ExplicitInitializationCheck"/>
    <suppress files="." checks="MemberNameCheck"/>
    <suppress files="." checks="FinalClassCheck"/>
</suppressions>

如果您需要有关配置的 Maven 部分的帮助，请参阅@Mawia的answer。

Answer 2

这对我有用。

而不是做

<suppressionsLocation>${checkstyle.suppressions}</suppressionsLocation>

我把它放在$ {checkstyle.ruleset}中（我假设你是检查风格的xml文件）

<module name="SuppressionFilter">
    <property name="file" value="${checkstyle.suppressions}" />
</module>

我的$ {checkstyle.suppressions}有

<suppressions>
    <suppress files="package-info.java" checks="[a-zA-Z0-9]*"/>
    <suppress files="SomeClass.java" checks="[a-zA-Z0-9]*"/>
</suppressions>

在某些文件上禁止特定checkstyle规则的正确语法是什么？

2 个答案: