Remove Maven dependency

org.openrewrite.maven.RemoveDependency

Removes a single dependency from the section of the pom.xml.

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.

com.google.guava

String

artifactId

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

guava

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 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.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 Maven dependency example
recipeList:
  - org.openrewrite.maven.RemoveDependency:
      groupId: com.google.guava
      artifactId: guava
      scope: compile

Now that com.yourorg.RemoveDependencyExample 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.RemoveDependencyExample</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, Greg Adams, Sam Snyder, Patrick Way, Tyler Van Gorder, Jonathan Leitschuh, Tim te Beek

Last updated