Open source

Copy YAML value

Recipe IDorg.openrewrite.yaml.CopyValueArtifactorg.openrewrite:rewrite-yaml

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. By default, attempts to create the new key if it does not exist.

Single recipeApache 2.0

Add to your build

Get a download tokenSign in with GitHub or Google, and your token replaces YOUR_DOWNLOAD_TOKEN below. Free for open source recipes like this one.

~/.gradle/gradle.properties

codeGenomeUsername=you@example.com
codeGenomeToken=YOUR_DOWNLOAD_TOKEN

build.gradle.kts

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

rewrite {
    activeRecipe("org.openrewrite.yaml.CopyValue")
}

repositories {
    mavenCentral()
    maven {
        url = uri("https://artifacts.codegenomeproject.org/maven")
        credentials {
            username = providers.gradleProperty("codeGenomeUsername").get()
            password = providers.gradleProperty("codeGenomeToken").get()
        }
    }
}

dependencies {
    rewrite("org.openrewrite:rewrite-yaml:8.92.8")
}

Then run

./gradlew rewriteRun

This recipe has required options, which a build sets in a rewrite.yml recipe that you activate instead.

Usage

You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.yaml.CopyValue --recipe-option "oldKeyPath=$.source.kind" --recipe-option "newKey=$.dest.kind"

If the recipe isn’t available locally, install it with:

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

Options

Name	Type	Description
`oldKeyPath`required	`String`	A JsonPath expression to locate a YAML key/value pair to copy. e.g. `$.source.kind`
`oldFilePath`	`String`	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. e.g. `src/main/resources/application.yaml`
`newKey`required	`String`	A JsonPath expression defining where the value should be written. e.g. `$.dest.kind`
`newFilePath`	`String`	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. e.g. `src/main/resources/application.yaml`
`createNewKeys`	`Boolean`	When the key path does _not_ match any keys, create new keys on the spot. Default is `true`.

Data tables

Structured output this recipe can produce.

Source files that had resultsSource files that were modified by the recipe run.org.openrewrite.table.SourcesFileResults
Source files that had search resultsSearch results that were found during the recipe run.org.openrewrite.table.SearchResults
Source files that errored on a recipeThe details of all errors produced by a recipe run.org.openrewrite.table.SourcesFileErrors
Recipe performanceStatistics used in analyzing the performance of recipes.org.openrewrite.table.RecipeRunStats