open class DependencyInsightReportTask : DefaultTask
Generates a report that attempts to answer questions like:
While the regular dependencies report (DependencyReportTask) shows the path from the top level dependencies down through the transitive dependencies, the dependency insight report shows the path from a particular dependency to the dependencies that pulled it in. That is, it is an inverted view of the regular dependencies report.
The task requires setting the dependency spec and the configuration. For more information on how to configure those please refer to docs for DependencyInsightReportTask#setDependencySpec(Object)
and DependencyInsightReportTask#setConfiguration(String)
.
The task can also be configured from the command line. For more information please refer to DependencyInsightReportTask#setDependencySpec(Object)
and DependencyInsightReportTask#setConfiguration(String)
DependencyInsightReportTask()
Generates a report that attempts to answer questions like:
While the regular dependencies report (DependencyReportTask) shows the path from the top level dependencies down through the transitive dependencies, the dependency insight report shows the path from a particular dependency to the dependencies that pulled it in. That is, it is an inverted view of the regular dependencies report. The task requires setting the dependency spec and the configuration. For more information on how to configure those please refer to docs for The task can also be configured from the command line. For more information please refer to |
open fun getConfiguration(): Configuration
Configuration to look the dependency in |
|
open fun getDependencySpec(): Spec<DependencyResult>
Selects the dependency (or dependencies if multiple matches found) to show the report for. |
|
open fun isShowSinglePathToDependency(): Boolean
Tells if the report should only show one path to each dependency. |
|
open fun report(): Unit |
|
open fun setConfiguration(configuration: Configuration): Unit
Sets the configuration to look the dependency in. open fun setConfiguration(configurationName: String): Unit
Sets the configuration (via name) to look the dependency in. This method is exposed to the command line interface. Example usage:
|
|
open fun setDependencySpec(dependencySpec: Spec<DependencyResult>): Unit
The dependency spec selects the dependency (or dependencies if multiple matches found) to show the report for. The spec receives an instance of DependencyResult as parameter. open fun setDependencySpec(dependencyInsightNotation: Any): Unit
Configures the dependency to show the report for. Multiple notation formats are supported: Strings, instances of Spec and groovy closures. Spec and closure receive DependencyResult as parameter. Examples of String notation: 'org.slf4j:slf4j-api', 'slf4j-api', or simply: 'slf4j'. The input may potentially match multiple dependencies. See also This method is exposed to the command line interface. Example usage:
|
|
open fun setShowSinglePathToDependency(showSinglePathToDependency: Boolean): Unit
Tells if the report should only display a single path to each dependency, which can be useful when the graph is large. This is false by default, meaning that for each dependency, the report will display all paths leading to it. |