Add Maven dependency
org.openrewrite.maven.AddDependency Add a maven dependency to a
pom.xml file in the correct scope based on where it is used.- groupId: org.openrewrite
- artifactId: rewrite-maven
- version: 7.38.0
Type | Name | Description |
|---|---|---|
String | groupId | The first part of a dependency coordinate 'com.google.guava:guava:VERSION'. |
String | artifactId | The second part of a dependency coordinate 'com.google.guava:guava:VERSION'. |
String | version | An exact version number or node-style semver selector used to select the version number. |
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 |
String | scope | 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 import dependency. |
Boolean | releasesOnly | Optional. Whether to exclude snapshots from consideration when using a semver selector |
String | onlyIfUsing | Used to determine if the dependency will be added and in which scope it should be placed. |
String | type | Optional. The type of dependency to add. If omitted Maven defaults to assuming the type is "jar". |
String | classifier | Optional. A Maven classifier to add. Most commonly used to select shaded or test variants of a library |
Boolean | optional | Optional. Set the value of the <optional> tag. No <optional> tag will be added when this is null. |
String | familyPattern | Optional. A pattern, applied to groupIds, used to determine which other dependencies should have aligned version numbers. Accepts '*' as a wildcard character. |
Boolean | acceptTransitive | Optional. Default false. If enabled, the dependency will not be added if it is already on the classpath as a transitive dependency. |
This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly. 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:rewrite.yml
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.AddDependencyExample
displayName: Add Maven dependency example
recipeList:
- org.openrewrite.maven.AddDependency:
groupId: com.google.guava
artifactId: guava
version: 29.X
versionPattern: '-jre'
scope: runtime
releasesOnly: null
onlyIfUsing: org.junit.jupiter.api.*
type: jar
classifier: test
optional: null
familyPattern: com.fasterxml.jackson*
acceptTransitive: true
Now that
com.yourorg.AddDependencyExample has been defined activate it in your build file:Gradle
Maven
build.gradle
plugins {
id("org.openrewrite.rewrite") version("5.38.0")
}
rewrite {
activeRecipe("com.yourorg.AddDependencyExample")
}
repositories {
mavenCentral()
}
pom.xml
<project>
<build>
<plugins>
<plugin>
<groupId>org.openrewrite.maven</groupId>
<artifactId>rewrite-maven-plugin</artifactId>
<version>4.42.0</version>
<configuration>
<activeRecipes>
<recipe>com.yourorg.AddDependencyExample</recipe>
</activeRecipes>
</configuration>
</plugin>
</plugins>
</build>
</project>
The Moderne public SaaS instance 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.
Last modified 5d ago