← All recipes
Open source

Copy JSON value

Recipe IDorg.openrewrite.json.CopyValue
Artifactorg.openrewrite:rewrite-json

Copies a JSON value from one key to another. The existing key/value pair remains unaffected by this change. Attempts to create the new key if it does not exist.

Single recipeApache 2.0

Usage

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

mod run . --recipe org.openrewrite.json.CopyValue --recipe-option "sourceKeyPath=$.source.kind" --recipe-option "destinationKeyPath='$.subjects.*' or '$.' or '$.x[1].y.*' etc." --recipe-option "destinationKey=myKey"

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

mod config recipes jar install org.openrewrite:rewrite-json:8.88.0

Options

NameTypeDescription
sourceKeyPathrequiredStringA JSONPath expression to locate a JSON value to copy.
e.g. $.source.kind
sourceFilePathStringThe file path to the JSON file to copy the value from. If null then the value will be copied from any JSON file it appears within.
e.g. src/main/resources/application.json
destinationKeyPathrequiredStringA JSONPath expression to locate the *parent* JSON entry.
e.g. '$.subjects.*' or '$.' or '$.x[1].y.*' etc.
destinationKeyrequiredStringThe key to create.
e.g. myKey
destinationFilePathStringThe file path to the JSON 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.json

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