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.22.0

Options

Type
Name
Description
String
propertyKey
The key to look for.
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
1
---
2
type: specs.openrewrite.org/v1beta/recipe
3
name: com.yourorg.FindPropertyExample
4
displayName: Find YAML properties example
5
recipeList:
6
- org.openrewrite.yaml.search.FindProperty:
7
propertyKey: management.metrics.binders.files.enabled
8
relaxedBinding: null
Copied!
Now that com.yourorg.FindPropertyExample has been defined activate it in your build file:
Gradle
Maven
build.gradle
1
plugins {
2
id("org.openrewrite.rewrite") version("5.20.0")
3
}
4
5
rewrite {
6
activeRecipe("com.yourorg.FindPropertyExample")
7
}
8
9
repositories {
10
mavenCentral()
11
}
Copied!
pom.xml
1
<project>
2
<build>
3
<plugins>
4
<plugin>
5
<groupId>org.openrewrite.maven</groupId>
6
<artifactId>rewrite-maven-plugin</artifactId>
7
<version>4.23.0</version>
8
<configuration>
9
<activeRecipes>
10
<recipe>com.yourorg.FindPropertyExample</recipe>
11
</activeRecipes>
12
</configuration>
13
</plugin>
14
</plugins>
15
</build>
16
</project>
Copied!
Recipes can also be activated directly from the commandline by adding the argument -Drewrite.activeRecipes=com.yourorg.FindPropertyExample
Export as PDF
Copy link