Skip to main content

Maven dependency insight

org.openrewrite.maven.search.DependencyInsight

Find direct and transitive dependencies matching a group, artifact, and scope. Results include dependencies that either directly match or transitively include a matching dependency.

Recipe source​

GitHub, Issue Tracker, Maven Central

This recipe is available under the Apache License Version 2.0.

Options​

TypeNameDescriptionExample
StringgroupIdPatternGroup glob pattern used to match dependencies.com.fasterxml.jackson.module
StringartifactIdPatternArtifact glob pattern used to match dependencies.jackson-module-*
StringscopeOptional. Match dependencies with the specified scope. All scopes are searched by default. Valid options: compile, test, runtime, provided, systemcompile
StringversionOptional. Match only dependencies with the specified version. Node-style version selectors may be used.All versions are searched by default.1.x
BooleanonlyDirectOptional. If enabled, transitive dependencies will not be considered. All dependencies are searched by default.true

Example​

Parameters​
ParameterValue
groupIdPattern*guava*
artifactIdPattern*
scopecompile
versionnull
onlyDirectnull
Before​
pom.xml
<project>
  <groupId>com.mycompany.app</groupId>
  <artifactId>my-app</artifactId>
  <version>1</version>
  <dependencies>
    <dependency>
        <groupId>com.google.guava</groupId>
        <artifactId>guava</artifactId>
        <version>29.0-jre</version>
    </dependency>
  </dependencies>
</project>
After​
pom.xml
<project>
  <groupId>com.mycompany.app</groupId>
  <artifactId>my-app</artifactId>
  <version>1</version>
  <dependencies>
    <!--~~>--><dependency>
        <groupId>com.google.guava</groupId>
        <artifactId>guava</artifactId>
        <version>29.0-jre</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.DependencyInsightExample. 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.DependencyInsightExample
displayName: Maven dependency insight example
recipeList:
  - org.openrewrite.maven.search.DependencyInsight:
      groupIdPattern: com.fasterxml.jackson.module
      artifactIdPattern: jackson-module-*
      scope: compile
      version: 1.x
      onlyDirect: true

Now that com.yourorg.DependencyInsightExample 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>6.10.0</version>
        <configuration>
          <exportDatatables>true</exportDatatables>
          <activeRecipes>
            <recipe>com.yourorg.DependencyInsightExample</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​

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​

Dependencies in use​

org.openrewrite.maven.table.DependenciesInUse

Direct and transitive dependencies in use.

Column NameDescription
Project nameThe name of the project that contains the dependency.
Source setThe source set that contains the dependency.
GroupThe first part of a dependency coordinate com.google.guava:guava:VERSION.
ArtifactThe second part of a dependency coordinate com.google.guava:guava:VERSION.
VersionThe resolved version.
Dated snapshot versionThe resolved dated snapshot version or null if this dependency is not a snapshot.
ScopeDependency scope. This will be compile if the dependency is direct and a scope is not explicitly specified in the POM.
DepthHow many levels removed from a direct dependency. This will be 0 for direct dependencies.

Contributors​

Sam Snyder, Jonathan Schneider, Greg Adams, Nick McKinney, Jonathan Leitschuh, Tim te Beek