项目报告插件向您的项目添加一些任务,这些任务生成包含有关您构建的有用信息的报告。这些任务生成的内容与您从命令行执行 tasksdependenciesproperties 任务获得的内容相同(请参阅 命令行项目报告)。与命令行报告相比,报告插件将报告生成到文件中。还有一个聚合任务,它依赖于插件添加的所有报告任务。

我们计划在 Gradle 的未来版本中为现有报告添加更多内容并创建其他报告。

用法

要使用项目报告插件,请在您的构建脚本中包含以下内容

plugins {
    id 'project-report'
}

任务

项目报告插件定义了以下任务

dependencyReportDependencyReportTask

生成项目依赖报告。

htmlDependencyReportHtmlDependencyReportTask

为项目或一组项目生成 HTML 依赖和依赖洞察报告。

propertyReportPropertyReportTask

生成项目属性报告。

taskReportTaskReportTask

生成项目任务报告。

projectReportTask

依赖于dependencyReportpropertyReporttaskReporthtmlDependencyReport

生成所有项目报告。

项目布局

项目报告插件不要求任何特定的项目布局。

依赖管理

项目报告插件未定义任何依赖配置。

约定属性

项目报告定义了以下约定属性

projectsSet<Project>

要为其生成报告的项目。默认值:一个包含插件应用到的项目的单元素集合。

projectReportDirNameString

用于生成项目报告的目录名称,相对于报告目录。默认值"project"

projectReportDirFile (只读)

用于生成项目报告的目录。默认值reportsDir/projectReportDirName

reportsDirNameString

用于生成项目报告的目录名称,相对于报告目录。默认值"reports"

reportsDirFile (只读)

用于生成项目报告的目录。默认值buildDir/reportsDirName

这些约定属性由 ProjectReportsPluginConvention 类型的约定对象提供。

通过插件的约定属性配置项目报告任务已弃用。如果您需要更改默认值,请直接配置相应的任务。如果您想配置项目中所有相同类型的报告任务,请使用 tasks.withType(…​).configureEach(…​)(例如,类型可以是 HtmlDependencyReportTask)。