Skip to main content

Add Maven dependency

org.openrewrite.maven.AddDependency

Add a Maven dependency to a pom.xml file in the correct scope based on where it is used.

Recipe source

GitHub, Issue Tracker, Maven Central

Options

TypeNameDescriptionExample
StringgroupIdThe first part of a dependency coordinate com.google.guava:guava:VERSION.com.google.guava
StringartifactIdThe second part of a dependency coordinate com.google.guava:guava:VERSION.guava
StringversionAn exact version number or node-style semver selector used to select the version number.29.X
StringversionPatternOptional. Allows version selection to be extended beyond the original Node Semver semantics. So for example,Setting 'version' to "25-29" can be paired with a metadata pattern of "-jre" to select Guava 29.0-jre-jre
StringscopeOptional. A scope to use when it is not what can be inferred from usage. Most of the time this will be left empty, but is used when adding a runtime, provided, or import dependency. Valid options: import, runtime, providedruntime
BooleanreleasesOnlyOptional. Whether to exclude snapshots from consideration when using a semver selector
StringonlyIfUsingOptional. Used to determine if the dependency will be added and in which scope it should be placed.org.junit.jupiter.api.*
StringtypeOptional. The type of dependency to add. If omitted Maven defaults to assuming the type is "jar". Valid options: jar, pom, warjar
StringclassifierOptional. A Maven classifier to add. Most commonly used to select shaded or test variants of a librarytest
BooleanoptionalOptional. Set the value of the <optional> tag. No <optional> tag will be added when this is null.
StringfamilyPatternOptional. A pattern, applied to groupIds, used to determine which other dependencies should have aligned version numbers. Accepts '*' as a wildcard character.com.fasterxml.jackson*
BooleanacceptTransitiveOptional. Default false. If enabled, the dependency will not be added if it is already on the classpath as a transitive dependency.true

Usage

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly. To activate this recipe you must create a new recipe which fills in the required parameters. In your rewrite.yml create a new recipe with a unique name. For example: com.yourorg.AddDependencyExample. Here's how you can define and customize such a recipe within your rewrite.yml:

rewrite.yml
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.AddDependencyExample
displayName: Add Maven dependency example
recipeList:
- org.openrewrite.maven.AddDependency:
groupId: com.google.guava
artifactId: guava
version: 29.X
versionPattern: '-jre'
scope: runtime
onlyIfUsing: org.junit.jupiter.api.*
type: jar
classifier: test
familyPattern: com.fasterxml.jackson*
acceptTransitive: true

Now that com.yourorg.AddDependencyExample has been defined, activate it in your build file:

  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.46.1</version>
<configuration>
<exportDatatables>true</exportDatatables>
<activeRecipes>
<recipe>com.yourorg.AddDependencyExample</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

Maven metadata failures

org.openrewrite.maven.table.MavenMetadataFailures

Attempts to resolve maven metadata that failed.

Column NameDescription
Group idThe groupId of the artifact for which the metadata download failed.
Artifact idThe artifactId of the artifact for which the metadata download failed.
VersionThe version of the artifact for which the metadata download failed.
Maven repositoryThe URL of the Maven repository that the metadata download failed on.
SnapshotsDoes the repository support snapshots.
ReleasesDoes the repository support releases.
FailureThe reason the metadata download failed.

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.

Source files that errored on a recipe

org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

Column NameDescription
Source pathThe file that failed to parse.
Recipe that made changesThe specific recipe that made a change.
Stack traceThe stack trace of the failure.

Recipe performance

org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

Column NameDescription
The recipeThe recipe whose stats are being measured both individually and cumulatively.
Source file countThe number of source files the recipe ran over.
Source file changed countThe number of source files which were changed in the recipe run. Includes files created, deleted, and edited.
Cumulative scanning timeThe total time spent across the scanning phase of this recipe.
99th percentile scanning time99 out of 100 scans completed in this amount of time.
Max scanning timeThe max time scanning any one source file.
Cumulative edit timeThe total time spent across the editing phase of this recipe.
99th percentile edit time99 out of 100 edits completed in this amount of time.
Max edit timeThe max time editing any one source file.