Open source

Add Maven dependency

Recipe IDorg.openrewrite.maven.AddDependency

Artifactorg.openrewrite:rewrite-maven

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

Single recipeOpenRewriteApache License Version 2.0

Try in PlatformTry this recipe in the Moderne platform. Not a user yet? You’ll get a no-setup demo environment, with nothing to install or configure.

Options

12 parameters

3 required9 optional

Parameter	Example	Type	Required
artifactId	guava	String	Required
The second part of a dependency coordinate com.google.guava:guava:VERSION.
groupId	com.google.guava	String	Required
The first part of a dependency coordinate com.google.guava:guava:VERSION.
version	29.X	String	Required
An exact version number or node-style semver selector used to select the version number.
acceptTransitive	true	Boolean	Optional
Default false. If enabled, the dependency will not be added if it is already on the classpath as a transitive dependency.
classifier	test	String	Optional
A Maven classifier to add. Most commonly used to select shaded or test variants of a library
familyPattern	com.fasterxml.jackson*	String	Optional
A pattern, applied to groupIds, used to determine which other dependencies should have aligned version numbers. Accepts '*' as a wildcard character.
onlyIfUsing	org.junit.jupiter.api.*	String	Optional
Used to determine if the dependency will be added and in which scope it should be placed. Required for multi-module projects to avoid adding dependencies unnecessarily.
optional	—	Boolean	Optional
Set the value of the <optional> tag. No <optional> tag will be added when this is null.
releasesOnly	—	Boolean	Optional
Whether to exclude snapshots from consideration when using a semver selector
scope	runtime	String	Optional
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 test dependency.
type	jar	String	Optional
The type of dependency to add. If omitted Maven defaults to assuming the type is "jar".
versionPattern	-jre	String	Optional
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

Examples

xml

Parameter	Value
groupId	com.google.guava
artifactId	guava
version	29.0-jre
versionPattern	null
scope	null
releasesOnly	true
onlyIfUsing	null
type	null
classifier	null
optional	null
familyPattern	null
acceptTransitive	null

xml

Before

<project>
    <groupId>com.mycompany.app</groupId>
    <artifactId>my-app</artifactId>
    <version>1</version>
</project>

After

<project>
    <groupId>com.mycompany.app</groupId>
    <artifactId>my-app</artifactId>
    <version>1</version>
    <dependencies>
        <dependency>
            <groupId>com.google.guava</groupId>
            <artifactId>guava</artifactId>
            <version>29.0-jre</version>
        </dependency>
    </dependencies>
</project>

Diff

--- pom.xml
+++ pom.xml
@@ -5,0 +5,7 @@
    <artifactId>my-app</artifactId>
    <version>1</version>
+   <dependencies>
+       <dependency>
+           <groupId>com.google.guava</groupId>
+           <artifactId>guava</artifactId>
+           <version>29.0-jre</version>
+       </dependency>
+   </dependencies>
</project>

xml

Parameter	Value
groupId	com.fasterxml.jackson.module
artifactId	jackson-module-afterburner
version	2.10.5
versionPattern	null
scope	null
releasesOnly	true
onlyIfUsing	null
type	null
classifier	null
optional	false
familyPattern	null
acceptTransitive	null

xml

Before

<project>
    <groupId>com.mycompany.app</groupId>
    <artifactId>my-app</artifactId>
    <version>1</version>
</project>

After

<project>
    <groupId>com.mycompany.app</groupId>
    <artifactId>my-app</artifactId>
    <version>1</version>
    <dependencies>
        <dependency>
            <groupId>com.fasterxml.jackson.module</groupId>
            <artifactId>jackson-module-afterburner</artifactId>
            <version>2.10.5</version>
        </dependency>
        <dependency>
            <groupId>com.google.guava</groupId>
            <artifactId>guava</artifactId>
            <version>29.0-jre</version>
        </dependency>
    </dependencies>
</project>

Diff

--- pom.xml
+++ pom.xml
@@ -5,0 +5,12 @@
    <artifactId>my-app</artifactId>
    <version>1</version>
+   <dependencies>
+       <dependency>
+           <groupId>com.fasterxml.jackson.module</groupId>
+           <artifactId>jackson-module-afterburner</artifactId>
+           <version>2.10.5</version>
+       </dependency>
+       <dependency>
+           <groupId>com.google.guava</groupId>
+           <artifactId>guava</artifactId>
+           <version>29.0-jre</version>
+       </dependency>
+   </dependencies>
</project>

Usage

Run this recipe

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell

mod run . --recipe AddDependency --recipe-option "groupId=com.google.guava" --recipe-option "artifactId=guava" --recipe-option "version=29.X" --recipe-option "versionPattern='-jre'" --recipe-option "scope=runtime" --recipe-option "onlyIfUsing=org.junit.jupiter.api.*" --recipe-option "type=jar" --recipe-option "classifier=test" --recipe-option "familyPattern=com.fasterxml.jackson*" --recipe-option "acceptTransitive=true"

If the recipe is not available locally, then you can install it using:

mod config recipes jar install org.openrewrite:rewrite-maven:8.85.6

Data tables

Maven metadata failures

org.openrewrite.maven.table.MavenMetadataFailures

Attempts to resolve maven metadata that failed.

Column	Description
Group id	The groupId of the artifact for which the metadata download failed.
Artifact id	The artifactId of the artifact for which the metadata download failed.
Version	The version of the artifact for which the metadata download failed.
Maven repository	The URL of the Maven repository that the metadata download failed on.
Snapshots	Does the repository support snapshots.
Releases	Does the repository support releases.
Failure	The reason the metadata download failed.

Source files that had results

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column	Description
Source path before the run	The source path of the file before the run. null when a source file was created during the run.
Source path after the run	A 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 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 had search results

org.openrewrite.table.SearchResults

Search results that were found during the recipe run.

Column	Description
Source path of search result before the run	The source path of the file with the search result markers present.
Source path of search result after run the run	A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Result	The trimmed printed tree of the LST element that the marker is attached to.
Description	The content of the description of the marker.
Recipe that added the search marker	The specific recipe that added the Search marker.

Source files that errored on a recipe

org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

Column	Description
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	Description
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 (ns)	The total time spent across the scanning phase of this recipe.
Max scanning time (ns)	The max time scanning any one source file.
Cumulative edit time (ns)	The total time spent across the editing phase of this recipe.
Max edit time (ns)	The max time editing any one source file.