ReportingExtension

Allows to intercept detekt's result container by listening to the initial and final state and manipulate the reported findings.

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
open fun onFinalResult(result: Detektion)

Is called after all extensions's transformFindings were called.

Link copied to clipboard
open fun onRawResult(result: Detektion)

Is called before any transformFindings calls were executed.

Link copied to clipboard

Allows to transform the reported findings e.g. apply custom filtering.

Properties

Link copied to clipboard
open val id: String

Name of the extension.

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.