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
​GitHub, Issue Tracker, Maven Central​
groupId: org.openrewrite
artifactId: rewrite-properties
version: 8.6.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.
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: null
      delimiter: :
Now that com.yourorg.AddPropertyExample has been defined activate it in your build file:
Gradle
Maven
1.Add the following to your build.gradle file:
build.gradle
plugins {
    id("org.openrewrite.rewrite") version("6.3.11")
}
​
rewrite {
    activeRecipe("com.yourorg.AddPropertyExample")
}
​
repositories {
    mavenCentral()
}
2.Run gradle rewriteRun to run the recipe.
1.Add the following to your pom.xml file:
pom.xml
<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>5.5.2</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.AddPropertyExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>
2.Run mvn rewrite:run to run the recipe.
Contributors
​Tracey Yoshima​
​Nick McKinney​
​Shannon Pamperl​
​Tim te Beek​
​Jonathan Schneider​
Aaron Gershman
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.

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.

Properties

Change property key

Last modified 6d ago