Links

Change a Gradle dependency configuration

org.openrewrite.gradle.ChangeDependencyConfiguration
A common example is the need to change compile to api/implementation as part of the move to Gradle 7.x and later.

Source

  • groupId: org.openrewrite
  • artifactId: rewrite-gradle
  • version: 7.40.6

Contributors

Options

Type
Name
Description
String
groupId
The first part of a dependency coordinate com.google.guava:guava:VERSION. This can be a glob expression.
String
artifactId
The second part of a dependency coordinate com.google.guava:guava:VERSION. This can be a glob expression.
String
newConfiguration
A dependency configuration container.
String
configuration
Optional. The dependency configuration to search for dependencies in.

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.ChangeDependencyConfigurationExample. 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.ChangeDependencyConfigurationExample
displayName: Change a Gradle dependency configuration example
recipeList:
- org.openrewrite.gradle.ChangeDependencyConfiguration:
groupId: com.fasterxml.jackson*
artifactId: jackson-module*
newConfiguration: api
configuration: api
Now that com.yourorg.ChangeDependencyConfigurationExample has been defined activate it in your build file:
Gradle
build.gradle
plugins {
id("org.openrewrite.rewrite") version("5.40.4")
}
rewrite {
activeRecipe("com.yourorg.ChangeDependencyConfigurationExample")
}
repositories {
mavenCentral()
}

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.