Add comment to a YAML property
Recipe ID
org.openrewrite.yaml.AddCommentToPropertyArtifact
org.openrewrite:rewrite-yamlAdd a comment to a YAML property. The comment will be added on the line before the property.
Usage
You’ll need the Moderne CLI configured before running the command below.
mod run . --recipe org.openrewrite.yaml.AddCommentToProperty --recipe-option "propertyKey=management.metrics.binders.*.enabled" --recipe-option "comment=This property is deprecated"If the recipe isn’t available locally, install it with:
mod config recipes jar install org.openrewrite:rewrite-yaml:8.88.0Options
| Name | Type | Description |
|---|---|---|
propertyKeyrequired | String | The property key to add a comment to. Supports glob patterns. e.g. management.metrics.binders.*.enabled |
commentrequired | String | The comment to add to the property. e.g. This property is deprecated |
relaxedBinding | Boolean | Whether to match the propertyKey using relaxed binding rules. Defaults to true. If you want to use exact matching in your search, set this to false. |
filePattern | String | A glob expression representing a file path to search for (relative to the project root). Blank/null matches all. e.g. .github/workflows/*.yml |
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