Skip to main content

Dependency insight for Gradle and Maven

org.openrewrite.java.dependencies.DependencyInsight

Finds dependencies, including transitive dependencies, in both Gradle and Maven projects. Matches within all Gradle dependency configurations and Maven scopes.

Recipe source​

GitHub: DependencyInsight.java, Issue Tracker, Maven Central

This recipe is available under the Apache License Version 2.0.

Options​

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

Used by​

This recipe is used as part of the following composite recipes:

Example​

Parameters​
ParameterValue
groupIdPatternorg.springframework*
artifactIdPattern*
versionnull
scopenull
Before​
pom.xml
<project>
  <groupId>com.example</groupId>
  <artifactId>foo</artifactId>
  <version>1.0.0</version>

  <dependencies>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-core</artifactId>
      <version>5.2.6.RELEASE</version>
    </dependency>
  </dependencies>
</project>
After​
pom.xml
<project>
  <groupId>com.example</groupId>
  <artifactId>foo</artifactId>
  <version>1.0.0</version>

  <dependencies>
    <!--~~(org.springframework:spring-core:5.2.6.RELEASE,org.springframework:spring-jcl:5.2.6.RELEASE)~~>--><dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-core</artifactId>
      <version>5.2.6.RELEASE</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.DependencyInsightExample
displayName: Dependency insight for Gradle and Maven example
recipeList:
  - org.openrewrite.java.dependencies.DependencyInsight:
      groupIdPattern: com.fasterxml.jackson*
      artifactIdPattern: jackson-*
      version: 1.x
      scope: compile

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

shell
mod run . --recipe DependencyInsight --recipe-option "groupIdPattern=com.fasterxml.jackson*" --recipe-option "artifactIdPattern=jackson-*" --recipe-option "version=1.x" --recipe-option "scope=compile"

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

mod config recipes jar install org.openrewrite.recipe:rewrite-java-dependencies:1.51.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​

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.
CountHow many times does this dependency appear.