Change property value

org.openrewrite.properties.ChangePropertyValue

Change a property value leaving the key intact.

Recipe source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite

• artifactId: rewrite-properties

• version: 8.24.0

Options

Type	Name	Description	Example
String	propertyKey	The name of the property key whose value is to be changed. Supports glob patterns.	management.metrics.binders.*.enabled
String	newValue	The new value to be used for key specified by propertyKey.
String	oldValue	Optional. Only change the property value if it matches the configured oldValue.
Boolean	regex	Optional. Default false. If enabled, oldValue will be interpreted as a Regular Expression, to replace only all parts that match the regex. Capturing group can be used in newValue.
Boolean	relaxedBinding	Optional. Whether to match the propertyKey using relaxed binding rules. Default is true. Set to false to use exact matching.

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.ChangePropertyValueExample. 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.ChangePropertyValueExample
displayName: Change property value example
recipeList:
  - org.openrewrite.properties.ChangePropertyValue:
      propertyKey: management.metrics.binders.*.enabled
      newValue: null

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

repositories {
    mavenCentral()
}

2. Run gradle rewriteRun to run the recipe.

Maven

1. Add the following to your pom.xml file:

pom.xml

<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>5.29.0</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.ChangePropertyValueExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

2. Run mvn rewrite:run 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 ChangePropertyValueExample

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

Jonathan Leitschuh, Jenson3210, Nick McKinney, Jonathan Schneider, Tim te Beek