Links

Change Maven dependency scope

org.openrewrite.maven.ChangeDependencyScope
Add or alter the scope of the specified dependency.

Source

  • groupId: org.openrewrite
  • artifactId: rewrite-maven
  • version: 8.6.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
newScope
Optional. Scope to apply to specified Maven dependency. May be omitted, which indicates that no scope should be added and any existing scope be removed from the 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.ChangeDependencyScopeExample. 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.ChangeDependencyScopeExample
displayName: Change Maven dependency scope example
recipeList:
- org.openrewrite.maven.ChangeDependencyScope:
groupId: com.google.guava
artifactId: guava
newScope: compile
Now that com.yourorg.ChangeDependencyScopeExample has been defined activate it in your build file:
Maven
  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.5.2</version>
<configuration>
<activeRecipes>
<recipe>com.yourorg.ChangeDependencyScopeExample</recipe>
</activeRecipes>
</configuration>
</plugin>
</plugins>
</build>
</project>
  1. 2.
    Run mvn rewrite:run to run the recipe.

Contributors

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.