Delete key

org.openrewrite.yaml.DeleteKey

Delete a YAML mapping entry key.

Recipe source

GitHub, Issue Tracker, Maven Central

  • groupId: org.openrewrite

  • artifactId: rewrite-yaml

  • version: 8.21.0

Options

TypeNameDescriptionExample

String

keyPath

A JsonPath expression to locate a YAML entry.

$.source.kind

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.DeleteKeyExample. 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.DeleteKeyExample
displayName: Delete key example
recipeList:
  - org.openrewrite.yaml.DeleteKey:
      keyPath: $.source.kind

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

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, Tim te Beek, Mike Solomon, Sam Snyder, Tracey Yoshima

Last updated