Dependency report

Name: OpenRewrite
Author: Moderne

org.openrewrite.java.dependencies.DependencyList

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

Recipe source

GitHub, Issue Tracker, Maven Central

This recipe is available under the Apache License Version 2.0.

Options

Type	Name	Description	Example
`Scope`	scope	Optional. The scope of the dependencies to include in the report.Defaults to "Compile" Valid options: `Compile`, `Runtime`, `TestRuntime`	`Compile`
`boolean`	includeTransitive	Optional. Whether or not to include transitive dependencies in the report. Defaults to including only direct dependencies.Defaults to false.	`true`
`boolean`	validateResolvable	Optional. When 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. Valid options: `true`, `false`	`true`

Usage

This recipe has no required configuration options. It can be activated by adding a dependency on org.openrewrite.recipe:rewrite-java-dependencies in your build file or by running a shell command (in which case no build changes are needed):

Gradle
Gradle init script
Maven POM
Maven Command Line
Moderne CLI

Add the following to your build.gradle file:

build.gradle
plugins {
    id("org.openrewrite.rewrite") version("7.6.2")
}

rewrite {
    activeRecipe("org.openrewrite.java.dependencies.DependencyList")
    setExportDatatables(true)
}

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-java-dependencies:1.34.0")
}

Run gradle rewriteRun to run the recipe.

Create a file named init.gradle in the root of your project.

init.gradle
initscript {
    repositories {
        maven { url "https://plugins.gradle.org/m2" }
    }
    dependencies { classpath("org.openrewrite:plugin:7.6.2") }
}
rootProject {
    plugins.apply(org.openrewrite.gradle.RewritePlugin)
    dependencies {
        rewrite("org.openrewrite.recipe:rewrite-java-dependencies:1.34.0")
    }
    rewrite {
        activeRecipe("org.openrewrite.java.dependencies.DependencyList")
        setExportDatatables(true)
    }
    afterEvaluate {
        if (repositories.isEmpty()) {
            repositories {
                mavenCentral()
            }
        }
    }
}

Run the recipe.

shell

gradle --init-script init.gradle rewriteRun

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.9.0</version>
        <configuration>
          <exportDatatables>true</exportDatatables>
          <activeRecipes>
            <recipe>org.openrewrite.java.dependencies.DependencyList</recipe>
          </activeRecipes>
        </configuration>
        <dependencies>
          <dependency>
            <groupId>org.openrewrite.recipe</groupId>
            <artifactId>rewrite-java-dependencies</artifactId>
            <version>1.34.0</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>
</project>

Run mvn rewrite:run to run the recipe.

You will need to have Maven installed on your machine before you can run the following command.

shell
mvn -U org.openrewrite.maven:rewrite-maven-plugin:run -Drewrite.recipeArtifactCoordinates=org.openrewrite.recipe:rewrite-java-dependencies:RELEASE -Drewrite.activeRecipes=org.openrewrite.java.dependencies.DependencyList -Drewrite.exportDatatables=true

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

shell
mod run . --recipe DependencyList

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.34.0

See how this recipe works across multiple open-source repositories

Run this recipe on OSS repos at scale with the Moderne SaaS.

Run this recipe here

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

DependencyListReport
MavenMetadataFailures
SourcesFileResults
SourcesFileErrors
RecipeRunStats