← All recipes
Open source

Dependency report

Recipe IDorg.openrewrite.java.dependencies.DependencyListArtifactorg.openrewrite.recipe:rewrite-java-dependencies

Emits a data table detailing all Gradle and Maven dependencies. This recipe makes no changes to any source file.

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.java.dependencies.DependencyList")
}

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.recipe:rewrite-java-dependencies:1.63.0")
}

Then run

./gradlew rewriteRun

Usage

This recipe has no required configuration options. You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.java.dependencies.DependencyList

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

mod config recipes jar install org.openrewrite.recipe:rewrite-java-dependencies:RELEASE

Options

NameTypeDescription
scopeScopeThe scope of the dependencies to include in the report.Defaults to "Compile"
e.g. Compile
includeTransitivebooleanWhether or not to include transitive dependencies in the report. Defaults to including only direct dependencies.Defaults to false.
e.g. true
validateResolvablebooleanWhen enabled the recipe will attempt to download every dependency it encounters, reporting on any failures. This can be useful for identifying dependencies that have become unavailable since an LST was produced.Defaults to false.
e.g. true

Data tables

Structured output this recipe can produce.

  • Dependency reportLists all Gradle and Maven dependenciesorg.openrewrite.java.dependencies.table.DependencyListReport
  • Maven metadata failuresAttempts to resolve maven metadata that failed.org.openrewrite.maven.table.MavenMetadataFailures
  • 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