PMD自定义规则集 - 也许你拼错了规则名称?

时间:2018-02-23 18:48:33

标签: java maven-plugin pmd

我正在尝试将pmd集成到我的项目中。但我收到了以下错误

  

java.lang.IllegalArgumentException:找不到规则。也许你拼错了规则名称?

pom.xml条目如下 -

<reporting>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-pmd-plugin</artifactId>
            <version>3.7</version>
            <configuration>
                <linkXRef>false</linkXRef>
                <rulesets>             
                    <ruleset>
                        pmdruleset.xml
                    </ruleset>
                </rulesets>
            </configuration>
        </plugin>
    </plugins>
</reporting>

自定义规则集文件包含以下内容 -

<?xml version="1.0"?>
<ruleset name="Controversial"
         xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 http://pmd.sourceforge.net/ruleset_2_0_0.xsd">

    <description>
        <rule ref="rulesets/java/errorprone.xml/NullAssignment"/>
    </description>
</ruleset>

我无法理解错误。有人可以帮忙!

1 个答案:

答案 0 :(得分:3)

@ eclipse-pmd是对的,规则标记需要是规则集标记的子代。

此外,您尝试使用的规则(NullAssignment)不在规则集错误中,但存在争议。对于PMD 6,规则还被组织成类别,现在属于&#34; errorprone&#34;。关于这一点的更多内容将随之而来。

maven-pmd-plugin 3.7 / PMD 5.5.1

您使用的是maven-pmd-plugin版本3.7 - &gt;这意味着,您将自动使用旧的PMD版本(准确地说是版本5.5.1)。对于此版本,您的规则集应如下所示:

<?xml version="1.0"?>
<ruleset name="Custom Ruleset"
     xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 http://pmd.sourceforge.net/ruleset_2_0_0.xsd">

    <description>
        Custom Ruleset
    </description>

    <rule ref="rulesets/java/controversial.xml/NullAssignment"/>
</ruleset>

PMD 5.5.1的文档位于:https://pmd.github.io/pmd-5.5.1/pmd-java/rules/java/controversial.html#NullAssignment

maven-pmd-plugin 3.9.0 / PMD 6.0.1

如果您切换到最新的maven-pmd-plugin版本3.9.0,您将自动使用PMD 6.0.1并从最新的错误修正中受益。您可以继续使用上面的规则集,但是您会看到弃用通知,因为我们移动了规则。要消除此警告,请使用以下规则参考:

<rule ref="category/java/errorprone.xml/NullAssignment" />

PMD 6.0.1的文档位于:https://pmd.github.io/pmd-6.0.1/pmd_rules_java_errorprone.html#nullassignment

有关规则集的文档位于:https://pmd.github.io/pmd-6.0.1/pmd_userdocs_understanding_rulesets.html