Links

Change property key

org.openrewrite.yaml.ChangePropertyKey
Change a YAML property key leaving the value intact. Nested YAML mappings are interpreted as dot separated property names, i.e. as Spring Boot interprets application.yml files.

Source

  • groupId: org.openrewrite
  • artifactId: rewrite-yaml
  • version: 7.40.6

Contributors

Options

Type
Name
Description
String
oldPropertyKey
The property key to rename. Supports glob
String
newPropertyKey
The new name for the property key.
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.
List
except
Optional. If any of these property keys exist as direct children of oldPropertyKey, then they will not be moved to 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.yaml.ChangePropertyKey:
oldPropertyKey: management.metrics.binders.*.enabled
newPropertyKey: management.metrics.enable.process.files
relaxedBinding: null
fileMatcher: '**/application-*.yml'
except: null
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.40.4")
}
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.45.0</version>
<configuration>
<activeRecipes>
<recipe>com.yourorg.ChangePropertyKeyExample</recipe>
</activeRecipes>
</configuration>
</plugin>
</plugins>
</build>
</project>

See how this recipe works across multiple open-source repositories

Moderne Link Image
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.