Open source

Comment on deprecated properties

Recipe IDio.quarkus.updates.quarkiverse.cxf.CommentDeprecatedPropertiesArtifactorg.openrewrite.recipe:rewrite-third-party

Adds the configured warning comment at the top of every properties file that contains a key matching the configured pattern. The configuration itself is never changed and a file already carrying the comment is left alone.

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("io.quarkus.updates.quarkiverse.cxf.CommentDeprecatedProperties")
}

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.recipe:rewrite-third-party:0.48.0")
}

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 io.quarkus.updates.quarkiverse.cxf.CommentDeprecatedProperties --recipe-option "keyPattern=(%[^.]+\.)?quarkus\.cxf\.client\.[^.]+\.proxy-server" --recipe-option "comment=Deprecation warning: ..."

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

mod config recipes jar install org.openrewrite.recipe:rewrite-third-party:RELEASE

Options

Name	Type	Description
`keyPattern`required	`String`	A regular expression; a properties file containing a key that fully matches it gets the comment. e.g. `(%[^.]+\.)?quarkus\.cxf\.client\.[^.]+\.proxy-server`
`comment`required	`String`	The warning text added as a single comment line at the top of every affected file, without the leading `#`. e.g. `Deprecation warning: ...`

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