ReportingExtension

abstract class ReportingExtension(source)

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

Example usage:

reporting {
    baseDir "$buildDir/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

Link copied to clipboard
@Inject
constructor(project: Project)

Properties

Link copied to clipboard
Link copied to clipboard
The default name of the base directory for all reports, relative to getBuildDir ({@value}).
Link copied to clipboard
val NAME: String = "reporting"
The name of this extension ("{@value}")

Functions

Link copied to clipboard
open fun file(path: String): File
Creates a file object for the given path, relative to getBaseDir.
Link copied to clipboard
Link copied to clipboard
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.
Link copied to clipboard
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.