Design Partners
Remove Maven dependency
** org.openrewrite.maven.RemoveDependency** Removes a single dependency from the section of the pom.xml.

Source

  • groupId: org.openrewrite
  • artifactId: rewrite-maven
  • version: 7.22.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
scope
Optional. Only remove dependencies if they are in this scope. If 'runtime', this willalso remove dependencies in the 'compile' scope because 'compile' dependencies are part of the runtime dependency set

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.RemoveDependencyExample. 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.RemoveDependencyExample
4
displayName: Remove Maven dependency example
5
recipeList:
6
- org.openrewrite.maven.RemoveDependency:
7
groupId: com.google.guava
8
artifactId: guava
9
scope: compile
Copied!
Now that com.yourorg.RemoveDependencyExample 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.RemoveDependencyExample")
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.RemoveDependencyExample</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.RemoveDependencyExample
Export as PDF
Copy link