Dependency report
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
groupId: org.openrewrite.recipe
artifactId: rewrite-java-dependencies
version: 1.13.0
Options
Type | Name | Description | Example |
---|---|---|---|
| scope | The scope of the dependencies to include in the report. Valid options: |
|
| includeTransitive | Whether or not to include transitive dependencies in the report. Defaults to including only direct dependencies. |
|
Data Tables
Dependency report
org.openrewrite.java.dependencies.table.DependencyListReport
Lists all Gradle and Maven dependencies
Column Name | 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 |
Source files that had results
org.openrewrite.table.SourcesFileResults
Source files that were modified by the recipe run.
Column Name | Description |
---|---|
Source path before the run | The source path of the file before the run. |
Source path after the run | A recipe may modify the source path. This is the path after 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 errored on a recipe
org.openrewrite.table.SourcesFileErrors
The details of all errors produced by a recipe run.
Column Name | 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 Name | 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 | The total time spent across the scanning phase of this recipe. |
99th percentile scanning time | 99 out of 100 scans completed in this amount of time. |
Max scanning time | The max time scanning any one source file. |
Cumulative edit time | The total time spent across the editing phase of this recipe. |
99th percentile edit time | 99 out of 100 edits completed in this amount of time. |
Max edit time | The max time editing any one source file. |
Usage
This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly. 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:
Now that com.yourorg.DependencyListExample
has been defined activate it and take a dependency on org.openrewrite.recipe:rewrite-java-dependencies:1.13.0 in your build file:
Add the following to your
build.gradle
file:
Run
gradle rewriteRun
to run the recipe.
See how this recipe works across multiple open-source repositories
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.
Contributors
Last updated