Comment on page

Change property key

org.openrewrite.properties.ChangePropertyKey
Change a property key leaving the value intact.
Recipe source
​GitHub, Issue Tracker, Maven Central​
groupId: org.openrewrite
artifactId: rewrite-properties
version: 8.9.5
Options
Type
Name
Description
String
oldPropertyKey
The property key to rename.
String
newPropertyKey
The new name for the key identified by oldPropertyKey.
Boolean
relaxedBinding
Optional. Whether to match the oldPropertyKey using relaxed binding rules. Default is true. Set to false to use exact matching.
Boolean
regex
Optional. Default false. If enabled, oldPropertyKey will be interpreted as a Regular Expression, and capture group contents will be available in newPropertyKey
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.ChangePropertyKeyExample. 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.ChangePropertyKeyExample
displayName: Change property key example
recipeList:
  - org.openrewrite.properties.ChangePropertyKey:
      oldPropertyKey: management.metrics.binders.files.enabled
      newPropertyKey: management.metrics.enable.process.files
      relaxedBinding: null
      regex: null
Now that com.yourorg.ChangePropertyKeyExample has been defined activate it in your build file:
Gradle
Maven
Moderne CLI
1.Add the following to your build.gradle file:
build.gradle
plugins {
    id("org.openrewrite.rewrite") version("6.5.6")
}
​
rewrite {
    activeRecipe("com.yourorg.ChangePropertyKeyExample")
}
​
repositories {
    mavenCentral()
}
2.Run gradle rewriteRun to run the recipe.
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.13.0</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.ChangePropertyKeyExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>
2.Run mvn rewrite:run to run the recipe.
You will need to have configured the Moderne CLI on your machine before you can run the following command.
shell
mod run . --recipe ChangePropertyKey
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, Nick McKinney, Jonathan Schnéider, Sam Snyder, Josh Soref

Type	Name	Description
`String`	oldPropertyKey	The property key to rename.
`String`	newPropertyKey	The new name for the key identified by `oldPropertyKey`.
`Boolean`	relaxedBinding	Optional. Whether to match the `oldPropertyKey` using relaxed binding rules. Default is `true`. Set to `false` to use exact matching.
`Boolean`	regex	Optional. Default false. If enabled, `oldPropertyKey` will be interpreted as a Regular Expression, and capture group contents will be available in `newPropertyKey`

Add a new property

Change property value

Last modified 9d ago