org.openrewrite.yaml.ChangePropertyKey
Change a YAML property key while leaving the value intact. Expects dot notation for nested YAML mappings, similar to how Spring Boot interprets application.yml
files.
GitHub, Issue Tracker, Maven Central
- groupId: org.openrewrite
- artifactId: rewrite-yaml
- version: 8.24.0
Type | Name | Description | Example |
---|---|---|---|
String |
oldPropertyKey | The property key to rename. Supports glob patterns. | management.metrics.binders.*.enabled |
String |
newPropertyKey | The new name for the property key. | management.metrics.enable.process.files |
Boolean |
relaxedBinding | Optional. Whether to match the oldPropertyKey using relaxed binding rules. Defaults to true . If you want to use exact matching in your search, set this to false . |
|
List |
except | Optional. If any of these property keys exist as direct children of oldPropertyKey , then they will not be moved to newPropertyKey . |
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.ChangePropertyKeyExample
.
Here's how you can define and customize such a recipe within your rewrite.yml:
{% code title="rewrite.yml" %}
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.ChangePropertyKeyExample
displayName: Change property key example
recipeList:
- org.openrewrite.yaml.ChangePropertyKey:
oldPropertyKey: management.metrics.binders.*.enabled
newPropertyKey: management.metrics.enable.process.files
{% endcode %}
Now that com.yourorg.ChangePropertyKeyExample
has been defined activate it in your build file:
{% tabs %}
{% tab title="Gradle" %}
- Add the following to your
build.gradle
file: {% code title="build.gradle" %}
plugins {
id("org.openrewrite.rewrite") version("6.12.0")
}
rewrite {
activeRecipe("com.yourorg.ChangePropertyKeyExample")
}
repositories {
mavenCentral()
}
{% endcode %}
2. Run gradle rewriteRun
to run the recipe.
{% endtab %}
{% tab title="Maven" %}
- Add the following to your
pom.xml
file: {% code title="pom.xml" %}
<project>
<build>
<plugins>
<plugin>
<groupId>org.openrewrite.maven</groupId>
<artifactId>rewrite-maven-plugin</artifactId>
<version>5.29.0</version>
<configuration>
<activeRecipes>
<recipe>com.yourorg.ChangePropertyKeyExample</recipe>
</activeRecipes>
</configuration>
</plugin>
</plugins>
</build>
</project>
{% endcode %}
2. Run mvn rewrite:run
to run the recipe.
{% endtab %}
{% tab title="Moderne CLI" %}
You will need to have configured the Moderne CLI on your machine before you can run the following command.
{% code title="shell" %}
mod run . --recipe ChangePropertyKeyExample
{% endcode %} {% endtab %} {% endtabs %}
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.
Nick McKinney, Jonathan Leitschuh, Patrick, Jonathan Schnéider, Tracey Yoshima, Mike Solomon, Thomas Zub, Sandeep Nagaraj, Tim te Beek