Add Gradle dependency
Recipe ID
org.openrewrite.gradle.AddDependencyArtifact
org.openrewrite:rewrite-gradleAdd a gradle dependency to a build.gradle file in the correct configuration based on where it is used.
Usage
You’ll need the Moderne CLI configured before running the command below.
mod run . --recipe org.openrewrite.gradle.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:rewrite-gradle:8.88.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:VERSION' e.g. guava |
version | String | An exact version number or node-style semver selector used to select the version number. You can also use latest.release for the latest available version and latest.patch if the current version is a valid semantic version. For more details, you can look at the documentation page of version selectors.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 |
configuration | String | A configuration 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 new as of yet unused dependency. e.g. implementation |
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 |
extension | String | The extension of the dependency to add. If omitted Gradle defaults to assuming the type is "jar". e.g. jar |
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* |
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.
- Maven metadata failuresAttempts to resolve maven metadata that failed.
org.openrewrite.maven.table.MavenMetadataFailures - 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