Open source

Change TOML table row value

Recipe IDorg.openrewrite.toml.ChangeTableRowValueArtifactorg.openrewrite:rewrite-toml

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

Single recipeApache 2.0

Add to your build

Get a download tokenSign in with GitHub or Google, and your token replaces YOUR_DOWNLOAD_TOKEN below. Free for open source recipes like this one.

~/.gradle/gradle.properties

codeGenomeUsername=you@example.com
codeGenomeToken=YOUR_DOWNLOAD_TOKEN

build.gradle.kts

plugins {
    id("org.openrewrite.rewrite") version("latest.release")
}

rewrite {
    activeRecipe("org.openrewrite.toml.ChangeTableRowValue")
}

repositories {
    mavenCentral()
    maven {
        url = uri("https://artifacts.codegenomeproject.org/maven")
        credentials {
            username = providers.gradleProperty("codeGenomeUsername").get()
            password = providers.gradleProperty("codeGenomeToken").get()
        }
    }
}

dependencies {
    rewrite("org.openrewrite:rewrite-toml:8.92.8")
}

Then run

./gradlew rewriteRun

This recipe has required options, which a build sets in a rewrite.yml recipe that you activate instead.

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:RELEASE

Options

Name	Type	Description
`tableName`required	`String`	The name of the TOML array table containing the row to update. e.g. `package.contributors`
`identifyingKey`required	`String`	The key within a table row to match on. e.g. `name`
`identifyingValue`required	`String`	The value to match. Can be a regular expression if useRegex is true. e.g. `Alice Smith`
`useRegex`	`Boolean`	Whether to interpret the identifying value as a regular expression. Default is false.
`propertyKey`required	`String`	The key of the property to update within the matched row. e.g. `email`
`newValue`	`String`	The 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