Design Partners
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: 7.22.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
1
---
2
type: specs.openrewrite.org/v1beta/recipe
3
name: com.yourorg.ChangeDependencyScopeExample
4
displayName: Change Maven dependency scope example
5
recipeList:
6
- org.openrewrite.maven.ChangeDependencyScope:
7
groupId: com.google.guava
8
artifactId: guava
9
newScope: compile
Copied!
Now that com.yourorg.ChangeDependencyScopeExample has been defined activate it in your build file:
Gradle
Maven
build.gradle
1
plugins {
2
id("org.openrewrite.rewrite") version("5.20.0")
3
}
4
5
rewrite {
6
activeRecipe("com.yourorg.ChangeDependencyScopeExample")
7
}
8
9
repositories {
10
mavenCentral()
11
}
Copied!
pom.xml
1
<project>
2
<build>
3
<plugins>
4
<plugin>
5
<groupId>org.openrewrite.maven</groupId>
6
<artifactId>rewrite-maven-plugin</artifactId>
7
<version>4.23.0</version>
8
<configuration>
9
<activeRecipes>
10
<recipe>com.yourorg.ChangeDependencyScopeExample</recipe>
11
</activeRecipes>
12
</configuration>
13
</plugin>
14
</plugins>
15
</build>
16
</project>
Copied!
Recipes can also be activated directly from the commandline by adding the argument -Drewrite.activeRecipes=com.yourorg.ChangeDependencyScopeExample
Export as PDF
Copy link