Remove Maven project property

org.openrewrite.maven.RemoveProperty

Removes the specified Maven project property from the pom.xml.

Recipe source

GitHub, Issue Tracker, Maven Central

  • groupId: org.openrewrite

  • artifactId: rewrite-maven

  • version: 8.24.0

Options

TypeNameDescriptionExample

String

propertyName

Key name of the property to remove.

junit.version

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.RemovePropertyExample. 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.RemovePropertyExample
displayName: Remove Maven project property example
recipeList:
  - org.openrewrite.maven.RemoveProperty:
      propertyName: junit.version

Now that com.yourorg.RemovePropertyExample has been defined activate it in your build file:

  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.RemovePropertyExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>
  1. Run mvn rewrite:run to run the recipe.

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

Patrick Way, Aaron Gershman, Nick McKinney, Sam Snyder, Greg Adams, Jonathan Schnéider, Tim te Beek

Last updated