从 maven 插件中的 PMD 中删除单个规则检查

java maven pmd

2022-09-04 04:16:40

我想在POM中排除单个PMD规则，但它不起作用。我尝试创建一个pmd-exclude.xml（与pom.xml相同的目录）：

<?xml version="1.0"?>
<ruleset name="remove_rules">
    <description>Remove rules</description>
    <rule ref="rulesets/unnecessary.xml">
        <exclude name="UselessParentheses"/>
    </rule>
</ruleset>

从 http://www.ing.iac.es/~docs/external/java/pmd/howtomakearuleset.html，并在pom中引用它.xml：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-pmd-plugin</artifactId>
    <version>3.0.1</version>
    <configuration>
        <sourceEncoding>utf-8</sourceEncoding>
            <rulesets>
                    <ruleset>${pom.basedir}/pmd-exclude.xml</ruleset>
            </rulesets>
    </configuration>
</plugin>

但它不断报告这些规则。

另外：我不想指定它必须检查哪些规则，因为较新版本可以（并且将）包含新版本，并且我不想检查每个新版本中将运行哪些新规则。

答案 1

我认为您需要添加要检查的规则集，并仅丢弃不需要的特定规则。

pmd-exclude.xml应如下所示：

<?xml version="1.0" encoding="UTF-8"?>
<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    name="Android Application Rules"
    xmlns="http://pmd.sf.net/ruleset/1.0.0"
    xsi:noNamespaceSchemaLocation="http://pmd.sf.net/ruleset_xml_schema.xsd"
    xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0 http://pmd.sf.net/ruleset_xml_schema.xsd" >

    <description>Remove rules</description>

    <rule ref="rulesets/clone.xml" />
    <rule ref="rulesets/finalizers.xml" />
    <rule ref="rulesets/imports.xml" />
    <rule ref="rulesets/logging-java.xml" />
    <rule ref="rulesets/unnecessary.xml" >
        <exclude name="UselessParentheses" />
    </rule>

</ruleset>

答案 2

@marcelopazzo的解决方案对我有用。我只想补充一点，如果您正在使用多模块maven项目，那么您必须更新对pmd-exclude的引用.xml，除非您计划在每个模块中都有此文件的副本。

例

    <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-pmd-plugin</artifactId>
        <version>3.6</version>
        <configuration>
            <rulesets>
                <ruleset>${project.parent.basedir}/pmd-exclude.xml</ruleset>
            </rulesets>
        </configuration>
    </plugin>