changedependencyconfiguration.md

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

GitHub, Issue Tracker, Maven Central

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

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.

Example

Parameters

Parameter	Value
groupId	org.openrewrite
artifactId	*
newConfiguration	implementation
configuration	``

{% tabs %} {% tab title="build.gradle" %}

Before

{% code title="build.gradle" %}

plugins {
    id 'java-library'
}

repositories {
    mavenCentral()
}

dependencies {
    api 'org.openrewrite:rewrite-gradle:latest.release'
}

{% endcode %}

After

{% code title="build.gradle" %}

plugins {
    id 'java-library'
}

repositories {
    mavenCentral()
}

dependencies {
    implementation 'org.openrewrite:rewrite-gradle:latest.release'
}

{% endcode %}

{% endtab %} {% tab title="Diff" %} {% code %}

--- build.gradle
+++ build.gradle
@@ -10,1 +10,1 @@

dependencies {
-   api 'org.openrewrite:rewrite-gradle:latest.release'
+   implementation 'org.openrewrite:rewrite-gradle:latest.release'
}

{% endcode %} {% endtab %} {% endtabs %}

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:

{% code title="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

{% endcode %}

Now that com.yourorg.ChangeDependencyConfigurationExample has been defined activate it in your build file: {% tabs %} {% tab title="Gradle" %} {% code title="build.gradle" %}

plugins {
    id("org.openrewrite.rewrite") version("6.1.4")
}

rewrite {
    activeRecipe("com.yourorg.ChangeDependencyConfigurationExample")
}

repositories {
    mavenCentral()
}

{% endcode %} {% endtab %}

{% endtabs %}

Contributors

• Shannon Pamperl
• Jonathan Schnéider
• Jonathan Leitschuh

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.