OutputReport

Translates detekt's result container - Detektion - into an output report which is written inside a file.

Constructors

constructor()

abstract val ending: String

Supported ending of this report type.

open val id: String

Name of the extension.

open val name: String?

Name of the report. Is used to exclude this report in the yaml config.

Is used to run extensions in a specific order. The higher the priority the sooner the extension will run in detekt's lifecycle.

open fun init(config: Config)

Allows to read any or even user defined properties from the detekt yaml config to setup this extension.

open fun init(context: SetupContext)

Setup extension by querying common paths and config options.

abstract fun render(detektion: Detektion): String?

Defines the translation process of detekt's result into a string.

fun write(filePath: Path, detektion: Detektion)

Renders result and writes it to the given filePath.