Links

Find YAML properties

org.openrewrite.yaml.search.FindProperty
Find a YAML property. Nested YAML mappings are interpreted as dot separated property names, i.e. as Spring Boot interprets application.yml files.

Source

  • groupId: org.openrewrite
  • artifactId: rewrite-yaml
  • version: 7.40.6

Contributors

Options

Type
Name
Description
String
propertyKey
The key to look for. Glob is supported.
Boolean
relaxedBinding
Optional. Whether to match the propertyKey using relaxed binding rules. Default is true. Set to false to use exact matching.

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.FindPropertyExample. 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.FindPropertyExample
displayName: Find YAML properties example
recipeList:
- org.openrewrite.yaml.search.FindProperty:
propertyKey: management.metrics.binders.*.enabled
relaxedBinding: null
Now that com.yourorg.FindPropertyExample has been defined activate it in your build file:
Gradle
Maven
build.gradle
plugins {
id("org.openrewrite.rewrite") version("5.40.4")
}
rewrite {
activeRecipe("com.yourorg.FindPropertyExample")
}
repositories {
mavenCentral()
}
pom.xml
<project>
<build>
<plugins>
<plugin>
<groupId>org.openrewrite.maven</groupId>
<artifactId>rewrite-maven-plugin</artifactId>
<version>4.45.0</version>
<configuration>
<activeRecipes>
<recipe>com.yourorg.FindPropertyExample</recipe>
</activeRecipes>
</configuration>
</plugin>
</plugins>
</build>
</project>

See how this recipe works across multiple open-source repositories

Moderne Link Image
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.