← All recipes
Open source

Delete property by key

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

Deletes key/value pairs from properties files, as well as any comments that immediately precede the key/value pair. Comments separated by two or more newlines from the deleted key/value pair are preserved.

Single recipeApache 2.0

Usage

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

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

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

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

Options

NameTypeDescription
propertyKeyrequiredStringThe key(s) to be deleted. This is a glob expression.
e.g. management.metrics.binders.files.enabled or management.metrics.*
relaxedBindingBooleanWhether to match the propertyKey using relaxed binding rules. Default is true. Set to false to use exact matching.

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