← All recipes
Open source

Change property key

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

Change a property key leaving the value intact.

Single recipeApache 2.0

Usage

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

mod run . --recipe org.openrewrite.properties.ChangePropertyKey --recipe-option "oldPropertyKey=management.metrics.binders.files.enabled" --recipe-option "newPropertyKey=management.metrics.enable.process.files"

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

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

Options

NameTypeDescription
oldPropertyKeyrequiredStringThe property key to rename.
e.g. management.metrics.binders.files.enabled
newPropertyKeyrequiredStringThe new name for the key identified by oldPropertyKey.
e.g. management.metrics.enable.process.files
relaxedBindingBooleanWhether to match the oldPropertyKey using relaxed binding rules. Default is true. Set to false to use exact matching.
regexBooleanDefault false. If enabled, oldPropertyKey will be interpreted as a Regular Expression, and capture group contents will be available in newPropertyKey

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