Open source

Gradle dependency insight

Recipe IDorg.openrewrite.gradle.search.DependencyInsightArtifactorg.openrewrite:rewrite-gradle

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

Single recipeApache 2.0

Add to your build

Get a download tokenSign in with GitHub or Google, and your token replaces YOUR_DOWNLOAD_TOKEN below. Free for open source recipes like this one.

~/.gradle/gradle.properties

codeGenomeUsername=you@example.com
codeGenomeToken=YOUR_DOWNLOAD_TOKEN

build.gradle.kts

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

rewrite {
    activeRecipe("org.openrewrite.gradle.search.DependencyInsight")
}

repositories {
    mavenCentral()
    maven {
        url = uri("https://artifacts.codegenomeproject.org/maven")
        credentials {
            username = providers.gradleProperty("codeGenomeUsername").get()
            password = providers.gradleProperty("codeGenomeToken").get()
        }
    }
}

dependencies {
    rewrite("org.openrewrite:rewrite-gradle:8.92.8")
}

Then run

./gradlew rewriteRun

This recipe has required options, which a build sets in a rewrite.yml recipe that you activate instead.

Usage

You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.gradle.search.DependencyInsight --recipe-option "groupIdPattern=com.fasterxml.jackson.module" --recipe-option "artifactIdPattern=jackson-module-*"

If the recipe isn’t available locally, install it with:

mod config recipes jar install org.openrewrite:rewrite-gradle:RELEASE

Options

Name	Type	Description
`groupIdPattern`required	`String`	Group glob pattern used to match dependencies. e.g. `com.fasterxml.jackson.module`
`artifactIdPattern`required	`String`	Artifact glob pattern used to match dependencies. e.g. `jackson-module-*`
`version`	`String`	Match only dependencies with the specified resolved version. Node-style version selectors may be used.All versions are searched by default. e.g. `1.x`
`configuration`	`String`	Match dependencies with the specified scope. If not specified, all configurations will be searched. e.g. `compileClasspath`

Data tables

Structured output this recipe can produce.

Dependencies in useDirect and transitive dependencies in use.org.openrewrite.maven.table.DependenciesInUse
Explain dependencies in useA dependency graph explainer similar to that shown by `gradle dependencyInsight` for each matching dependency. This table will contain a row per matching dependency per configuration per (sub)project.org.openrewrite.maven.table.ExplainDependenciesInUse
Source files that had resultsSource files that were modified by the recipe run.org.openrewrite.table.SourcesFileResults
Source files that had search resultsSearch results that were found during the recipe run.org.openrewrite.table.SearchResults
Source files that errored on a recipeThe details of all errors produced by a recipe run.org.openrewrite.table.SourcesFileErrors
Recipe performanceStatistics used in analyzing the performance of recipes.org.openrewrite.table.RecipeRunStats