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

Options

Type	Name	Description	Example
`Scope`	scope	The scope of the dependencies to include in the report. Valid options: `Compile`, `Runtime`, `TestRuntime`	`Compile`
`boolean`	includeTransitive	Whether or not to include transitive dependencies in the report. Defaults to including only direct dependencies.	`true`

License

This recipe is available under the Apache License 2.0.

Usage

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly (unless you are running them via the Moderne CLI). 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.DependencyListExample. Here's how you can define and customize such a recipe within your rewrite.yml:

rewrite.yml
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.DependencyListExample
displayName: Dependency report example
recipeList:
  - org.openrewrite.java.dependencies.DependencyList:
      scope: Compile
      includeTransitive: false

Now that com.yourorg.DependencyListExample has been defined, activate it and take a dependency on org.openrewrite.recipe:rewrite-java-dependencies:1.25.0 in your build file:

Gradle
Maven
Moderne CLI

Add the following to your build.gradle file:

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

rewrite {
    activeRecipe("com.yourorg.DependencyListExample")
    setExportDatatables(true)
}

repositories {
    mavenCentral()
}

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

Run gradle rewriteRun to run the recipe.

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>5.47.0</version>
        <configuration>
          <exportDatatables>true</exportDatatables>
          <activeRecipes>
            <recipe>com.yourorg.DependencyListExample</recipe>
          </activeRecipes>
        </configuration>
        <dependencies>
          <dependency>
            <groupId>org.openrewrite.recipe</groupId>
            <artifactId>rewrite-java-dependencies</artifactId>
            <version>1.25.0</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>
</project>

Run mvn rewrite:run to run the recipe.

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

shell
mod run . --recipe DependencyList --recipe-option "scope=Compile" --recipe-option "includeTransitive=false"

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