api / org.gradle.api.reporting.dependencies / HtmlDependencyReportTask

HtmlDependencyReportTask

@Incubating open class HtmlDependencyReportTask : ConventionTask, Reporting<DependencyReportContainer>

Generates an HTML dependency report. This report combines the features of the ASCII dependency report and those of the ASCII dependency insight report. For a given project, it generates a tree of the dependencies of every configuration, and each dependency can be clicked to show the insight of this dependency.

This task generates a report for the task's containing project by default. But it can also generate a report for multiple projects, by setting the value of the projects property. Here's how to generate an HTML dependency report for all the projects of a multi-project build, for example:

 htmlDependencyReport { projects = project.allprojects } 

The report is generated in the build/reports/project/dependencies directory by default. This can also be changed by setting the reports.html.destination property:

 htmlDependencyReport { reports.html.destination = file("build/reports/project/dependencies") } 

Constructors

<init>

HtmlDependencyReportTask()

Functions

generate

open fun generate(): Unit

getObjectFactory

open fun getObjectFactory(): ObjectFactory

Injects and returns an instance of org.gradle.api.model.ObjectFactory.

getProjects

open fun getProjects(): MutableSet<Project>

Returns the set of projects to generate a report for. By default, the report is generated for the task's containing project.

getReports

open fun getReports(): DependencyReportContainer

reports

open fun reports(closure: Closure<Any>): DependencyReportContainer
open fun reports(configureAction: Action<in DependencyReportContainer>): DependencyReportContainer

setProjects

open fun setProjects(projects: MutableSet<Project>): Unit

Specifies the set of projects to generate this report for.