Rules to detect constructs that are either broken, extremely confusing or prone to runtime errors.
Edit me

InvalidDependencyTypes

Since: PMD 5.4

Priority: Medium (3)

If you use an invalid dependency type in the dependency management section, Maven doesn’t fail. Instead, the entry is just ignored, which might have the effect, that the wrong version of the dependency is used.

The following types are considered valid: pom, jar, maven-plugin, ejb, war, ear, rar, par.

This rule is defined by the following XPath expression:

//dependencyManagement/dependency/type/text[not(@Image = $validTypes)]

Example(s):

<project...>
  ...
  <dependencyManagement>
      ...
    <dependency>
      <groupId>org.jboss.arquillian</groupId>
      <artifactId>arquillian-bom</artifactId>
      <version>${arquillian.version}</version>
      <type>bom</type> <!-- not a valid type ! 'pom' is ! -->
      <scope>import</scope>
    </dependency>
    ...
  </dependencyManagement>
</project>

This rule has the following properties:

Name Default Value Description Multivalued
validTypes pom , jar , maven-plugin , ejb , war , ear , rar , par Set of valid types. yes. Delimiter is ‘,’.

Use this rule with the default properties by just referencing it:

<rule ref="category/pom/errorprone.xml/InvalidDependencyTypes" />

Use this rule and customize it:

<rule ref="category/pom/errorprone.xml/InvalidDependencyTypes">
    <properties>
        <property name="validTypes" value="pom,jar,maven-plugin,ejb,war,ear,rar,par" />
    </properties>
</rule>

ProjectVersionAsDependencyVersion

Since: PMD 5.4

Priority: Medium (3)

Using that expression in dependency declarations seems like a shortcut, but it can go wrong. By far the most common problem is the use of ${project.version} in a BOM or parent POM.

This rule is defined by the following XPath expression:

//dependencies/dependency
    [contains(version/text/@Image,'{project.version}')]
    [
        (/document/project/parent/groupId and groupId/text/@Image != /document/project/parent/groupId/text/@Image)
        or
        (/document/project/groupId and groupId/text/@Image != /document/project/groupId/text/@Image)
    ]/version

Example(s):

<project...>
  ...
  <dependency>
    ...
    <version>7.0.0-SNAPSHOT</version>
  </dependency>
</project>

Use this rule by referencing it:

<rule ref="category/pom/errorprone.xml/ProjectVersionAsDependencyVersion" />