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, Code Genome Project

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. Recipes with required configuration parameters cannot be activated directly (unless you are running them via the Moderne CLI). 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.FindPropertiesExample. 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.FindPropertiesExample
displayName: Find Maven project properties example
recipeList:
  - org.openrewrite.maven.search.FindProperties:
      propertyPattern: guava.*
      valuePattern: 28.*

This recipe has no required configuration parameters and comes from a rewrite core library. It can be activated directly without adding any dependencies.

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

OpenRewrite artifacts are distributed through the Code Genome Project repository (https://artifacts.codegenomeproject.org/maven), which requires authentication. Sign in to the Code Genome Project to create a download token, then in the snippets below replace USERNAME with the email or username you signed in with and TOKEN with that token. See the quickstart guide for details.

  1. Add the Code Genome Project credentials to your Maven settings.xml file (typically at ~/.m2/settings.xml):
    settings.xml
    <settings>
      <servers>
        <server>
          <id>codegenome</id>
          <username>USERNAME</username>
          <password>TOKEN</password>
        </server>
      </servers>
    </settings>
  2. Add the following to your pom.xml file:
    pom.xml
    <project>
      <repositories>
        <repository>
          <id>codegenome</id>
          <url>https://artifacts.codegenomeproject.org/maven</url>
        </repository>
      </repositories>
      <pluginRepositories>
        <pluginRepository>
          <id>codegenome</id>
          <url>https://artifacts.codegenomeproject.org/maven</url>
        </pluginRepository>
      </pluginRepositories>
      <build>
        <plugins>
          <plugin>
            <groupId>org.openrewrite.maven</groupId>
            <artifactId>rewrite-maven-plugin</artifactId>
            <version>6.45.0</version>
            <configuration>
              <exportDatatables>true</exportDatatables>
              <activeRecipes>
                <recipe>com.yourorg.FindPropertiesExample</recipe>
              </activeRecipes>
            </configuration>
          </plugin>
        </plugins>
      </build>
    </project>
  3. Run mvn rewrite:run to run the recipe.

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.