OutputReport

abstract class OutputReport : Extension

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

Constructors

Link copied to clipboard
constructor()

Functions

Link copied to clipboard
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.

Link copied to clipboard
abstract fun render(detektion: Detektion): String?

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

Link copied to clipboard
fun write(filePath: Path, detektion: Detektion)

Renders result and writes it to the given filePath.

Properties

Link copied to clipboard
abstract val ending: String

Supported ending of this report type.

Link copied to clipboard
open val id: String

Name of the extension.

Link copied to clipboard
open val name: String?

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

Link copied to clipboard
open val priority: Int

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