Skip to main content

Find Maven project properties

org.openrewrite.maven.search.FindProperties

Finds the specified Maven project properties within a pom.xml.

Recipe source​

GitHub: FindProperties.java, Issue Tracker, Maven Central

This recipe is available under the Apache License Version 2.0.

Options​

TypeNameDescriptionExample
StringpropertyPatternRegular expression pattern used to match property tag names.guava.*
StringvaluePatternOptional. Regular expression pattern used to match property values.28.*

Example​

Parameters​
ParameterValue
propertyPatternguava.*
valuePatternnull
Before​
pom.xml
<project>
  <properties>
    <someNullProp/>
    <guava.version>28.2-jre</guava.version>
  </properties>
  <groupId>com.mycompany.app</groupId>
  <artifactId>my-app</artifactId>
  <version>1</version>
  <dependencies>
    <dependency>
        <groupId>com.google.guava</groupId>
        <artifactId>guava</artifactId>
        <version>${guava.version}</version>
    </dependency>
  </dependencies>
</project>
After​
pom.xml
<project>
  <properties>
    <someNullProp/>
    <!--~~>--><guava.version>28.2-jre</guava.version>
  </properties>
  <groupId>com.mycompany.app</groupId>
  <artifactId>my-app</artifactId>
  <version>1</version>
  <dependencies>
    <dependency>
        <groupId>com.google.guava</groupId>
        <artifactId>guava</artifactId>
        <version><!--~~(28.2-jre)~~>-->${guava.version}</version>
    </dependency>
  </dependencies>
</project>

Usage​

This recipe has required configuration parameters and can only be run by users of Moderne. To run this recipe, you will need to provide the Moderne CLI run command with the required options. Or, if you'd like to create a declarative recipe, please see the below example of a rewrite.yml file:

rewrite.yml
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.FindPropertiesExample
displayName: Find Maven project properties example
recipeList:
  - org.openrewrite.maven.search.FindProperties:
      propertyPattern: guava.*
      valuePattern: 28.*

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

shell
mod run . --recipe FindProperties --recipe-option "propertyPattern=guava.*" --recipe-option "valuePattern=28.*"

If the recipe is not available locally, then you can install it using:

mod config recipes jar install org.openrewrite:rewrite-maven:8.74.1

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

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.

Data Tables​

Maven properties​

org.openrewrite.maven.table.MavenProperties

Property and value.

Column NameDescription
PropertyThe Maven property that was found.
ValueThe value associated with the property.