Does not include Maven dependency

org.openrewrite.maven.search.DoesNotIncludeDependency

An applicability test which returns false if visiting a Maven pom which includes the specified dependency in the classpath of some scope. For compatibility with multimodule projects, this should most often be applied as a single-source applicability test.

Recipe source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite

• artifactId: rewrite-maven

• version: 8.23.1

Options

Type	Name	Description	Example
String	groupId	The first part of a dependency coordinate com.google.guava:guava:VERSION. Supports glob.	com.google.guava
String	artifactId	The second part of a dependency coordinate com.google.guava:guava:VERSION. Supports glob.	guava
Boolean	onlyDirect	Optional. Default false. If enabled, transitive dependencies will not be considered.	true
String	scope	Optional. Default any. If specified, only the requested scope's classpaths will be checked. Valid options: compile, test, runtime, provided	compile

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.DoesNotIncludeDependencyExample. 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.DoesNotIncludeDependencyExample
displayName: Does not include Maven dependency example
recipeList:
  - org.openrewrite.maven.search.DoesNotIncludeDependency:
      groupId: com.google.guava
      artifactId: guava
      onlyDirect: true
      scope: compile

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

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.27.0</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.DoesNotIncludeDependencyExample</recipe>
          </activeRecipes>
        </configuration>
      </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 DoesNotIncludeDependencyExample

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

Nick McKinney, Jonathan Schnéider, Sam Snyder, Jonathan Leitschuh, Tim te Beek