Skip to main content

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​

GitHub, Issue Tracker, Maven Central

This recipe is available under the Apache License Version 2.0.

Options​

TypeNameDescriptionExample
StringoldKeyPathA JsonPath expression to locate a YAML key/value pair to copy.$.source.kind
StringoldFilePathOptional. 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
StringnewKeyA JsonPath expression defining where the value should be written.$.dest.kind
StringnewFilePathOptional. 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

Example​

Parameters​
ParameterValue
oldKeyPath$.source
oldFilePathnull
newKey$.destination
newFilePathnull
Before​
source: value
destination: original
After​
source: value
destination: value

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

  1. Add the following to your build.gradle file:
build.gradle
plugins {
    id("org.openrewrite.rewrite") version("7.5.0")
}

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

repositories {
    mavenCentral()
}
  1. Run gradle rewriteRun to run the recipe.

See how this recipe works across multiple open-source repositories​

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

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​

Source files that had results​

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column NameDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA 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 changesIn 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 changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.