Comment on page
Remove a Gradle or Maven dependency
org.openrewrite.java.dependencies.RemoveDependency
For Gradle project, removes a single dependency from the dependencies section of the
build.gradle. For Maven project, removes a single dependency from the section of the pom.xml.- groupId: org.openrewrite.recipe
- artifactId: rewrite-java-dependencies
- version: 1.2.0
This recipe is composed of more than one recipe. If you want to customize the set of recipes this is composed of, you can find and copy the GitHub source for the recipe from the link above.
Type | Name | Description |
|---|---|---|
String | groupId | The first part of a dependency coordinate com.google.guava:guava:VERSION. This can be a glob expression. |
String | artifactId | The second part of a dependency coordinate com.google.guava:guava:VERSION. This can be a glob expression. |
String | configuration | Optional. The dependency configuration to remove from. |
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 |
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
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.RemoveDependencyExample
displayName: Remove a Gradle or Maven dependency example
recipeList:
- org.openrewrite.java.dependencies.RemoveDependency:
groupId: com.fasterxml.jackson*
artifactId: jackson-module*
configuration: api
scope: compile
Now that
com.yourorg.RemoveDependencyExample has been defined activate it and take a dependency on org.openrewrite.recipe:rewrite-java-dependencies:1.2.0 in your build file:Gradle
Maven
Moderne CLI
- 1.Add the following to your
build.gradlefile:
build.gradle
plugins {
id("org.openrewrite.rewrite") version("6.5.6")
}
rewrite {
activeRecipe("com.yourorg.RemoveDependencyExample")
}
repositories {
mavenCentral()
}
dependencies {
rewrite("org.openrewrite.recipe:rewrite-java-dependencies:1.2.0")
}
- 2.Run
gradle rewriteRunto run the recipe.
- 1.Add the following to your
pom.xmlfile:
pom.xml
<project>
<build>
<plugins>
<plugin>
<groupId>org.openrewrite.maven</groupId>
<artifactId>rewrite-maven-plugin</artifactId>
<version>5.13.0</version>
<configuration>
<activeRecipes>
<recipe>com.yourorg.RemoveDependencyExample</recipe>
</activeRecipes>
</configuration>
<dependencies>
<dependency>
<groupId>org.openrewrite.recipe</groupId>
<artifactId>rewrite-java-dependencies</artifactId>
<version>1.2.0</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
</project>
- 2.Run
mvn rewrite:runto 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 RemoveDependency
Recipe List
Yaml Recipe List
---
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.dependencies.RemoveDependency
displayName: Remove a Gradle or Maven dependency
description: For Gradle project, removes a single dependency from the dependencies section of the `build.gradle`.
For Maven project, removes a single dependency from the <dependencies> section of the pom.xml.
recipeList:
- org.openrewrite.gradle.RemoveDependency:
- org.openrewrite.maven.RemoveDependency:
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.