Add Maven dependency
Recipe ID
org.openrewrite.maven.AddDependencyArtifact
org.openrewrite:rewrite-mavenAdd 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.maven.AddDependency --recipe-option "groupId=com.google.guava" --recipe-option "artifactId=guava" --recipe-option "version=29.X"If the recipe isn’t available locally, install it with:
mod config recipes jar install org.openrewrite:rewrite-maven: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 |
versionrequired | 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 |
scope | String | 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. e.g. runtime |
releasesOnly | Boolean | Whether to exclude snapshots from consideration when using a semver selector |
onlyIfUsing | String | 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. e.g. org.junit.jupiter.api.* |
type | String | The type of dependency to add. If omitted Maven defaults to assuming the type is "jar". e.g. jar |
classifier | String | A Maven classifier to add. Most commonly used to select shaded or test variants of a library e.g. test |
optional | Boolean | Set the value of the <optional> tag. No <optional> tag will be added when this is null. |
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