Глава 29. Плагин отчета о проекте.

Плагин отчета о проекте добавляет несколько задач к вашему проекту, которые генерируют отчеты, содержащие полезную информацию о вашей сборке. Эти задачи выдают ту же самую информацию, которую вы можете получить, выполнив tasks, dependencies, и properties из командной строки (смотрите Секцию 4.7 Получение информации о вашей сборке). В отличие от отчетов командной строки, этот плагин сохраняет отчеты в файл. Также есть совокупная задачи, которая зависит от всех отчетных задач, добавленных плагином.

Мы планируем добавить больше информации к существующим и создать дополнительные отчеты в будущих выпусках Gradle.

29.1. Использование.

Чтобы использовать плагин отчета о проекте, добавьте следующую строчку в ваш сборочный скрипт:

apply plugin: 'project-report'
	  

29.2. Задачи.

Плагин отчета о проекте определяет следующие задачи:

Таблица 29.1. Плагин отчета о проекте - задачи
Имя задачиЗависит отТипОписание
dependencyReport-DependencyReportTaskГенерирует отчет о зависимостях в проекте.
htmlDependencyReport-HtmlDependencyReportTaskГенерирует HTML-зависимости и понимание зависимостей отчет для проекта или набора проектов.
propertyReport-PropertyReportTaskГенерирует отчет о свойствах проекта.
taskReport-TaskReportTaskГенерирует очет о задачах проекта.
projectReportdependencyReport, propertyReport, taskReport, htmlDependencyReportTaskГенерирует все отчеты проекта.

29.3. Разметка проекта.

Для плагина отчета о проекте не требуется никакой специальной разметки проекта.

29.4. Управление зависимостями.

Плагин отчет о проекте не определяет никакие конфигурации зависимостей.

29.5. Условные свойства.

Плагин отчета о проекте определяет следующие условные свойства:

Таблица 29.2. Плагин отчета о проекте - условные свойства
Имя свойстваТипЗначение по умолчаниюОписание
reportsDirNameStringreportsИмя папки, относительно папки сборки, куда будут сохранены сгенерированные отчеты.
reportsDirFile (только для чтения)buildDir/reportsDirNameПапка, куда будут сохранены сгенерированные отчеты.
projectsSet<Project>Множество с одним элементом, содержащее проект, к которому был применен плагин.Проект, для которого будут сгенерированы отчеты
projectReportDirNameStringprojectИмя папки, относительно папки отчетов, куда будет сгенерирован отчет о проекте.
projectReportDirFile (только для чтения)reportsDir/projectReportDirNameПапка, куда будет сохранен сгенерированный отчет о проекте.

Эти условные свойства предоставляются условным объектом типа ProjectReportsPluginConvention.