專案報告外掛程式會在專案中新增一些工作,用來產生包含組建相關有用資訊的報告。這些工作會產生與從命令列執行 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)。