Links

Exclude Maven dependency

org.openrewrite.maven.ExcludeDependency
Exclude specified dependency from any dependency that transitively includes it.

Recipe source

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

Options

Type
Name
Description
Example
String
groupId
The first part of a dependency coordinate com.google.guava:guava:VERSION.
com.google.guava
String
artifactId
The second part of a dependency coordinate com.google.guava:guava:VERSION.
guava
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. Valid options: compile, test, runtime, provided
compile

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
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.ExcludeDependencyExample
displayName: Exclude Maven dependency example
recipeList:
- org.openrewrite.maven.ExcludeDependency:
groupId: com.google.guava
artifactId: guava
scope: compile
Now that com.yourorg.ExcludeDependencyExample 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.ExcludeDependencyExample</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 ExcludeDependencyExample

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