Add comment before property key
Recipe ID
org.openrewrite.properties.AddPropertyCommentArtifact
org.openrewrite:rewrite-propertiesAdd a new comment before a property key if not already present, optionally commenting out the property.
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:8.88.0Options
| Name | Type | Description |
|---|---|---|
propertyKeyrequired | String | The name of the property to add comment. e.g. management.metrics.binders |
commentrequired | 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