Change property key

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.
Source
​GitHub, Issue Tracker, Maven Central​
groupId: org.openrewrite
artifactId: rewrite-yaml
version: 8.6.0
Options
Type
Name
Description
String
oldPropertyKey
The property key to rename. Supports glob patterns.
String
newPropertyKey
The new name for the property key.
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.
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.ChangePropertyKeyExample. 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.ChangePropertyKeyExample
displayName: Change property key example
recipeList:
  - org.openrewrite.yaml.ChangePropertyKey:
      oldPropertyKey: management.metrics.binders.*.enabled
      newPropertyKey: management.metrics.enable.process.files
      relaxedBinding: null
      except: null
Now that com.yourorg.ChangePropertyKeyExample 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.ChangePropertyKeyExample")
}
​
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.ChangePropertyKeyExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>
2.Run mvn rewrite:run to run the recipe.
Contributors
​Nick McKinney​
​Jonathan Leitschuh​
​Patrick​
​Tracey Yoshima​
​Jonathan Schnéider​
​Mike Solomon​
​Thomas Zub​
Sandeep Nagaraj
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`	oldPropertyKey	The property key to rename. Supports glob patterns.
`String`	newPropertyKey	The new name for the property key.
`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`.

Change key

Change value

Last modified 6d ago