dependencyinsight.md

Gradle dependency insight

org.openrewrite.gradle.search.DependencyInsight

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

Source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite
• artifactId: rewrite-gradle
• version: 8.1.3

Options

Type	Name	Description
String	groupIdPattern	Group glob pattern used to match dependencies.
String	artifactIdPattern	Artifact glob pattern used to match dependencies.
String	configuration	Optional. Match dependencies with the specified scope. If not specified, all configurations will be searched.

Data Tables (Only available on the Moderne platform)

Dependencies in use

Direct and transitive dependencies in use.

Column Name	Description
Project name	The name of the project that contains the dependency.
Source set	The source set that contains the dependency.
Group	The first part of a dependency coordinate com.google.guava:guava:VERSION.
Artifact	The second part of a dependency coordinate com.google.guava:guava:VERSION.
Version	The resolved version.
Dated snapshot version	The resolved dated snapshot version or null if this dependency is not a snapshot.
Scope	Dependency scope. This will be compile if the dependency is direct and a scope is not explicitly specified in the POM.
Depth	How many levels removed from a direct dependency. This will be 0 for direct dependencies.

Example

Parameters

Parameter	Value
groupIdPattern	com.google.guava
artifactIdPattern	failureaccess
configuration	null

{% tabs %} {% tab title="build.gradle" %}

Before

{% code title="build.gradle" %}

plugins {
    id 'java-library'
}

repositories {
    mavenCentral()
}

dependencies {
    implementation 'com.google.guava:guava:31.1-jre'
}

{% endcode %}

After

{% code title="build.gradle" %}

plugins {
    id 'java-library'
}

repositories {
    mavenCentral()
}

dependencies {
    /*~~(com.google.guava:failureaccess:1.0.1)~~>*/implementation 'com.google.guava:guava:31.1-jre'
}

{% endcode %}

{% endtab %} {% tab title="Diff" %} {% code %}

--- build.gradle
+++ build.gradle
@@ -10,1 +10,1 @@

dependencies {
-   implementation 'com.google.guava:guava:31.1-jre'
+   /*~~(com.google.guava:failureaccess:1.0.1)~~>*/implementation 'com.google.guava:guava:31.1-jre'
}

{% endcode %} {% endtab %} {% endtabs %}

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.DependencyInsightExample. Here's how you can define and customize such a recipe within your rewrite.yml:

{% code title="rewrite.yml" %}

---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.DependencyInsightExample
displayName: Gradle dependency insight example
recipeList:
  - org.openrewrite.gradle.search.DependencyInsight:
      groupIdPattern: com.fasterxml.jackson.module
      artifactIdPattern: jackson-module-*
      configuration: compileClasspath

{% endcode %}

Now that com.yourorg.DependencyInsightExample has been defined activate it in your build file: {% tabs %} {% tab title="Gradle" %} {% code title="build.gradle" %}

plugins {
    id("org.openrewrite.rewrite") version("6.1.4")
}

rewrite {
    activeRecipe("com.yourorg.DependencyInsightExample")
}

repositories {
    mavenCentral()
}

{% endcode %} {% endtab %}

{% endtabs %}

Contributors

• Sam Snyder
• Jonathan Schnéider
• Tim te Beek

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.