copyvalue.md

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. If either the source or destination key path does not exist, no value will be copied. Furthermore, copies are limited to scalar values, not whole YAML blocks.

Source

GitHub, Issue Tracker, Maven Central

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

Options

Type	Name	Description
String	oldKeyPath	A JsonPath expression to locate a YAML key/value pair to copy.
String	newKey	A JsonPath expression for where the new value should be copied to.

Example

Parameters

Parameter	Value
oldKeyPath	.source
newKey	.destination

{% tabs %} {% tab title="yaml" %}

Before

{% code %}

id: something
source:   password
destination: whatever

{% endcode %}

After

{% code %}

id: something
source:   password
destination:   password

{% endcode %}

{% endtab %} {% tab title="Diff" %} {% code %}

@@ -3,1 +3,1 @@
id: something
source:   password
-destination: whatever
+destination:   password

{% endcode %} {% endtab %} {% endtabs %}

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:

{% code title="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
      newKey: $.dest.kind

{% endcode %}

Now that com.yourorg.CopyValueExample has been defined activate it in your build file: {% tabs %} {% tab title="Gradle" %} {% code title="build.gradle" %}

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

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

repositories {
    mavenCentral()
}

{% endcode %} {% endtab %} {% tab title="Maven" %} {% code title="pom.xml" %}

<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>5.2.4</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.CopyValueExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

{% endcode %} {% endtab %} {% endtabs %}

Contributors

• Jonathan Schneider
• Aaron Gershman

See how this recipe works across multiple open-source repositories

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.