detekt-api/io.gitlab.arturbosch.detekt.api/SetupContext

SetupContext

interface SetupContext : PropertiesAware

Context providing useful processing settings to initialize extensions.

Properties

Link copied to clipboard
abstract val basePath: Path
Link copied to clipboard
abstract val config: Config

Configuration which is used to set up detekt.

Link copied to clipboard
abstract val configUris: Collection<URI>

All config locations which where used to create config.

Link copied to clipboard
abstract val errorChannel: Appendable

The channel to log all the errors.

Link copied to clipboard
abstract val outputChannel: Appendable

The channel to log all the output.

Link copied to clipboard
abstract val properties: Map<String, Any?>

Raw properties.

Functions

Link copied to clipboard
inline fun <T : Any> PropertiesAware.getOrNull(key: String): T?

Allows to retrieve stored properties in a type safe way.

Link copied to clipboard
abstract fun register(key: String, value: Any)

Binds a given value with given key and stores it for later use.