Design Partners
Exclude Maven dependency
** org.openrewrite.maven.ExcludeDependency** Exclude specified dependency from any dependency that transitively includes it.

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. Match dependencies with the specified scope. If you specify compile, this will NOT match dependencies in runtime. The purpose of this is to be able to exclude dependencies that should be in a higher scope, e.g. a compile dependency that should be a test dependency.

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