Open source

Add comment before property key

Recipe IDorg.openrewrite.properties.AddPropertyCommentArtifactorg.openrewrite:rewrite-properties

Add a new comment before a property key if not already present, optionally commenting out the property.

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.properties.AddPropertyComment")
}

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-properties: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.properties.AddPropertyComment --recipe-option "propertyKey=management.metrics.binders" --recipe-option "comment=comment"

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

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

Options

Name	Type	Description
`propertyKey`required	`String`	The name of the property to add comment. e.g. `management.metrics.binders`
`comment`required	`String`	The comment to be added. e.g. `comment`
`commentOutProperty`	`Boolean`	If true, property will be commented out. e.g. `true`

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