Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Remove a single rule check from PMD in maven plugin

Tags:

java

maven

pmd

I want to exclude a single PMD rule in POM, but it is not working. I have tried creating a pmd-exclude.xml (in the same dir as the pom.xml):

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

From http://www.ing.iac.es/~docs/external/java/pmd/howtomakearuleset.html and referenced it in 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>

But it keeps reporting these rules.

Also: I do not want to specify which rules it must check, as newer versions can (and will) include new ones and I do not want to check which new rules will run in every new version.

like image 580
Fernando M. Pinheiro Avatar asked Apr 15 '13 17:04

Fernando M. Pinheiro


People also ask

How do I skip a PMD violation?

Is there any way to skip the PMD or CPD reports temporarily? Yes, each report supports a skip parameter which you can pass on the command line, -Dpmd. skip=true and -Dcpd. skip=true respectively.

What is PMD rule set?

A ruleset is an XML configuration file, which describes a collection of rules to be executed in a PMD run. PMD includes built-in rulesets to run quick analyses with a default configuration, but users are encouraged to make their own rulesets from the start, because they allow for so much configurability.

What is PMD violation?

PMD violations are assigned a priority from 1 (most severe) to 5 (least severe) according the the rule's priority. Violations at or less than this priority level are considered failures and will fail the build if failOnViolation=true and the count exceeds maxAllowedViolations .


1 Answers

I think you will need to add the rulesets you want to check and discard just the specific rule you don't need.

The pmd-exclude.xml should look like this:

<?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>
like image 144
marcelopazzo Avatar answered Oct 04 '22 12:10

marcelopazzo