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)#setDependencySpec(Object) and DependencyInsightReportTask#setConfiguration(String)#setConfiguration(String).
The task can also be configured from the command line. For more information please refer to DependencyInsightReportTask#setDependencySpec(Object)#setDependencySpec(Object) and DependencyInsightReportTask#setConfiguration(String)#setConfiguration(String)
Type | Name and description |
---|---|
Configuration |
configuration Configuration to look the dependency in |
Spec<DependencyResult> |
dependencySpec Selects the dependency (or dependencies if multiple matches found) to show the report for. |
Type | Name and description |
---|---|
protected StyledTextOutputFactory |
getTextOutputFactory() |
protected VersionMatcher |
getVersionMatcher() |
void |
report() |
void |
setConfiguration(Configuration configuration) Sets the configuration to look the dependency in. |
void |
setConfiguration(String configurationName) Sets the configuration (via name) to look the dependency in. |
void |
setDependencySpec(Spec<DependencyResult> dependencySpec) The dependency spec selects the dependency (or dependencies if multiple matches found) to show the report for. |
void |
setDependencySpec(Object dependencyInsightNotation) Configures the dependency to show the report for. |
Configuration to look the dependency in
Selects the dependency (or dependencies if multiple matches found) to show the report for.
Sets the configuration to look the dependency in.
Sets the configuration (via name) to look the dependency in.
This method is exposed to the command line interface. Example usage:
gradle dependencyInsight --configuration runtime --dependency slf4j
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.
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 DependencyInsightReportTask#setDependencySpec(Spec)#setDependencySpec(Spec)
This method is exposed to the command line interface. Example usage:
gradle dependencyInsight --dependency slf4j