rewrite-spring-core

The rewrite-spring-core module publishes 6 recipes across 1 category.

spring › boot › properties

Recipes

io.arconia.rewrite.spring.boot.properties.CommentSpringBootProperty

Add a comment to a property in Spring Boot configuration files. Optionally, comment out the property itself.

Table 1. Options
Name	Type	Required	Description
`propertyKey`	String	yes	The key for the property to comment. Example: `spring.ai.ollama.chat.enabled`
`comment`	String	yes	The comment to add before the property key. Example: `This property is deprecated and will be removed in future versions.`
`commentOutProperty`	Boolean	no	Whether to comment out the property. Defaults to `true`.

Example

Before

arconia:
  feature:
    toggle: true
    tier: platinum

After

arconia:
  feature:
    # This property has been removed from this version
    # toggle: true
    tier: platinum

io.arconia.rewrite.spring.boot.properties.ChangeSpringBootPropertyValue

Change the value of a property in Spring Boot configuration files.

Table 2. Options
Name	Type	Required	Description
`propertyKey`	String	yes	The property key whose value must change. Example: `arconia.dev.services.*.reusable`
`oldPropertyValue`	String	no	The property value to change. Example: `true`
`newPropertyValue`	String	yes	The new value for the property key. Example: `always`
`useRegex`	Boolean	no	Treats the old property value as a regular expression for matching. When enabled, only matching portions are replaced, and capture groups can be referenced in the new value. Defaults to `false`.
`relaxedBinding`	Boolean	no	Whether to match the property key using Spring Boot relaxed binding rules. Defaults to `true`.
`pathExpressions`	List	no	Glob expressions to match Spring Boot configuration files to modify. Defaults to standard `application.yml`, `application.yaml`, and `application.properties` files (including profile-specific variants). Multiple patterns are OR-ed together.

Example

Before

arconia:
  feature:
    toggle: true

After

arconia:
  feature:
    toggle: enabled

io.arconia.rewrite.spring.boot.properties.DeleteSpringBootProperty

Delete a property in Spring Boot configuration files.

Table 3. Options
Name	Type	Required	Description
`propertyKey`	String	yes	The key of the property to delete. Example: `arconia.modes.name`
`relaxedBinding`	Boolean	no	Whether to match the property key using Spring Boot relaxed binding rules. Defaults to `true`.
`pathExpressions`	List	no	Glob expressions to match Spring Boot configuration files to modify. Defaults to standard `application.yml`, `application.yaml`, and `application.properties` files (including profile-specific variants). Multiple patterns are OR-ed together.

Example

Before

arconia:
  modes:
    name: fantasy

After

io.arconia.rewrite.spring.boot.properties.FindSpringBootConfigFiles

Finds Spring Boot configuration files based on the provided path matchers.

Table 4. Options
Name	Type	Required	Description
`pathExpressions`	List	no	A list of glob expressions used to match which files contain Spring Boot configuration properties and therefore will be modified. If no value is provided, default expressions will be used to match the main YAML and Properties files supported by Spring Boot for configuration. If multiple patterns are supplied, any of the patterns matching will be interpreted as a match.

Example

Before

spring.application.name=myapp

After

~~>spring.application.name=myapp

io.arconia.rewrite.spring.boot.properties.RenameSpringBootPropertyKey

Rename the key of a property in Spring Boot configuration files.

Table 5. Options
Name	Type	Required	Description
`oldPropertyKey`	String	yes	The property key to rename. Example: `arconia.config.profiles.test`
`newPropertyKey`	String	yes	The new name for the property key. Example: `arconia.test.profiles`
`relaxedBinding`	Boolean	no	Whether to match the old property key using Spring Boot relaxed binding rules. Defaults to `true`.
`pathExpressions`	List	no	Glob expressions to match Spring Boot configuration files to modify. Defaults to standard `application.yml`, `application.yaml`, and `application.properties` files (including profile-specific variants). Multiple patterns are OR-ed together.

Example

Before

arconia:
  dev:
    profiles:
      test: local

After

arconia:
  config.profiles.test: local

io.arconia.rewrite.spring.boot.properties.RenameSpringBootPropertyKeyIfValue

Rename the key of a property in Spring Boot configuration files when its current value matches the given value.

Table 6. Options
Name	Type	Required	Description
`oldPropertyKey`	String	yes	The property key to rename. Example: `arconia.observations.conventions.type`
`propertyValue`	String	yes	The property value that must be present for the key to be renamed. Example: `langsmith`
`newPropertyKey`	String	yes	The new name for the property key. Example: `arconia.observations.conventions.opentelemetry.ai.flavor`
`relaxedBinding`	Boolean	no	Whether to match the old property key using Spring Boot relaxed binding rules. Defaults to `true`.
`pathExpressions`	List	no	Glob expressions to match Spring Boot configuration files to modify. Defaults to standard `application.yml`, `application.yaml`, and `application.properties` files (including profile-specific variants). Multiple patterns are OR-ed together.

Example

Before

arconia:
  feature:
    mode: advanced

After

arconia:
  feature:
    advanced-mode: advanced