Comment out Spring properties
Recipe ID
org.openrewrite.java.spring.CommentOutSpringPropertyKeyArtifact
org.openrewrite.recipe:rewrite-springAdd comment to specified Spring properties, and optionally comment out the property.
Usage
You’ll need the Moderne CLI configured before running the command below.
mod run . --recipe org.openrewrite.java.spring.CommentOutSpringPropertyKey --recipe-option "propertyKey=management.metrics.binders.files.enabled" --recipe-option "comment=This property is deprecated and no longer applicable starting from Spring Boot 3.0.x"If the recipe isn’t available locally, install it with:
mod config recipes jar install org.openrewrite.recipe:rewrite-spring:6.36.0Options
| Name | Type | Description |
|---|---|---|
propertyKeyrequired | String | The name of the property key to comment out. e.g. management.metrics.binders.files.enabled |
commentrequired | String | Comment to replace the property key. e.g. This property is deprecated and no longer applicable starting from Spring Boot 3.0.x |
commentOutProperty | Boolean | If false the property is kept and only the comment is added. Defaults to 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