Skip to main content

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

This recipe is available under the Apache License Version 2.0.

Options​

TypeNameDescriptionExample
StringpropertyKeyThe key to be commented out.applicability.singleSource
StringcommentTextThe comment text to be added before the specified key.The foo property is deprecated, please migrate
BooleancommentOutPropertyOptional. If false, property wouldn't be commented out, only comment will be added. By default, set to truetrue

Examples​

Example 1​

comment out a map entry

Parameters​
ParameterValue
propertyKeyfoo.bar.sequence.propertyA
commentTextSome comments
commentOutPropertynull
Before​
  foo:
    bar:
      sequence:
        - name: name
        - propertyA: fieldA
        - propertyB: fieldB
      scalar: value
After​
  foo:
    bar:
      sequence:
        - name: name
        # Some comments
        # propertyA: fieldA
        - propertyB: fieldB
      scalar: value
Example 2​

comment out entire sequence

Parameters​
ParameterValue
propertyKeyfoo.bar.sequence
commentTextSome comments
commentOutPropertynull
Before​
foo:
  bar:
    sequence:
      - name: name
      - propertyA: fieldA
      - propertyB: fieldB
    scalar: value
After​
foo:
  bar:
    # Some comments
    # sequence:
    #   - name: name
    #   - propertyA: fieldA
    #   - propertyB: fieldB
    scalar: value
Example 3​

comment out a map entry

Parameters​
ParameterValue
propertyKeyfoo.bar.sequence.propertyA
commentTextSome comments
commentOutPropertyfalse
Before​
  foo:
    bar:
      sequence:
        - name: name
        - propertyA: fieldA
        - propertyB: fieldB
      scalar: value
After​
  foo:
    bar:
      sequence:
        - name: name
        # Some comments
        - propertyA: fieldA
        - propertyB: fieldB
      scalar: value
Example 4​

comment out a map entry

Parameters​
ParameterValue
propertyKeyfoo.bar.sequence.name
commentTextSome comments
commentOutPropertyfalse
Before​
  foo:
    bar:
      sequence:
        - name: name
        - propertyA: fieldA
        - propertyB: fieldB
      scalar: value
After​
  foo:
    bar:
      sequence:
        # Some comments
        - name: name
        - propertyA: fieldA
        - propertyB: fieldB
      scalar: value
Example 5​

comment out entire sequence

Parameters​
ParameterValue
propertyKeyfoo.bar.sequence
commentTextSome comments
commentOutPropertyfalse
Before​
foo:
  bar:
    sequence:
      - name: name
      - propertyA: fieldA
      - propertyB: fieldB
    scalar: value
After​
foo:
  bar:
    # Some comments
    sequence:
      - name: name
      - propertyA: fieldA
      - propertyB: fieldB
    scalar: value

Usage​

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly (unless you are running them via the Moderne CLI). 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
      commentOutProperty: true

Now that com.yourorg.CommentOutPropertyExample has been defined, activate it in your build file:

  1. Add the following to your build.gradle file:
build.gradle
plugins {
    id("org.openrewrite.rewrite") version("7.7.0")
}

rewrite {
    activeRecipe("com.yourorg.CommentOutPropertyExample")
    setExportDatatables(true)
}

repositories {
    mavenCentral()
}
  1. Run gradle rewriteRun to run the recipe.

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

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.

Data Tables​

Source files that had results​

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column NameDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changesIn a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.

Contributors​

Kun Li, ashakirin, Valentin Delaye, Jonathan Schnéider, Sam Snyder, Tim te Beek