Add a spring configuration property

org.openrewrite.java.spring.AddSpringProperty
Add a spring configuration property to a configuration file if it does not already exist in that file.
Source
​GitHub, Issue Tracker, Maven Central​
groupId: org.openrewrite.recipe
artifactId: rewrite-spring
version: 5.0.10
Options
Type
Name
Description
String
property
The property key to add.
String
value
The value of the new property key.
String
comment
Optional. A comment that will be added to the new property.
List
pathExpressions
Optional. Each value in this list represents a glob expression that is used to match which files will be modified. If this value is not present, this recipe will query the execution context for reasonable defaults. ("/application.yml", "/application.yml", and "**/application.properties".
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.AddSpringPropertyExample. 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.AddSpringPropertyExample
displayName: Add a spring configuration property example
recipeList:
  - org.openrewrite.java.spring.AddSpringProperty:
      property: management.metrics.enable.process.files
      value: true
      comment: This is a comment
      pathExpressions: ["**/application.yml"]
Now that com.yourorg.AddSpringPropertyExample has been defined activate it and take a dependency on org.openrewrite.recipe:rewrite-spring:5.0.10 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.AddSpringPropertyExample")
}
​
repositories {
    mavenCentral()
}
​
dependencies {
    rewrite("org.openrewrite.recipe:rewrite-spring:5.0.10")
}
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.AddSpringPropertyExample</recipe>
          </activeRecipes>
        </configuration>
        <dependencies>
          <dependency>
            <groupId>org.openrewrite.recipe</groupId>
            <artifactId>rewrite-spring</artifactId>
            <version>5.0.10</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>
</project>
2.Run mvn rewrite:run to run the recipe.
Contributors
Tyler Van Gorder
​Knut Wannheden​
​Patrick​
​Sam Snyder​
​Mike Solomon​
​Kyle Scully​
​Shannon Pamperl​
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`	property	The property key to add.
`String`	value	The value of the new property key.
`String`	comment	Optional. A comment that will be added to the new property.
`List`	pathExpressions	Optional. Each value in this list represents a glob expression that is used to match which files will be modified. If this value is not present, this recipe will query the execution context for reasonable defaults. ("/application.yml", "/application.yml", and "**/application.properties".

Spring

Change the key of a spring application property

Last modified 6d ago