Delete property

org.openrewrite.yaml.DeleteProperty
Delete a YAML property. Nested YAML mappings are interpreted as dot separated property names, i.e. as Spring Boot interprets application.yml files like a.b.c.d or a.b.c:d.
Source
​GitHub, Issue Tracker, Maven Central​
groupId: org.openrewrite
artifactId: rewrite-yaml
version: 8.6.0
Options
Type
Name
Description
String
propertyKey
The key to be deleted.
Boolean
coalesce
Optional. (Deprecated: in a future version, this recipe will always use the false behavior) Simplify nested map hierarchies into their simplest dot separated property form.
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.DeletePropertyExample. 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.DeletePropertyExample
displayName: Delete property example
recipeList:
  - org.openrewrite.yaml.DeleteProperty:
      propertyKey: management.metrics.binders.files.enabled
      coalesce: null
      relaxedBinding: null
Now that com.yourorg.DeletePropertyExample has been defined activate it in your build file:
Gradle
Maven
1.Add the following to your build.gradle file:
build.gradle
plugins {
    id("org.openrewrite.rewrite") version("6.3.11")
}
​
rewrite {
    activeRecipe("com.yourorg.DeletePropertyExample")
}
​
repositories {
    mavenCentral()
}
2.Run gradle rewriteRun to run the recipe.
1.Add the following to your pom.xml file:
pom.xml
<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>5.5.2</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.DeletePropertyExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>
2.Run mvn rewrite:run to run the recipe.
Contributors
​Jonathan Schneider​
​Kun Li​
​Patrick​
Patrick Way
​Aaron Gershman​
​Mike Solomon​
​Aurélien Mino​
​traceyyoshima​
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.

Type	Name	Description
`String`	propertyKey	The key to be deleted.
`Boolean`	coalesce	Optional. (Deprecated: in a future version, this recipe will always use the `false` behavior) Simplify nested map hierarchies into their simplest dot separated property form.
`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`.

Delete key

Merge YAML snippet

Last modified 6d ago