ReportingExtension

A project extension named "reporting" that provides basic reporting settings and utilities.

Example usage:

reporting {
    baseDirectory = layout.buildDirectory.dir("our-reports")
}

When implementing a task that produces reports, the location of where to generate reports should be obtained via the file method of this extension.

Constructors

@Inject

constructor(project: Project)

The default name of the base directory for all reports, relative to getBuildDirectory ({@value}).

val NAME: String = "reporting"

The name of this extension ("{@value}")

open fun file(path: String): File

Creates a file object for the given path, relative to getBaseDir.

open fun ~~getBaseDir~~(): File

The base directory for all reports This value can be changed, so any files derived from this should be calculated on demand.

open fun ~~setBaseDir~~(baseDir: File)

Sets the base directory to use for all reports

open fun ~~setBaseDir~~(baseDir: Any)

Sets the base directory to use for all reports The value will be converted to a File on demand via file.