Links

Find YAML entries

org.openrewrite.yaml.search.FindKey
Find YAML entries by JsonPath expression.

Source

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

Contributors

Options

Type
Name
Description
String
key
A JsonPath expression used to find matching keys.

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.FindKeyExample. 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.FindKeyExample
displayName: Find YAML entries example
recipeList:
- org.openrewrite.yaml.search.FindKey:
key: $.subjects.kind
Now that com.yourorg.FindKeyExample 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.FindKeyExample")
}
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.FindKeyExample</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.