Open source

Change property key

Recipe IDorg.openrewrite.yaml.ChangePropertyKey

Artifactorg.openrewrite:rewrite-yaml

Change a YAML property key while leaving the value intact. Expects dot notation for nested YAML mappings, similar to how Spring Boot interprets application.yml files.

Single recipeYAMLApache License Version 2.0

Try in PlatformTry this recipe in the Moderne platform. Not a user yet? You’ll get a no-setup demo environment, with nothing to install or configure.

Options

5 parameters

2 required3 optional

Parameter	Example	Type	Required
newPropertyKey	management.metrics.enable.process.files	String	Required
The new name for the property key.
oldPropertyKey	management.metrics.binders.*.enabled	String	Required
The property key to rename. Supports glob patterns.
except	List.of("group")	List	Optional
If any of these property keys exist as direct children of oldPropertyKey, then they will not be moved to newPropertyKey.
filePattern	.github/workflows/*.yml	String	Optional
A glob expression representing a file path to search for (relative to the project root). Blank/null matches all.
relaxedBinding	—	Boolean	Optional
Whether to match the oldPropertyKey using [relaxed binding](https://docs.spring.io/spring-boot/docs/2.5.6/reference/html/features.html#features.external-config.typesafe-configuration-properties.relaxed-binding) rules. Defaults to true. If you want to use exact matching in your search, set this to false.

Examples

yaml

Parameter	Value
oldPropertyKey	a.b.c.d
newPropertyKey	a.b.c
relaxedBinding	null
except	null
filePattern	null

yaml

Before

a.b.c.d: true

After

a.b.c: true

Diff

@@ -1,1 +1,1 @@
-a.b.c.d: true
+a.b.c: true

yaml

Parameter	Value
oldPropertyKey	management.metrics.binders.*.enabled
newPropertyKey	management.metrics.enable.process.files
relaxedBinding	null
except	null
filePattern	null

yaml

Before

management.metrics.binders.files.enabled: true

After

management.metrics.enable.process.files: true

Diff

@@ -1,1 +1,1 @@
-management.metrics.binders.files.enabled: true
+management.metrics.enable.process.files: true

yaml

Parameter	Value
oldPropertyKey	spring.profiles
newPropertyKey	spring.config.activate.on-profile
relaxedBinding	null
except	List.of("group", "active", "include")
filePattern	null

yaml

Before

spring:
  profiles:
    active: allEnvs
    include: baseProfile
    foo: bar
    group:
      prod: proddb,prodmq,prodmetrics

After

spring:
  profiles:
    active: allEnvs
    include: baseProfile
    group:
      prod: proddb,prodmq,prodmetrics
  config.activate.on-profile:
    foo: bar

Diff

@@ -5,1 +5,0 @@
    active: allEnvs
    include: baseProfile
-   foo: bar
    group:
@@ -8,0 +7,2 @@
    group:
      prod: proddb,prodmq,prodmetrics
+ config.activate.on-profile:
+   foo: bar

yaml

Parameter	Value
oldPropertyKey	spring.profiles
newPropertyKey	spring.config.activate.on-profile
relaxedBinding	null
except	null
filePattern	null

yaml

Before

spring.profiles.group.prod: proddb,prodmq,prodmetrics

After

spring.config.activate.on-profile.group.prod: proddb,prodmq,prodmetrics

Diff

@@ -1,1 +1,1 @@
-spring.profiles.group.prod: proddb,prodmq,prodmetrics
+spring.config.activate.on-profile.group.prod: proddb,prodmq,prodmetrics

Usage

Run this 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 --recipe-option "oldPropertyKey=management.metrics.binders.*.enabled" --recipe-option "newPropertyKey=management.metrics.enable.process.files" --recipe-option "except=List.of("group")" --recipe-option "filePattern=.github/workflows/*.yml"

If the recipe is not available locally, then you can install it using:

mod config recipes jar install org.openrewrite:rewrite-yaml:8.85.6

Data tables

Source files that had results

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column	Description
Source path before the run	The source path of the file before the run. null when a source file was created during the run.
Source path after the run	A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changes	In a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changes	The specific recipe that made a change.
Estimated time saving	An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
Cycle	The recipe cycle in which the change was made.

Source files that had search results

org.openrewrite.table.SearchResults

Search results that were found during the recipe run.

Column	Description
Source path of search result before the run	The source path of the file with the search result markers present.
Source path of search result after run the run	A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Result	The trimmed printed tree of the LST element that the marker is attached to.
Description	The content of the description of the marker.
Recipe that added the search marker	The specific recipe that added the Search marker.

Source files that errored on a recipe

org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

Column	Description
Source path	The file that failed to parse.
Recipe that made changes	The specific recipe that made a change.
Stack trace	The stack trace of the failure.

Recipe performance

org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

Column	Description
The recipe	The recipe whose stats are being measured both individually and cumulatively.
Source file count	The number of source files the recipe ran over.
Source file changed count	The number of source files which were changed in the recipe run. Includes files created, deleted, and edited.
Cumulative scanning time (ns)	The total time spent across the scanning phase of this recipe.
Max scanning time (ns)	The max time scanning any one source file.
Cumulative edit time (ns)	The total time spent across the editing phase of this recipe.
Max edit time (ns)	The max time editing any one source file.