org.gradle.api.tasks.diagnostics
[Groovy] Class DependencyInsightReportTask

java.lang.Object
  org.gradle.api.internal.AbstractTask
      org.gradle.api.DefaultTask
          org.gradle.api.tasks.diagnostics.DependencyInsightReportTask

@Incubating
class DependencyInsightReportTask
extends DefaultTask

Generates a report that attempts to answer questions like:

• Why is this dependency in the dependency graph?
• Exactly which dependencies are pulling this dependency into the graph?
• What is the actual version (i.e. *selected* version) of the dependency that will be used? Is it the same as what was *requested*?
• Why is the *selected* version of a dependency different to the *requested*?

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)

configuration

Configuration configuration

Configuration to look the dependency in

dependencySpec

Spec dependencySpec

Selects the dependency (or dependencies if multiple matches found) to show the report for.

DependencyInsightReportTask

@Inject
DependencyInsightReportTask(StyledTextOutputFactory outputFactory)

report

@TaskAction
void report()

setConfiguration

void setConfiguration(Configuration configuration)

Sets the configuration to look the dependency in.

Parameters:

configuration

setConfiguration

@CommandLineOption(options = "configuration", description = "Looks for the dependency in given configuration.")
void setConfiguration(String configurationName)

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

Parameters:

configurationName

setDependencySpec

void setDependencySpec(Spec dependencySpec)

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.

Parameters:

dependencySpec

setDependencySpec

@CommandLineOption(options = "dependency", description = "Shows the details of given dependency.")
void setDependencySpec(Object dependencyInsightNotation)

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

Parameters:

dependencyInsightNotation

Gradle API 1.3