← All recipes
Open source

Delete key

Recipe IDorg.openrewrite.yaml.DeleteKey
Artifactorg.openrewrite:rewrite-yaml

Delete a YAML mapping entry key.

Single recipeApache 2.0

Usage

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

mod run . --recipe org.openrewrite.yaml.DeleteKey --recipe-option "keyPath=$.source.kind"

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

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

Options

NameTypeDescription
keyPathrequiredStringA JsonPath expression to locate a YAML entry.
e.g. $.source.kind
filePatternStringA glob expression representing a file path to search for (relative to the project root). Blank/null matches all.
e.g. .github/workflows/*.yml

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