Open source

Dependency report

Recipe IDorg.openrewrite.java.dependencies.DependencyList

Artifactorg.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 recipeJavaApache License Version 2.0

Options

3 parameters

3 optional

Parameter	Example	Type	Required
`includeTransitive`	`true`	boolean	Optional
Whether or not to include transitive dependencies in the report. Defaults to including only direct dependencies.Defaults to false.
`scope`	`Compile`	Scope	Optional
The scope of the dependencies to include in the report.Defaults to "Compile"
`validateResolvable`	`true`	boolean	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.

Run this recipe

This recipe has no required configuration options. Users of Moderne can run it via the Moderne CLI.

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

Dependency report

org.openrewrite.java.dependencies.table.DependencyListReport

Lists all Gradle and Maven dependencies

Column	Description
Build tool	The build tool used to manage dependencies (Gradle or Maven).
Group id	The Group ID of the Gradle project or Maven module requesting the dependency.
Artifact id	The Artifact ID of the Gradle project or Maven module requesting the dependency.
Version	The version of Gradle project or Maven module requesting the dependency.
Dependency group id	The Group ID of the dependency.
Dependency artifact id	The Artifact ID of the dependency.
Dependency version	The version of the dependency.
Direct Dependency	When `true` the project directly depends on the dependency. When `false` the project depends on the dependency transitively through at least one direct dependency.
Resolution failure	The reason why the dependency could not be resolved. Blank when resolution was not attempted.

Maven metadata failures

org.openrewrite.maven.table.MavenMetadataFailures

Attempts to resolve maven metadata that failed.

Column	Description
Group id	The groupId of the artifact for which the metadata download failed.
Artifact id	The artifactId of the artifact for which the metadata download failed.
Version	The version of the artifact for which the metadata download failed.
Maven repository	The URL of the Maven repository that the metadata download failed on.
Snapshots	Does the repository support snapshots.
Releases	Does the repository support releases.
Failure	The reason the metadata download failed.

Source files that had results

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column	Description
Source path before the run	The source path of the file before the run. `null` when a source file was created during the run.
Source path after the run	A recipe may modify the source path. This is the path after the run. `null` when a source file was deleted during the run.
Parent of the recipe that made changes	In a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changes	The specific recipe that made a change.
Estimated time saving	An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
Cycle	The recipe cycle in which the change was made.

Source files that had search results

org.openrewrite.table.SearchResults

Search results that were found during the recipe run.

Column	Description
Source path of search result before the run	The source path of the file with the search result markers present.
Source path of search result after run the run	A recipe may modify the source path. This is the path after the run. `null` when a source file was deleted during the run.
Result	The trimmed printed tree of the LST element that the marker is attached to.
Description	The content of the description of the marker.
Recipe that added the search marker	The specific recipe that added the Search marker.

Source files that errored on a recipe

org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

Column	Description
Source path	The file that failed to parse.
Recipe that made changes	The specific recipe that made a change.
Stack trace	The stack trace of the failure.

Recipe performance

org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

Column	Description
The recipe	The recipe whose stats are being measured both individually and cumulatively.
Source file count	The number of source files the recipe ran over.
Source file changed count	The number of source files which were changed in the recipe run. Includes files created, deleted, and edited.
Cumulative scanning time (ns)	The total time spent across the scanning phase of this recipe.
Max scanning time (ns)	The max time scanning any one source file.
Cumulative edit time (ns)	The total time spent across the editing phase of this recipe.
Max edit time (ns)	The max time editing any one source file.