← All recipes
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

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

NameTypeDescription
keyPatternrequiredStringA regular expression; a properties file containing a key that fully matches it gets the comment.
e.g. (%[^.]+\.)?quarkus\.cxf\.client\.[^.]+\.proxy-server
commentrequiredStringThe 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