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.

Recipe source

GitHub, Issue Tracker, Maven Central

  • groupId: org.openrewrite.recipe

  • artifactId: rewrite-spring

  • version: 5.7.0

Options

TypeNameDescriptionExample

String

property

The property key to add.

management.metrics.enable.process.files

String

value

The value of the new property key.

true

String

comment

Optional. A comment that will be added to the new property.

This is a comment

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".

["**/application.yml"]

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.7.0 in your build file:

  1. Add the following to your build.gradle file:

build.gradle
plugins {
    id("org.openrewrite.rewrite") version("6.10.0")
}

rewrite {
    activeRecipe("com.yourorg.AddSpringPropertyExample")
}

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-spring:5.7.0")
}
  1. Run gradle rewriteRun to run the recipe.

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.

Contributors

Tyler Van Gorder, Patrick, Knut Wannheden, Jonathan Schnéider, Sam Snyder, Mike Solomon, Kyle Scully, Shannon Pamperl, Adriano Machado

Last updated