Change a Gradle dependency extension

org.openrewrite.gradle.ChangeDependencyExtension

Finds dependencies declared in build.gradle files.

Recipe source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite

• artifactId: rewrite-gradle

• version: 8.23.1

Options

Type	Name	Description	Example
String	groupId	The first part of a dependency coordinate com.google.guava:guava:VERSION. This can be a glob expression.	com.fasterxml.jackson*
String	artifactId	The second part of a dependency coordinate com.google.guava:guava:VERSION. This can be a glob expression.	jackson-module*
String	newExtension	An artifact extension.	jar
String	configuration	Optional. The dependency configuration to search for dependencies in.	api

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.ChangeDependencyExtensionExample. 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.ChangeDependencyExtensionExample
displayName: Change a Gradle dependency extension example
recipeList:
  - org.openrewrite.gradle.ChangeDependencyExtension:
      groupId: com.fasterxml.jackson*
      artifactId: jackson-module*
      newExtension: jar
      configuration: api

Now that com.yourorg.ChangeDependencyExtensionExample has been defined activate it in your build file:

Gradle

1. Add the following to your build.gradle file:

build.gradle

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

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

repositories {
    mavenCentral()
}

2. Run gradle rewriteRun to run the recipe.

Moderne CLI

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell

mod run . --recipe ChangeDependencyExtensionExample

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

Shannon Pamperl, Jonathan Schnéider, Tim te Beek, Sam Snyder, Jonathan Leitschuh