Gradle 1.12用户指南翻译——第四十一章. 项目报告插件

时间:2023-03-09 22:45:16
Gradle 1.12用户指南翻译——第四十一章. 项目报告插件

本文由CSDN博客万一博主翻译,其他章节的翻译请参见:

http://blog.csdn.net/column/details/gradle-translation.html

翻译项目请关注Github上的地址:

https://github.com/msdx/gradledoc

本文翻译所在分支:

https://github.com/msdx/gradledoc/tree/1.12。

直接浏览双语版的文档请访问:

http://gradledoc.qiniudn.com/1.12/userguide/userguide.html。

另外,Android 手机用户可通过我写的一个程序浏览文档,带缓存功能的,目前0.2.1版本兼容 android 2.2以上系统,地址如下:

http://www.wandoujia.com/apps/com.githang.gradledoc

翻译不易,转载请注明本文在CSDN博客上的出处:

http://blog.csdn.net/maosidiaoxian/article/details/48129155

关于我对Gradle的翻译,以Github上的项目及http://gradledoc.qiniudn.com 上的文档为准。如有发现翻译有误的地方,将首先在以上两个地方更新。因时间精力问题,博客中发表的译文基本不会同步修改。

第四十一章. 项目报告插件

项目报告插件将一些任务添加到项目中,用于生成包含有关构建的有用信息的报告。这些任务生成内容,与由gradle tasks, gradle dependenciesgradle properties触发的命令行报告的内容完全相同(见第 11.6 节,“获取有关您的构建的信息”)。与命令行报告相比,报告插件将报告生成到一个文件中。这里也有一个聚合的任务,它依赖于由该插件添加的所有的报告任务。

我们计划在未来发布的版本中,向现有的报告添加更多的内容,以及创建额外的东西。

41.1. 用法

要使用项目报告插件,请在构建脚本中包含以下语句:

apply plugin: 'project-report'

41.2. 任务

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

表 41.1. 项目报告插件 - 任务

任务名称 依赖于 类型 描述
dependencyReport - DependencyReportTask 生成项目依赖项报告。
htmlDependencyReport - HtmlDependencyReportTask 对项目或项目集生成 HTML 依赖和依赖透视报告。
propertyReport - PropertyReportTask 生成项目属性报告。
taskReport - TaskReportTask 生成项目任务报告。
projectReport dependencyReportpropertyReporttaskReporthtmlDependencyReport Task 生成所有项目报告。

41.3. 项目布局

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

41.4. 依赖管理

项目报告插件没有定义任何的依赖配置。

41.5. 约定属性

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

表 41.2. 项目报告插件 - 约定属性

属性名称 类型 默认值 描述
reportsDirName String reports 相对于build目录的目录名称,报告将生成到此目录。
reportsDir File (read-only) buildDir/reportsDirName 报告将生成到此目录。
projects Set<Project> 一个元素集合,用于保存将要应用该插件的project 要生成报告的projects。
projectReportDirName String project 生成项目报告的目录名称,它是相对于reports目录的相对路径。
projectReportDir File (read-only) reportsDir/projectReportDirName 生成的项目报告的目录。

这些属性由一个ProjectReportsPluginConvention 的约定对象提供。