Comment on page

Comment out property

org.openrewrite.yaml.CommentOutProperty
Comment out a YAML property and add a comment in front.
Recipe source
​GitHub, Issue Tracker, Maven Central​
groupId: org.openrewrite
artifactId: rewrite-yaml
version: 8.9.5
Options
Type
Name
Description
String
propertyKey
The key to be commented out.
String
commentText
The comment text to be added before the specified key.
Usage
This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly. To activate this recipe you must create a new recipe which fills in the required parameters. In your rewrite.yml create a new recipe with a unique name. For example: com.yourorg.CommentOutPropertyExample. Here's how you can define and customize such a recipe within your rewrite.yml:
rewrite.yml
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.CommentOutPropertyExample
displayName: Comment out property example
recipeList:
  - org.openrewrite.yaml.CommentOutProperty:
      propertyKey: applicability.singleSource
      commentText: The `foo` property is deprecated, please migrate
Now that com.yourorg.CommentOutPropertyExample has been defined activate it in your build file:
Gradle
Maven
Moderne CLI
1.Add the following to your build.gradle file:
build.gradle
plugins {
    id("org.openrewrite.rewrite") version("6.5.6")
}
​
rewrite {
    activeRecipe("com.yourorg.CommentOutPropertyExample")
}
​
repositories {
    mavenCentral()
}
2.Run gradle rewriteRun to run the recipe.
1.Add the following to your pom.xml file:
pom.xml
<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>5.13.0</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.CommentOutPropertyExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>
2.Run mvn rewrite:run to run the recipe.
You will need to have configured the Moderne CLI on your machine before you can run the following command.
shell
mod run . --recipe CommentOutProperty
See how this recipe works across multiple open-source repositories
​​
​​
The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.
Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.
Contributors
​Kun Li, Mike Solomon​

Type	Name	Description
`String`	propertyKey	The key to be commented out.
`String`	commentText	The comment text to be added before the specified key.

Coalesce YAML properties

Copy YAML value

Last modified 12d ago