Add Gradle or Maven dependency
Recipe ID
org.openrewrite.java.dependencies.AddDependencyArtifact
org.openrewrite.recipe:rewrite-java-dependenciesFor 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.
Usage
You’ll need the Moderne CLI configured before running the command below.
mod run . --recipe org.openrewrite.java.dependencies.AddDependency --recipe-option "groupId=com.google.guava" --recipe-option "artifactId=guava"If the recipe isn’t available locally, install it with:
mod config recipes jar install org.openrewrite.recipe:rewrite-java-dependencies:1.60.0Options
| Name | Type | Description |
|---|---|---|
groupIdrequired | String | The first part of a dependency coordinate com.google.guava:guava:VERSION.e.g. com.google.guava |
artifactIdrequired | String | The second part of a dependency coordinate com.google.guava:guava:VERSIONe.g. guava |
version | String | An exact version number or node-style semver selector used to select the version number. e.g. 29.X |
versionPattern | String | 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 e.g. -jre |
onlyIfUsing | String | Used to determine if the dependency will be added and in which scope it should be placed. e.g. org.junit.jupiter.api.* |
classifier | String | A classifier to add. Commonly used to select variants of a library. e.g. test |
familyPattern | String | A pattern, applied to groupIds, used to determine which other dependencies should have aligned version numbers. Accepts '*' as a wildcard character. e.g. com.fasterxml.jackson* |
extension | String | For Gradle only, The extension of the dependency to add. If omitted Gradle defaults to assuming the type is "jar". e.g. jar |
configuration | String | 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.e.g. implementation |
scope | String | 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.e.g. runtime |
releasesOnly | Boolean | For Maven only, Whether to exclude snapshots from consideration when using a semver selector |
type | String | For Maven only, The type of dependency to add. If omitted Maven defaults to assuming the type is "jar". e.g. jar |
optional | Boolean | Set the value of the <optional> tag. No <optional> tag will be added when this is null. |
acceptTransitive | Boolean | Default false. If enabled, the dependency will not be added if it is already on the classpath as a transitive dependency. e.g. true |
Data tables
Structured output this recipe can produce.
- Source files that had resultsSource files that were modified by the recipe run.
org.openrewrite.table.SourcesFileResults - Source files that had search resultsSearch results that were found during the recipe run.
org.openrewrite.table.SearchResults - Source files that errored on a recipeThe details of all errors produced by a recipe run.
org.openrewrite.table.SourcesFileErrors - Recipe performanceStatistics used in analyzing the performance of recipes.
org.openrewrite.table.RecipeRunStats