Links

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

  • groupId: org.openrewrite.recipe
  • artifactId: rewrite-spring
  • version: 4.32.0

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:4.32.0 in your build file:
Gradle
Maven
build.gradle
plugins {
id("org.openrewrite.rewrite") version("5.34.0")
}
rewrite {
activeRecipe("com.yourorg.AddSpringPropertyExample")
}
repositories {
mavenCentral()
}
dependencies {
rewrite("org.openrewrite.recipe:rewrite-spring:4.32.0")
}
pom.xml
<project>
<build>
<plugins>
<plugin>
<groupId>org.openrewrite.maven</groupId>
<artifactId>rewrite-maven-plugin</artifactId>
<version>4.39.0</version>
<configuration>
<activeRecipes>
<recipe>com.yourorg.AddSpringPropertyExample</recipe>
</activeRecipes>
</configuration>
<dependencies>
<dependency>
<groupId>org.openrewrite.recipe</groupId>
<artifactId>rewrite-spring</artifactId>
<version>4.32.0</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
</project>
Recipes can also be activated directly from the command line by adding the argument -Drewrite.activeRecipes=com.yourorg.AddSpringPropertyExample

See how this recipe works across multiple open-source repositories

Moderne Link Image
The Moderne public SaaS instance 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.