Links

Add a new property

org.openrewrite.properties.AddProperty Adds a new property to a property file at the bottom of the file if it's missing. Whitespace before and after the = must be included in the property and value.

Source

  • groupId: org.openrewrite
  • artifactId: rewrite-properties
  • version: 7.35.0

Options

Type
Name
Description
String
property
The property key to add.
String
value
The value of the new property key.
String
delimiter
Optional. Property entries support different delimiters (=, :, or whitespace). The default value is = unless provided the delimiter of the new property entry.
String
fileMatcher
Optional. Matching files will be modified. This is a glob expression.

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.AddPropertyExample. 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.AddPropertyExample
displayName: Add a new property example
recipeList:
- org.openrewrite.properties.AddProperty:
property: management.metrics.enable.process.files
value: true
delimiter: :
fileMatcher: '**/application-*.properties'
Now that com.yourorg.AddPropertyExample has been defined activate it in your build file:
Gradle
Maven
build.gradle
plugins {
id("org.openrewrite.rewrite") version("5.34.0")
}
rewrite {
activeRecipe("com.yourorg.AddPropertyExample")
}
repositories {
mavenCentral()
}
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.AddPropertyExample</recipe>
</activeRecipes>
</configuration>
</plugin>
</plugins>
</build>
</project>
Recipes can also be activated directly from the command line by adding the argument -Drewrite.activeRecipes=com.yourorg.AddPropertyExample

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.