← All recipes
Open source

Delete TOML table row

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

Delete a TOML table row when one of its values 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.DeleteTableRow --recipe-option "tableName=package.contributors" --recipe-option "identifyingKey=name" --recipe-option "identifyingValue=example-*"

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 to delete (e.g., 'package.contributors').
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. example-*
useRegexBooleanWhether to interpret the value as a regular expression. Default is false.

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