專案報告外掛程式會為您的專案新增一些任務,這些任務會產生包含關於您建置的實用資訊的報告。 這些任務會產生與您從命令列執行 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,例如)。