Change property key

Github Join us on Slack Join us on Discord
Search…
Change property key
** org.openrewrite.properties.ChangePropertyKey** Change a property key leaving the value intact.
Source
​Github, Issue Tracker, Maven Central​
groupId: org.openrewrite
artifactId: rewrite-properties
version: 7.30.0
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.
String
fileMatcher
Optional. Matching files will be modified. This is a glob expression.
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
      fileMatcher: '**/application-*.properties'
Now that com.yourorg.ChangePropertyKeyExample has been defined activate it in your build file:
Gradle
Maven
build.gradle
plugins {
    id("org.openrewrite.rewrite") version("5.29.0")
}
​
rewrite {
    activeRecipe("com.yourorg.ChangePropertyKeyExample")
}
​
repositories {
    mavenCentral()
}
pom.xml
<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>4.34.0</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.ChangePropertyKeyExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>
Recipes can also be activated directly from the commandline by adding the argument -Drewrite.activeRecipes=com.yourorg.ChangePropertyKeyExample
Add a new property
Change property value
Last modified 9d ago
Export as PDF
Copy link
On this page
Source
Options
Usage