Change Extra Property

org.openrewrite.gradle.ChangeExtraProperty

Gradle's ExtraPropertiesExtension is a commonly used mechanism for setting arbitrary key/value pairs on a project. This recipe will change the value of a property with the given key name if that key can be found. It assumes that the value being set is a String literal. Does not add the value if it does not already exist.

Recipe source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite

• artifactId: rewrite-gradle

• version: 8.24.0

Options

Type	Name	Description	Example
String	key	The key of the property to change.	foo
String	value	The new value to set. The value will be treated the contents of a string literal.	bar

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.ChangeExtraPropertyExample. 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.ChangeExtraPropertyExample
displayName: Change Extra Property example
recipeList:
  - org.openrewrite.gradle.ChangeExtraProperty:
      key: foo
      value: bar

Now that com.yourorg.ChangeExtraPropertyExample 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.12.0")
}

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

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 ChangeExtraPropertyExample

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

Sam Snyder, Tim te Beek