Comment on page

Coalesce YAML properties

org.openrewrite.yaml.CoalesceProperties
Simplify nested map hierarchies into their simplest dot separated property form, similar to how Spring Boot interprets application.yml files.
Recipe source
​GitHub, Issue Tracker, Maven Central​
groupId: org.openrewrite
artifactId: rewrite-yaml
version: 8.9.5
Usage
This recipe has no required configuration parameters and comes from a rewrite core library. It can be activated directly without adding any dependencies.
Gradle
Gradle init script
Maven POM
Maven Command Line
Moderne CLI
1.Add the following to your build.gradle file:
build.gradle
plugins {
    id("org.openrewrite.rewrite") version("6.5.6")
}
​
rewrite {
    activeRecipe("org.openrewrite.yaml.CoalesceProperties")
}
​
repositories {
    mavenCentral()
}
​
2.Run gradle rewriteRun to run the recipe.
1.Create a file named init.gradle in the root of your project.
init.gradle
initscript {
    repositories {
        maven { url "https://plugins.gradle.org/m2" }
    }
    dependencies { classpath("org.openrewrite:plugin:latest.release") }
}
rootProject {
    plugins.apply(org.openrewrite.gradle.RewritePlugin)
    dependencies {
        rewrite("org.openrewrite:rewrite-java")
    }
    rewrite {
        activeRecipe("org.openrewrite.yaml.CoalesceProperties")
    }
    afterEvaluate {
        if (repositories.isEmpty()) {
            repositories {
                mavenCentral()
            }
        }
    }
}
2.Run gradle --init-script init.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>org.openrewrite.yaml.CoalesceProperties</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>
2.Run mvn rewrite:run to run the recipe.
You will need to have Maven installed on your machine before you can run the following command.
shell
mvn -U org.openrewrite.maven:rewrite-maven-plugin:run \
  -Drewrite.activeRecipes=org.openrewrite.yaml.CoalesceProperties
You will need to have configured the Moderne CLI on your machine before you can run the following command.
shell
mod run . --recipe CoalesceProperties
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
​Jonathan Leitschuh, Mike Solomon, Sam Snyder​

Change value

Comment out property

Last modified 12d ago