← All recipes
Open source

Delete property

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

Delete a YAML property. Nested YAML mappings are interpreted as dot separated property names, i.e. as Spring Boot interprets application.yml files like a.b.c.d or a.b.c:d.

Single recipeApache 2.0

Usage

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

mod run . --recipe org.openrewrite.yaml.DeleteProperty --recipe-option "propertyKey=management.metrics.binders.files.*"

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

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

Options

NameTypeDescription
propertyKeyrequiredStringThe key to be deleted. Supports glob patterns.
e.g. management.metrics.binders.files.*
coalesceBoolean(Deprecated: in a future version, this recipe will always use the false behavior) Simplify nested map hierarchies into their simplest dot separated property form.
relaxedBindingBooleanWhether to match the propertyKey using relaxed binding rules. Defaults to true. If you want to use exact matching in your search, set this to false.
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