Skip to main content

Remove redundant explicit dependency and plugin versions

org.openrewrite.maven.RemoveRedundantDependencyVersions

Remove explicitly-specified dependency/plugin versions when a parent POM's dependencyManagement/pluginManagement specifies the version.

Recipe source​

GitHub, Issue Tracker, Maven Central

This recipe is available under the Apache License Version 2.0.

Options​

TypeNameDescriptionExample
StringgroupPatternOptional. Group glob expression pattern used to match dependencies that should be managed.Group is the first part of a dependency coordinate com.google.guava:guava:VERSION.com.google.*
StringartifactPatternOptional. Artifact glob expression pattern used to match dependencies that should be managed.Artifact is the second part of a dependency coordinate com.google.guava:guava:VERSION.guava*
BooleanonlyIfVersionsMatchOptional. Deprecated; use onlyIfManagedVersionIs instead. Only remove the explicit version if it exactly matches the managed dependency version. When false explicit versions will be removed if they are older than or equal to the managed dependency version. Default true.
ComparatoronlyIfManagedVersionIsOptional. Only remove the explicit version if the managed version has the specified comparative relationship to the explicit version. For example, gte will only remove the explicit version if the managed version is the same or newer. Default eq. Valid options: ANY, EQ, LT, LTE, GT, GTE
ListexceptOptional. Accepts a list of GAVs. Dependencies matching a GAV will be ignored by this recipe. GAV versions are ignored if provided.com.jcraft:jsch

Example​

Parameters​
ParameterValue
groupPatternnull
artifactPatternnull
onlyIfVersionsMatch(RemoveRedundantDependencyVersions.Comparator) null
onlyIfManagedVersionIsnull
except
Before​
pom.xml
<project>
    <groupId>org.example</groupId>
    <artifactId>parent</artifactId>
    <version>1.0-SNAPSHOT</version>
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>com.google.guava</groupId>
                <artifactId>guava</artifactId>
                <version>30.0-jre</version>
            </dependency>
        </dependencies>
    </dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>com.google.guava</groupId>
            <artifactId>guava</artifactId>
            <version>30.0-jre</version>
        </dependency>
    </dependencies>
</project>
After​
pom.xml
<project>
    <groupId>org.example</groupId>
    <artifactId>parent</artifactId>
    <version>1.0-SNAPSHOT</version>
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>com.google.guava</groupId>
                <artifactId>guava</artifactId>
                <version>30.0-jre</version>
            </dependency>
        </dependencies>
    </dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>com.google.guava</groupId>
            <artifactId>guava</artifactId>
        </dependency>
    </dependencies>
</project>

Usage​

This recipe has no required configuration parameters and comes from a rewrite core library. It can be activated directly without adding any dependencies.

  1. Add the following to your pom.xml file:
pom.xml
<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>6.8.0</version>
        <configuration>
          <exportDatatables>true</exportDatatables>
          <activeRecipes>
            <recipe>org.openrewrite.maven.RemoveRedundantDependencyVersions</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>
  1. Run mvn rewrite:run to run the recipe.

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.

Data Tables​

Source files that had results​

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column NameDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changesIn a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.

Contributors​

Nick McKinney, Sam Snyder, DidierLoiseau, Kevin McCarpenter, Jonathan Schneider, Adriano Machado, Tim te Beek, Ryan Hudson, Niels de Bruin, rob-valor, Jonathan Leitschuh, Kyle Scully