Change key
** org.openrewrite.yaml.ChangeKey** Change a YAML mapping entry key leaving the value intact.

Source

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

Options

Type
Name
Description
String
oldKeyPath
A JsonPath expression to locate a YAML entry.
String
newKey
The new name for the key selected by oldKeyPath.
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.ChangeKeyExample. Here's how you can define and customize such a recipe within your rewrite.yml:
rewrite.yml
1
---
2
type: specs.openrewrite.org/v1beta/recipe
3
name: com.yourorg.ChangeKeyExample
4
displayName: Change key example
5
recipeList:
6
- org.openrewrite.yaml.ChangeKey:
7
oldKeyPath: $.subjects.kind
8
newKey: kind
9
fileMatcher: '**/application-*.yml'
Copied!
Now that com.yourorg.ChangeKeyExample has been defined activate it in your build file:
Gradle
Maven
build.gradle
1
plugins {
2
id("org.openrewrite.rewrite") version("5.20.0")
3
}
4
5
rewrite {
6
activeRecipe("com.yourorg.ChangeKeyExample")
7
}
8
9
repositories {
10
mavenCentral()
11
}
Copied!
pom.xml
1
<project>
2
<build>
3
<plugins>
4
<plugin>
5
<groupId>org.openrewrite.maven</groupId>
6
<artifactId>rewrite-maven-plugin</artifactId>
7
<version>4.23.0</version>
8
<configuration>
9
<activeRecipes>
10
<recipe>com.yourorg.ChangeKeyExample</recipe>
11
</activeRecipes>
12
</configuration>
13
</plugin>
14
</plugins>
15
</build>
16
</project>
Copied!
Recipes can also be activated directly from the commandline by adding the argument -Drewrite.activeRecipes=com.yourorg.ChangeKeyExample
Export as PDF
Copy link