Change property key

org.openrewrite.yaml.ChangePropertyKey

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.

Recipe source

GitHub, Issue Tracker, Maven Central

This recipe is available under the Apache License Version 2.0.

Options

Type	Name	Description	Example
String	oldPropertyKey	The property key to rename. Supports glob patterns.	management.metrics.binders.*.enabled
String	newPropertyKey	The new name for the property key.	management.metrics.enable.process.files
Boolean	relaxedBinding	Optional. Whether to match the oldPropertyKey using relaxed binding rules. Defaults to true. If you want to use exact matching in your search, set this to false.
List	except	Optional. If any of these property keys exist as direct children of oldPropertyKey, then they will not be moved to newPropertyKey.	List.of("group")
String	filePattern	Optional. A glob expression representing a file path to search for (relative to the project root). Blank/null matches all.	.github/workflows/*.yml

Examples

Example 1

Parameters

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

---

Example 2

Parameters

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

---

Example 3

Parameters

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

---

Example 4

Parameters

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

Usage

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly (unless you are running them via the Moderne CLI). 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
      except: List.of("group")
      filePattern: .github/workflows/*.yml

Now that com.yourorg.ChangePropertyKeyExample has been defined, activate it in your build file:

Gradle

1. Add the following to your build.gradle file:

build.gradle

plugins {
    id("org.openrewrite.rewrite") version("7.7.0")
}

rewrite {
    activeRecipe("com.yourorg.ChangePropertyKeyExample")
    setExportDatatables(true)
}

repositories {
    mavenCentral()
}

2. Run gradle rewriteRun to run the recipe.

Maven

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>6.10.0</version>
        <configuration>
          <exportDatatables>true</exportDatatables>
          <activeRecipes>
            <recipe>com.yourorg.ChangePropertyKeyExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

2. Run mvn rewrite:run to run the recipe.

Moderne CLI

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.54.0

See how this recipe works across multiple open-source repositories

Run this recipe on OSS repos at scale with the Moderne SaaS.

Run this recipe here

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.

Data Tables

SourcesFileResults

Source files that had results

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column Name	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.

SourcesFileErrors

Source files that errored on a recipe

org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

Column Name	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.

RecipeRunStats

Recipe performance

org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

Column Name	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.
99th percentile scanning time (ns)	99 out of 100 scans completed in this amount of time.
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.
99th percentile edit time (ns)	99 out of 100 edits completed in this amount of time.
Max edit time (ns)	The max time editing any one source file.

Contributors

Nick McKinney, Jonathan Leitschuh, Patrick, Sam Snyder, Tim te Beek, Jonathan Schnéider, Tracey Yoshima, Mike Solomon, Sandeep Nagaraj, Thomas Zub, Greg Oledzki, Jacob van Lingen