第41章 プロジェクトレポートプラグイン

The Project report plugin adds some tasks to your project which generate reports containing useful information about your build. These tasks generate the same content that you get by executing the tasks, dependencies, and properties tasks from the command line (see 「ビルドに関する情報を取得するObtaining information about your build). In contrast to the command line reports, the report plugin generates the reports into a file. There is also an aggregating task that depends on all report tasks added by the plugin.

プロジェクトレポートプラグインは、ビルドに関する有益な情報を含むレポートを生成するタスクをプロジェクトに追加します。 これらのタスクは、gradle tasksgradle dependencies およびgradle propertiesによるコマンドラインレポートとまったく同じ内容を生成します (「ビルドに関する情報を取得するObtaining information about your buildを参照)。 コマンドラインレポートとは対照的に、レポートプラグインはレポートをファイルに出力します。 プラグインによって追加されたすべてのレポートタスクに依存する集約タスクもあります。

We plan to add much more to the existing reports and create additional ones in future releases of Gradle.

Gradleの将来のリリースではもっと多くの情報をレポートに追加する予定です。

41.1. 使用法 Usage

To use the Project report plugin, include the following in your build script:

プロジェクトレポートプラグインを使うには、ビルドスクリプトに以下を含めます:

apply plugin: 'project-report'

41.2. タスク Tasks

The project report plugin defines the following tasks:

プロジェクトレポートプラグインは以下のタスクを定義しています:

表41.1 プロジェクトレポートプラグイン - タスク Project report plugin - tasks

タスク名 Task name 依存先 Depends on タイプ Type 説明 Description
dependencyReport - DependencyReportTask プロジェクト依存関係レポートを生成します。Generates the project dependency report.
htmlDependencyReport - HtmlDependencyReportTask Generates an HTML dependency and dependency insight report for the project or a set of projects.
propertyReport - PropertyReportTask プロジェクトプロパティレポートを生成します。Generates the project property report.
taskReport - TaskReportTask プロジェクトタスクレポートを生成します。Generates the project task report.
projectReport dependencyReport, propertyReport, taskReport, htmlDependencyReport Task すべてのプロジェクトレポートを生成します。Generates all project reports.

41.3. プロジェクトレイアウト Project layout

The project report plugin does not require any particular project layout.

プロジェクトレポートプラグインは特定のプロジェクトレイアウトを要求しません。

41.4. 依存関係 Dependency management

The project report plugin does not define any dependency configurations.

プロジェクトレポートプラグインはいかなる依存関係コンフィグレーションも定義しません。

41.5. 規約プロパティ Convention properties

The project report defines the following convention properties:

プロジェクトレポートプラグインは以下の規約プロパティを定義します:

表41.2 プロジェクトレポートプラグイン - 規約プロパティ Project report plugin - convention properties

プロパティ名 Property name タイプ Type デフォルト値 Default value 説明 Description
reportsDirName String reports レポートを生成するディレクトリ名。ビルドディレクトリへの相対パス The name of the directory to generate reports into, relative to the build directory.
reportsDir File (read-only) buildDir/reportsDirName レポートを生成するディレクトリ The directory to generate reports into.
projects Set<Project> プラグイン適用先プロジェクトからなる1要素のSet A one element set with the project the plugin was applied to. レポート生成対象のプロジェクト The projects to generate the reports for.
projectReportDirName String project プロジェクトレポート生成先ディレクトリ名、reportsディレクトリからの相対パス The name of the directory to generate the project report into, relative to the reports directory.
projectReportDir File (read-only) reportsDir/projectReportDirName プロジェクトレポート生成先ディレクトリ The directory to generate the project report into.

These convention properties are provided by a convention object of type ProjectReportsPluginConvention.

規約プロパティは ProjectReportsPluginConvention 型の規約オブジェクトによって提供されます。