Comment out property
Recipe ID
org.openrewrite.yaml.CommentOutPropertyArtifact
org.openrewrite:rewrite-yamlComment out a YAML property and add a comment in front.
Usage
You’ll need the Moderne CLI configured before running the command below.
mod run . --recipe org.openrewrite.yaml.CommentOutProperty --recipe-option "propertyKey=applicability.singleSource" --recipe-option "commentText=The `foo` property is deprecated, please migrate"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 key to be commented out. e.g. applicability.singleSource |
commentTextrequired | String | The comment text to be added before the specified key. e.g. The `foo` property is deprecated, please migrate |
commentOutProperty | Boolean | If false, property wouldn't be commented out, only comment will be added. By default, set to true 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