Comment on page

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.9.5
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. 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
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:
Maven
Moderne CLI
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.13.0</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.RemoveDependencyExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>
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 RemoveDependency
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, Tyler Van Gorder, Patrick Way, Jonathan Leitschuh​

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. 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

Order POM elements

Remove Maven managed dependency

Last modified 12d ago