Links

Change property key

org.openrewrite.properties.ChangePropertyKey Change a property key leaving the value intact.

Source

  • groupId: org.openrewrite
  • artifactId: rewrite-properties
  • version: 7.35.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.
Boolean
regex
Optional. Default false. If enabled, oldPropertyKey will be interepreted 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
fileMatcher: '**/application-*.properties'
regex: true
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.34.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.39.0</version>
<configuration>
<activeRecipes>
<recipe>com.yourorg.ChangePropertyKeyExample</recipe>
</activeRecipes>
</configuration>
</plugin>
</plugins>
</build>
</project>
Recipes can also be activated directly from the command line by adding the argument -Drewrite.activeRecipes=com.yourorg.ChangePropertyKeyExample

See how this recipe works across multiple open-source repositories

Moderne Link Image
The Moderne public SaaS instance 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.