gradle/org.gradle.api.tasks.diagnostics/DependencyInsightReportTask

DependencyInsightReportTask

@DisableCachingByDefault(because = "Produces only non-cacheable console output")

abstract class DependencyInsightReportTask : DefaultTask(source)

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*?
What variants are available for this dependency?

Use this task to get insight into a particular dependency (or dependencies) and find out what exactly happens during dependency resolution and conflict resolution. If the dependency version was forced or selected by the conflict resolution this information will be available in the report.

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 setDependencySpec and setConfiguration.

The task can also be configured from the command line. For more information please refer to setDependencySpec, setConfiguration, setShowSinglePathToDependency, and getShowingAllVariants.

Constructors

DependencyInsightReportTask

constructor()

Properties

@get:Nullable

open var configuration: Configuration

@get:Nullable

open var dependencySpec: Spec<DependencyResult>

open var description: String

open var enabled: Boolean

val ExtensionAware.extra: ExtraPropertiesExtension

The extra properties extension in this object's extension container.

open var group: String

impliesSubProjects

open var impliesSubProjects: Boolean

rootComponentProperty

@get:Input

@get:Incubating

val rootComponentProperty: Property<ResolvedComponentResult>

showingAllVariants

@get:Incubating

val showingAllVariants: Property<Boolean>

val state: TaskStateInternal

val TASK_ACTION: String = "action"

TASK_CONSTRUCTOR_ARGS

val TASK_CONSTRUCTOR_ARGS: String = "constructorArgs"

TASK_DEPENDS_ON

val TASK_DEPENDS_ON: String = "dependsOn"

TASK_DESCRIPTION

val TASK_DESCRIPTION: String = "description"

val TASK_GROUP: String = "group"

val TASK_NAME: String = "name"

val TASK_OVERWRITE: String = "overwrite"

val TASK_TYPE: String = "type"

val timeout: Property<Duration>

Functions

acceptServiceReferences

open fun acceptServiceReferences(serviceReferences: Set<ServiceReferenceSpec>)

appendParallelSafeAction

open fun appendParallelSafeAction(action: Action<in Task>)

open fun compareTo(otherTask: Task): Int

open fun configure(closure: Closure): Task

abstract fun configure(cl: Closure): T

inline fun <T : Any> ExtensionAware.configure(noinline configuration: T.() -> Unit)

Executes the given configuration block against the extension of the specified type.

open fun dependsOn(paths: Array<Any>): Task

open fun doFirst(action: Action<in Task>): Task

open fun doLast(action: Action<in Task>): Task

doNotTrackState

open fun doNotTrackState(reasonNotToTrackState: String)

open fun finalizedBy(paths: Array<Any>): Task

open fun getActions(): List<Action<in Task>>

open fun getAnt(): AntBuilder

getAsDynamicObject

open fun getAsDynamicObject(): DynamicObject

open fun getConvention(): Convention

open fun getDependsOn(): Set<Any>

getDestroyables

open fun getDestroyables(): TaskDestroyables

open fun getDidWork(): Boolean

open fun getExtensions(): ExtensionContainer

open fun getFinalizedBy(): TaskDependency

getIdentityPath

open fun getIdentityPath(): Path

open fun getInputs(): TaskInputsInternal

abstract fun getInputs(): TaskInputs

getLifecycleDependencies

open fun getLifecycleDependencies(): TaskDependencyInternal

abstract fun getLifecycleDependencies(): TaskDependency

open fun getLocalState(): TaskLocalState

open fun getLogger(): Logger

open fun getLogging(): LoggingManager

getMustRunAfter

open fun getMustRunAfter(): TaskDependency

open fun getName(): String

open fun getOnlyIf(): Spec<in TaskInternal>

open fun getOutputs(): TaskOutputsInternal

abstract fun getOutputs(): TaskOutputs

open fun getPath(): String

open fun getProject(): Project

getReasonNotToTrackState

open fun getReasonNotToTrackState(): Optional<String>

getReasonTaskIsIncompatibleWithConfigurationCache

open fun getReasonTaskIsIncompatibleWithConfigurationCache(): Optional<String>

getRequiredServices

open fun getRequiredServices(): TaskRequiredServices

getSharedResources

open fun getSharedResources(): List<ResourceLock>

abstract fun getSharedResources(): List<out ResourceLock>

getShouldRunAfter

open fun getShouldRunAfter(): TaskDependency

getStandardOutputCapture

open fun getStandardOutputCapture(): StandardOutputCapture

abstract fun getState(): TaskState

open fun getTaskActions(): List<InputChangesAwareTaskAction>

getTaskDependencies

open fun getTaskDependencies(): TaskDependencyInternal

abstract fun getTaskDependencies(): TaskDependency

getTaskIdentity

open fun getTaskIdentity(): TaskIdentity<out Any>

getTemporaryDir

open fun getTemporaryDir(): File

getTemporaryDirFactory

open fun getTemporaryDirFactory(): Factory<File>

open fun hasProperty(propertyName: String): Boolean

open fun hasTaskActions(): Boolean

injectIntoNewInstance

open fun <T : Task?> injectIntoNewInstance(project: ProjectInternal, identity: TaskIdentity<T>, factory: Callable<T>): T

isCompatibleWithConfigurationCache

open fun isCompatibleWithConfigurationCache(): Boolean

open fun isEnabled(): Boolean

isHasCustomActions

open fun isHasCustomActions(): Boolean

isShowSinglePathToDependency

open fun isShowSinglePathToDependency(): Boolean

Tells if the report should only show one path to each dependency.

open fun mustRunAfter(paths: Array<Any>): Task

notCompatibleWithConfigurationCache

open fun notCompatibleWithConfigurationCache(reason: String)

open fun onlyIf(spec: Spec<in Task>)

prependParallelSafeAction

open fun prependParallelSafeAction(action: Action<in Task>)

open fun property(propertyName: String): Any

open fun report()

open fun setActions(replacements: List<Action<in Task>>)

setConfiguration

open fun setConfiguration(@Nullable configurationName: String)

Sets the configuration (via name) to look the dependency in.

setDependencySpec

open fun setDependencySpec(@Nullable dependencyInsightNotation: Any)

Configures the dependency to show the report for.

open fun setDependsOn(dependsOn: Iterable<out Any>)

open fun setDidWork(didWork: Boolean)

open fun setFinalizedBy(finalizedByTasks: Iterable<out Any>)

setMustRunAfter

open fun setMustRunAfter(mustRunAfterTasks: Iterable<out Any>)

open fun setOnlyIf(spec: Spec<in Task>)

open fun setProperty(name: String, value: Any)

setShouldRunAfter

open fun setShouldRunAfter(shouldRunAfterTasks: Iterable<out Any>)

setShowSinglePathToDependency

open fun setShowSinglePathToDependency(showSinglePathToDependency: Boolean)

Tells if the report should only display a single path to each dependency, which can be useful when the graph is large.

open fun shouldRunAfter(paths: Array<Any>): TaskDependency

inline fun <T : Any> ExtensionAware.the(): T

Returns the extension of the specified type.

fun <T : Any> ExtensionAware.the(extensionType: KClass<T>): T

Returns the extension of the specified extensionType.

open fun usesService(service: Provider<out BuildService<out Any>>)