Remove exclusion

org.openrewrite.maven.RemoveExclusion

Remove any matching exclusion from any matching dependency.

Recipe source

GitHub, Issue Tracker, Maven Central

  • groupId: org.openrewrite

  • artifactId: rewrite-maven

  • version: 8.21.0

Options

TypeNameDescriptionExample

String

groupId

The first part of a dependency coordinate com.google.guava:guava:VERSION. Supports glob.

com.google.guava

String

artifactId

The second part of a dependency coordinate com.google.guava:guava:VERSION. Supports glob.

guava

String

exclusionGroupId

The first part of a dependency coordinate com.google.guava:guava:VERSION. Supports glob.

com.google.guava

String

exclusionArtifactId

The second part of a dependency coordinate com.google.guava:guava:VERSION. Supports glob.

guava

Boolean

onlyIneffective

Optional. Default false. If enabled, matching exclusions will only be removed if they are ineffective (if the excluded dependency was not actually a transitive dependency of the target 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.RemoveExclusionExample. 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.RemoveExclusionExample
displayName: Remove exclusion example
recipeList:
  - org.openrewrite.maven.RemoveExclusion:
      groupId: com.google.guava
      artifactId: guava
      exclusionGroupId: com.google.guava
      exclusionArtifactId: guava

Now that com.yourorg.RemoveExclusionExample has been defined activate it in your build file:

  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.25.0</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.RemoveExclusionExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>
  1. Run mvn rewrite:run to run the recipe.

See how this recipe works across multiple open-source repositories

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

Jonathan Schneider, Nick McKinney, Knut Wannheden, Patrick, Tim te Beek, Guillaume Smet

Last updated