changespringpropertykey.md

Change the key of a spring application property

org.openrewrite.java.spring.ChangeSpringPropertyKey

Change spring application property keys existing in either Properties or Yaml files.

Source

GitHub, Issue Tracker, Maven Central

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

Options

Type	Name	Description
String	oldPropertyKey	The property key to rename. Supports glob
String	newPropertyKey	The new name for the property key.
List	except	Optional. If any of these property keys exist as direct children of oldPropertyKey, then they will not be moved to newPropertyKey.

Example

Parameters

Parameter	Value
oldPropertyKey	server.servlet-path
newPropertyKey	server.servlet.path
except	null

{% tabs %} {% tab title="properties" %}

Before

{% code %}

server.servlet-path=/tmp/my-server-path

{% endcode %}

After

{% code %}

server.servlet.path=/tmp/my-server-path

{% endcode %}

{% endtab %} {% tab title="Diff" %} {% code %}

@@ -1,1 +1,1 @@
-server.servlet-path=/tmp/my-server-path
+server.servlet.path=/tmp/my-server-path

{% endcode %} {% endtab %} {% endtabs %}

{% tabs %} {% tab title="yaml" %}

Before

{% code %}

    server:
      servlet-path: /tmp/my-server-path

{% endcode %}

After

{% code %}

    server:
      servlet.path: /tmp/my-server-path

{% endcode %}

{% endtab %} {% tab title="Diff" %} {% code %}

@@ -2,1 +2,1 @@
    server:
-     servlet-path: /tmp/my-server-path
+     servlet.path: /tmp/my-server-path

{% endcode %} {% endtab %} {% endtabs %}

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.ChangeSpringPropertyKeyExample. Here's how you can define and customize such a recipe within your rewrite.yml:

{% code title="rewrite.yml" %}

---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.ChangeSpringPropertyKeyExample
displayName: Change the key of a spring application property example
recipeList:
  - org.openrewrite.java.spring.ChangeSpringPropertyKey:
      oldPropertyKey: management.metrics.binders.*.enabled
      newPropertyKey: management.metrics.enable.process.files
      except: null

{% endcode %}

Now that com.yourorg.ChangeSpringPropertyKeyExample has been defined activate it and take a dependency on org.openrewrite.recipe:rewrite-spring:5.0.1 in your build file: {% tabs %} {% tab title="Gradle" %} {% code title="build.gradle" %}

plugins {
    id("org.openrewrite.rewrite") version("6.1.4")
}

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

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-spring:5.0.1")
}

{% endcode %} {% endtab %} {% tab title="Maven" %} {% code title="pom.xml" %}

<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>5.2.4</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.ChangeSpringPropertyKeyExample</recipe>
          </activeRecipes>
        </configuration>
        <dependencies>
          <dependency>
            <groupId>org.openrewrite.recipe</groupId>
            <artifactId>rewrite-spring</artifactId>
            <version>5.0.1</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>
</project>

{% endcode %} {% endtab %} {% endtabs %}

Contributors

• Tyler Van Gorder
• Knut Wannheden
• Nick McKinney
• Patrick
• Kyle Scully

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.