Find YAML properties

org.openrewrite.yaml.search.FindProperty

Find YAML properties that match the specified propertyKey. Expects dot notation for nested YAML mappings, similar to how Spring Boot interprets application.yml files.

Recipe source

GitHub, Issue Tracker, Maven Central

  • groupId: org.openrewrite

  • artifactId: rewrite-yaml

  • version: 8.21.0

Options

TypeNameDescriptionExample

String

propertyKey

The key to look for. Glob is supported.

management.metrics.binders.*.enabled

Boolean

relaxedBinding

Optional. Whether to match the propertyKey using relaxed binding rules. Defaults to true. If you want to use exact matching in your search, set this to false.

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

Now that com.yourorg.FindPropertyExample 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("6.10.0")
}

rewrite {
    activeRecipe("com.yourorg.FindPropertyExample")
}

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

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 Schneider, Aaron Gershman, Nick McKinney, Mike Solomon, traceyyoshima, Tim te Beek

Last updated