Skip to main content

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

This recipe is available under the Moderne Source Available License.

Options​

TypeNameDescriptionExample
StringpropertyThe property key to add.management.metrics.enable.process.files
StringvalueThe value of the new property key.true
StringcommentOptional. A comment that will be added to the new property.This is a comment
ListpathExpressionsOptional. 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"]

Example​

Parameters​
ParameterValue
propertyserver.servlet.path
value/tmp/my-server-path
commentnull
pathExpressionsList.of("*")
Before​
server.port=8080
After​
server.port=8080
server.servlet.path=/tmp/my-server-path
Before​
server:
  port: 8080
After​
server:
  port: 8080
  servlet:
    path: /tmp/my-server-path

Usage​

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly (unless you are running them via the Moderne CLI). 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:6.7.0 in your build file:

  1. Add the following to your build.gradle file:
build.gradle
plugins {
    id("org.openrewrite.rewrite") version("7.6.1")
}

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

repositories {
    mavenCentral()
}

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

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

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.

Data Tables​

Source files that had results​

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column NameDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changesIn a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.

Contributors​

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