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

  • groupId: org.openrewrite

  • artifactId: rewrite-maven

  • version: 8.30.0

Options

TypeNameDescriptionExample

String

groupPattern

Optional. 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.*

String

artifactPattern

Optional. 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*

Boolean

onlyIfVersionsMatch

Optional. 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.

Comparator

onlyIfManagedVersionIs

Optional. 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

List

except

Optional. Accepts a list of GAVs. Dependencies matching a GAV will be ignored by this recipe. GAV versions are ignored if provided.

com.jcraft:jsch

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 run

The source path of the file before the run.

Source path after the run

A recipe may modify the source path. This is the path after the run.

Parent of the recipe that made changes

In 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 changes

The specific recipe that made a change.

Estimated time saving

An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.

Cycle

The recipe cycle in which the change was made.

Source files that errored on a recipe

org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

Column NameDescription

Source path

The file that failed to parse.

Recipe that made changes

The specific recipe that made a change.

Stack trace

The stack trace of the failure.

Recipe performance

org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

Column NameDescription

The recipe

The recipe whose stats are being measured both individually and cumulatively.

Source file count

The number of source files the recipe ran over.

Source file changed count

The number of source files which were changed in the recipe run. Includes files created, deleted, and edited.

Cumulative scanning time

The total time spent across the scanning phase of this recipe.

99th percentile scanning time

99 out of 100 scans completed in this amount of time.

Max scanning time

The max time scanning any one source file.

Cumulative edit time

The total time spent across the editing phase of this recipe.

99th percentile edit time

99 out of 100 edits completed in this amount of time.

Max edit time

The max time editing any one source file.

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>5.36.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

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.

Contributors

Nick McKinney, Sam Snyder, Kevin McCarpenter, Adriano Machado, Jonathan Schneider, Tim te Beek, Ryan Hudson, Jonathan Leitschuh

Last updated