Design Partners
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.

Source

  • groupId: org.openrewrite
  • artifactId: rewrite-maven
  • version: 7.24.0

Options

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.

Usage

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
1
---
2
type: specs.openrewrite.org/v1beta/recipe
3
name: com.yourorg.AddDependencyExample
4
displayName: Add Maven dependency example
5
recipeList:
6
- org.openrewrite.maven.AddDependency:
7
groupId: com.google.guava
8
artifactId: guava
9
version: 29.X
10
versionPattern: '-jre'
11
scope: runtime
12
releasesOnly: true
13
onlyIfUsing: org.junit.jupiter.api.*
14
type: jar
15
classifier: test
16
optional: true
17
familyPattern: com.fasterxml.jackson*
Copied!
Now that com.yourorg.AddDependencyExample has been defined activate it in your build file:
Gradle
Maven
build.gradle
1
plugins {
2
id("org.openrewrite.rewrite") version("5.22.2")
3
}
4
5
rewrite {
6
activeRecipe("com.yourorg.AddDependencyExample")
7
}
8
9
repositories {
10
mavenCentral()
11
}
Copied!
pom.xml
1
<project>
2
<build>
3
<plugins>
4
<plugin>
5
<groupId>org.openrewrite.maven</groupId>
6
<artifactId>rewrite-maven-plugin</artifactId>
7
<version>4.25.0</version>
8
<configuration>
9
<activeRecipes>
10
<recipe>com.yourorg.AddDependencyExample</recipe>
11
</activeRecipes>
12
</configuration>
13
</plugin>
14
</plugins>
15
</build>
16
</project>
Copied!
Recipes can also be activated directly from the commandline by adding the argument -Drewrite.activeRecipescom.yourorg.AddDependencyExample
Export as PDF
Copy link