项目报告插件向你的项目添加了一些任务，这些任务生成包含有关构建的有用信息的报告。这些任务生成的内容与你通过命令行执行 tasks、dependencies 和 properties 任务获得的内容相同（参见命令行项目报告）。与命令行报告不同，报告插件将报告生成到文件中。还有一个聚合任务，它依赖于插件添加的所有报告任务。

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

用法

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

plugins {
    id 'project-report'
}

任务

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

dependencyReport — DependencyReportTask

生成项目依赖报告。

htmlDependencyReport — HtmlDependencyReportTask

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

propertyReport — PropertyReportTask

生成项目属性报告。

taskReport — TaskReportTask

生成项目任务报告。

projectReport — Task

依赖于: dependencyReport, propertyReport, taskReport, htmlDependencyReport

生成所有项目报告。

项目布局

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

依赖管理

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

约定属性

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

projects — Set<Project>

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

projectReportDirName — String

生成项目报告的目标目录名称，相对于报告目录。默认值: "project"。

projectReportDir — File (read-only)

生成项目报告的目标目录。默认值: reportsDir/projectReportDirName。

reportsDirName — String

生成项目报告的目标目录名称，相对于报告目录。默认值: "reports"。

reportsDir — File (read-only)

生成项目报告的目标目录。默认值: buildDir/reportsDirName。

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

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