Links

Copy YAML value

org.openrewrite.yaml.CopyValue
Copies a YAML value from one key to another. The existing key/value pair remains unaffected by this change. Attempts to merge the copied value into the new key if it already exists. Attempts to create the new key if it does not exist.

Recipe source

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

Options

Type
Name
Description
Example
String
oldKeyPath
A JsonPath expression to locate a YAML key/value pair to copy.
$.source.kind
String
oldFilePath
Optional. The file path to the YAML file to copy the value from. If null then the value will be copied from any yaml file it appears within.
src/main/resources/application.yaml
String
newKey
A JsonPath expression defining where the value should be written.
$.dest.kind
String
newFilePath
Optional. The file path to the YAML file to copy the value to. If null then the value will be copied only into the same file it was found in.
src/main/resources/application.yaml

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.CopyValueExample. 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.CopyValueExample
displayName: Copy YAML value example
recipeList:
- org.openrewrite.yaml.CopyValue:
oldKeyPath: $.source.kind
oldFilePath: src/main/resources/application.yaml
newKey: $.dest.kind
newFilePath: src/main/resources/application.yaml
Now that com.yourorg.CopyValueExample has been defined activate it in your build file:
Gradle
Maven
Moderne CLI
  1. 1.
    Add the following to your build.gradle file:
build.gradle
plugins {
id("org.openrewrite.rewrite") version("6.8.4")
}
rewrite {
activeRecipe("com.yourorg.CopyValueExample")
}
repositories {
mavenCentral()
}
  1. 2.
    Run gradle rewriteRun to run the recipe.
  1. 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>5.23.1</version>
<configuration>
<activeRecipes>
<recipe>com.yourorg.CopyValueExample</recipe>
</activeRecipes>
</configuration>
</plugin>
</plugins>
</build>
</project>
  1. 2.
    Run mvn rewrite:run to run the recipe.
You will need to have configured the Moderne CLI on your machine before you can run the following command.
shell
mod run . --recipe CopyValueExample

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.