Delete Quarkus configuration property

org.openrewrite.quarkus.DeleteQuarkusProperty

Delete a property from Quarkus configuration files.

Recipe source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite.recipe

• artifactId: rewrite-quarkus

• version: 2.4.0

Options

Type	Name	Description	Example
String	propertyKey	The name of the property key whose value is to be deleted.	quarkus.hibernate-search-orm.indexing.plan.synchronization.strategy
String	oldValue	Optional. Only delete the property value if it matches the configured oldValue.	read-sync
String	profile	Optional. The profile where the property should be deleted. If not specified, the property will be deleted from all profiles by default.	dev
Boolean	deleteFromAllProfiles	Optional. If set to true, the property will be removed from all available profiles. Defaults to true.	false
List	pathExpressions	Optional. 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.yaml", "/application.properties" and "/META-INF/microprofile-config.properties".	["**/application.yaml"]

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.DeleteQuarkusPropertyExample. 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.DeleteQuarkusPropertyExample
displayName: Delete Quarkus configuration property example
recipeList:
  - org.openrewrite.quarkus.DeleteQuarkusProperty:
      propertyKey: quarkus.hibernate-search-orm.indexing.plan.synchronization.strategy
      oldValue: read-sync
      profile: dev
      deleteFromAllProfiles: false
      pathExpressions: ["**/application.yaml"]

Now that com.yourorg.DeleteQuarkusPropertyExample has been defined activate it and take a dependency on org.openrewrite.recipe:rewrite-quarkus:2.4.0 in your build file:

Gradle

1. Add the following to your build.gradle file:

build.gradle

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

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

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-quarkus:2.4.0")
}

2. Run gradle rewriteRun to run the recipe.

Maven

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.29.0</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.DeleteQuarkusPropertyExample</recipe>
          </activeRecipes>
        </configuration>
        <dependencies>
          <dependency>
            <groupId>org.openrewrite.recipe</groupId>
            <artifactId>rewrite-quarkus</artifactId>
            <version>2.4.0</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>
</project>

2. Run mvn rewrite:run to run the recipe.

Moderne CLI

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell

mod run . --recipe DeleteQuarkusPropertyExample

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.

Contributors

Adriano Machado, Guillaume Smet, Tim te Beek