Links

Remove Maven plugin dependency

org.openrewrite.maven.RemovePluginDependency
Removes a dependency from the section of a plugin in the pom.xml.

Recipe source

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

Options

Type
Name
Description
Example
String
pluginGroupId
Group ID of the plugin from which the dependency will be removed. Supports glob.A Group ID is the first part of a dependency coordinate 'org.openrewrite.maven:rewrite-maven-plugin:VERSION'.
org.openrewrite.maven
String
pluginArtifactId
Artifact ID of the plugin from which the dependency will be removed. Supports glob.The second part of a dependency coordinate 'org.openrewrite.maven:rewrite-maven-plugin:VERSION'.
rewrite-maven-plugin
String
groupId
The first part of a plugin dependency coordinate. Supports glob.
com.google.guava
String
artifactId
The second part of a plugin dependency coordinate. Supports glob.
guava

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.RemovePluginDependencyExample. 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.RemovePluginDependencyExample
displayName: Remove Maven plugin dependency example
recipeList:
- org.openrewrite.maven.RemovePluginDependency:
pluginGroupId: org.openrewrite.maven
pluginArtifactId: rewrite-maven-plugin
groupId: com.google.guava
artifactId: guava
Now that com.yourorg.RemovePluginDependencyExample has been defined activate it in your build file:
Maven
Moderne CLI
  1. 1.
    Add the following to your pom.xml file:
pom.xml
<project>
<build>
<plugins>
<plugin>
<groupId>org.openrewrite.maven</groupId>
<artifactId>rewrite-maven-plugin</artifactId>
<version>5.23.1</version>
<configuration>
<activeRecipes>
<recipe>com.yourorg.RemovePluginDependencyExample</recipe>
</activeRecipes>
</configuration>
</plugin>
</plugins>
</build>
</project>
  1. 2.
    Run mvn rewrite:run to run the recipe.
You will need to have configured the Moderne CLI on your machine before you can run the following command.
shell
mod run . --recipe RemovePluginDependencyExample

See how this recipe works across multiple open-source repositories

Moderne Link Image
The community edition of the Moderne platform 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.

Contributors