Comment on page

Change Maven dependency scope

org.openrewrite.maven.ChangeDependencyScope
Add or alter the scope of the specified dependency.
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
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
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.ChangeDependencyScopeExample</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 ChangeDependencyScope
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 Leitschuh, Jonathan Schnéider, Sam Snyder​

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.

Change Maven dependency groupId, artifactId and/or the version

Change Maven managed dependency groupId, artifactId and optionally the version

Last modified 10d ago