← All recipes
Open source

Change TOML table row value

Recipe IDorg.openrewrite.toml.ChangeTableRowValue
Artifactorg.openrewrite:rewrite-toml

Change a value in a TOML table row when the identifying property matches the specified matcher.

Single recipeApache 2.0

Usage

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

mod run . --recipe org.openrewrite.toml.ChangeTableRowValue --recipe-option "tableName=package.contributors" --recipe-option "identifyingKey=name" --recipe-option "identifyingValue=Alice Smith" --recipe-option "propertyKey=email"

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

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

Options

NameTypeDescription
tableNamerequiredStringThe name of the TOML array table containing the row to update.
e.g. package.contributors
identifyingKeyrequiredStringThe key within a table row to match on.
e.g. name
identifyingValuerequiredStringThe value to match. Can be a regular expression if useRegex is true.
e.g. Alice Smith
useRegexBooleanWhether to interpret the identifying value as a regular expression. Default is false.
propertyKeyrequiredStringThe key of the property to update within the matched row.
e.g. email
newValueStringThe new value to set for the property. If null, the property will be removed.
e.g. "alice.new@example.com"

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