Add Gradle or Maven dependency
org.openrewrite.java.dependencies.AddDependency
For a Gradle project, add a gradle dependency to a build.gradle
file in the correct configuration based on where it is used. Or For a maven project, 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
This recipe is available under the Apache License Version 2.0.
Options
Type | Name | Description | Example |
---|---|---|---|
String | groupId | The first part of a dependency coordinate com.google.guava:guava:VERSION . | com.google.guava |
String | artifactId | The second part of a dependency coordinate com.google.guava:guava:VERSION | guava |
String | version | Optional. An exact version number or node-style semver selector used to select the version number. | 29.X |
String | versionPattern | 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 | -jre |
String | onlyIfUsing | Optional. Used to determine if the dependency will be added and in which scope it should be placed. | org.junit.jupiter.api.* |
String | classifier | Optional. A classifier to add. Commonly used to select variants of a library. | test |
String | familyPattern | Optional. A pattern, applied to groupIds, used to determine which other dependencies should have aligned version numbers. Accepts '*' as a wildcard character. | com.fasterxml.jackson* |
String | extension | Optional. For Gradle only, The extension of the dependency to add. If omitted Gradle defaults to assuming the type is "jar". | jar |
String | configuration | Optional. The Gradle dependency configuration name within which to place the dependency. When omitted the configuration will be determined by the Maven scope parameter. If that parameter is also omitted, configuration will be determined based on where types matching onlyIfUsing appear in source code. | implementation |
String | scope | Optional. The Maven scope within which to place the dependency. When omitted scope will be determined based on where types matching onlyIfUsing appear in source code. Valid options: compile , provided , runtime , test | runtime |
Boolean | releasesOnly | Optional. For Maven only, Whether to exclude snapshots from consideration when using a semver selector | |
String | type | Optional. For Maven only, The type of dependency to add. If omitted Maven defaults to assuming the type is "jar". Valid options: jar , pom , war | jar |
Boolean | optional | Optional. Set the value of the <optional> tag. No <optional> tag will be added when this is null . | |
Boolean | acceptTransitive | Optional. Default false. If enabled, the dependency will not be added if it is already on the classpath as a transitive dependency. | true |
Used by
This recipe is used as part of the following composite recipes:
- Add AWS SDK for Java v2 S3 Event Notification dependency if needed
- Add AWS SDK for Java v2 S3 Transfer Manager dependency if needed
- Add Hibernate ORM Core if has dependencies
- Add Jakarta EE 9 Servlet Dependency
- Add Quarkus 2 dependencies
- Add
javax.validation-api
dependency - Add
org.hamcrest:hamcrest
if it is used. - Add explicit Common Annotations dependencies
- Add explicit Inject dependencies
- Add explicit JAX-WS dependencies
- Add explicit JAXB API dependencies
- Add missing Flyway module for MySQL
- Add missing Flyway module for Oracle
- Add missing Flyway module for PostgreSQL
- Add missing Flyway module for SQL Server
- Change v1 Maven/Gradle dependencies to v2
- Cucumber to JUnit test
@Suite
- JUnit Jupiter migration from JUnit 4.x
- Migrate Hamcrest assertions to AssertJ
- Migrate Hibernate dependencies to 6.0.x
- Migrate JUnit asserts to AssertJ
- Migrate Johnzon from javax to jakarta namespace
- Migrate Log4j 1.x to Log4j 2.x
- Migrate Log4j 2.x to Logback
- Migrate Log4j to SLF4J
- Migrate Spring Boot 2.x projects to JUnit 5 from JUnit 4
- Migrate Spring Cloud Sleuth 3.1 to Micrometer Tracing 1.0
- Migrate TestNG assertions to AssertJ
- Migrate dependencies from Jackson Codehaus (legacy) to FasterXML
- Migrate deprecated
javax.mail
packages tojakarta.mail
- Migrate deprecated
javax.ws
packages tojakarta.ws
- Migrate deprecated
javax.xml.ws
packages tojakarta.xml.ws
- Migrate from EasyMock to Mockito
- Migrate from JMockit to Mockito
- Migrate from Jakarta annotation API to JSpecify
- Migrate from JetBrains annotations to JSpecify
- Migrate from OpenRewrite annotations to JSpecify
- Migrate from Spring Framework annotations to JSpecify
- Migrate from httpcore-nio to ApacheHttpClient 5.x core dependency
- Migrate from javax annotation API to JSpecify
- Migrate from org.apache.httpcomponents to ApacheHttpClient 5.x dependencies
- Migrate to Spring Boot 2.3
- Migrate to Spring Boot 2.4
- Migrate to Spring Boot 3.2
- Migrate to Spring Data 2.3
- Migrate to Wicket 10.x
- Prefer the Java standard library instead of Joda-Time
- Rename the package name from
com.nimbusds.jose.shaded.json
tonet.minidev.json
- Replace SpringFox Dependencies
- Replace
micrometer-spring-legacy
withspring-boot-starter-actuator
- Update the Micronaut Retry support
- Update the Micronaut Websocket support
- Update to Micronaut Validation 4.x
- Use Mockito JUnit Jupiter extension
- Use Vert.x JUnit 5 Extension
- Use
org.springframework.boot.web.server.LocalServerPort
Usage
This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly (unless you are running them via the Moderne CLI). 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:
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.AddDependencyExample
displayName: Add Gradle or Maven dependency example
recipeList:
- org.openrewrite.java.dependencies.AddDependency:
groupId: com.google.guava
artifactId: guava
version: 29.X
versionPattern: '-jre'
onlyIfUsing: org.junit.jupiter.api.*
classifier: test
familyPattern: com.fasterxml.jackson*
extension: jar
configuration: implementation
scope: runtime
type: jar
acceptTransitive: true
Now that com.yourorg.AddDependencyExample
has been defined, activate it and take a dependency on org.openrewrite.recipe:rewrite-java-dependencies:1.39.0
in your build file:
- Gradle
- Maven
- Moderne CLI
- Add the following to your
build.gradle
file:
plugins {
id("org.openrewrite.rewrite") version("latest.release")
}
rewrite {
activeRecipe("com.yourorg.AddDependencyExample")
setExportDatatables(true)
}
repositories {
mavenCentral()
}
dependencies {
rewrite("org.openrewrite.recipe:rewrite-java-dependencies:1.39.0")
}
- Run
gradle rewriteRun
to run the recipe.
- Add the following to your
pom.xml
file:
<project>
<build>
<plugins>
<plugin>
<groupId>org.openrewrite.maven</groupId>
<artifactId>rewrite-maven-plugin</artifactId>
<version>6.15.0</version>
<configuration>
<exportDatatables>true</exportDatatables>
<activeRecipes>
<recipe>com.yourorg.AddDependencyExample</recipe>
</activeRecipes>
</configuration>
<dependencies>
<dependency>
<groupId>org.openrewrite.recipe</groupId>
<artifactId>rewrite-java-dependencies</artifactId>
<version>1.39.0</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
</project>
- Run
mvn rewrite:run
to run the recipe.
You will need to have configured the Moderne CLI on your machine before you can run the following command.
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 "onlyIfUsing=org.junit.jupiter.api.*" --recipe-option "classifier=test" --recipe-option "familyPattern=com.fasterxml.jackson*" --recipe-option "extension=jar" --recipe-option "configuration=implementation" --recipe-option "scope=runtime" --recipe-option "type=jar" --recipe-option "acceptTransitive=true"
If the recipe is not available locally, then you can install it using:
mod config recipes jar install org.openrewrite.recipe:rewrite-java-dependencies:1.39.0
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
- SourcesFileResults
- SourcesFileErrors
- RecipeRunStats
Source files that had results
org.openrewrite.table.SourcesFileResults
Source files that were modified by the recipe run.
Column Name | 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 errored on a recipe
org.openrewrite.table.SourcesFileErrors
The details of all errors produced by a recipe run.
Column Name | 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 Name | 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. |
99th percentile scanning time (ns) | 99 out of 100 scans completed in this amount of time. |
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. |
99th percentile edit time (ns) | 99 out of 100 edits completed in this amount of time. |
Max edit time (ns) | The max time editing any one source file. |