Design Partners
Add Maven plugin dependencies
** org.openrewrite.maven.AddPluginDependency** Adds the specified dependencies to a Maven plugin. Will not add the plugin if it does not already exist in the pom.

Source

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

Options

Type
Name
Description
String
pluginGroupId
GroupId of the plugin to which the dependency will be added. A GroupId is the first part of a dependency coordinate 'org.openrewrite.maven:rewrite-maven-plugin:VERSION'.
String
pluginArtifactId
ArtifactId of the plugin to which the dependency will be added.The second part of a dependency coordinate 'org.openrewrite.maven:rewrite-maven-plugin:VERSION'.
String
groupId
The GroupId of the dependency to add.
String
artifactId
The ArtifactId of the dependency to add.
String
version
The Version of the dependency to add.

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.AddPluginDependencyExample. 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.AddPluginDependencyExample
4
displayName: Add Maven plugin dependencies example
5
recipeList:
6
- org.openrewrite.maven.AddPluginDependency:
7
pluginGroupId: org.openrewrite.maven
8
pluginArtifactId: rewrite-maven-plugin
9
groupId: org.openrewrite.recipe
10
artifactId: org.openrewrite.recipe
11
version: org.openrewrite.recipe
Copied!
Now that com.yourorg.AddPluginDependencyExample has been defined activate it in your build file:
Gradle
Maven
build.gradle
1
plugins {
2
id("org.openrewrite.rewrite") version("5.20.0")
3
}
4
5
rewrite {
6
activeRecipe("com.yourorg.AddPluginDependencyExample")
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.23.0</version>
8
<configuration>
9
<activeRecipes>
10
<recipe>com.yourorg.AddPluginDependencyExample</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.activeRecipes=com.yourorg.AddPluginDependencyExample
Export as PDF
Copy link