detekt-tooling/io.github.detekt.tooling.api.spec/RulesSpec

RulesSpec

interface RulesSpec

Types

Link copied to clipboard
sealed class FailurePolicy

Policy to decide if detekt throws an error.

Link copied to clipboard
sealed class RunPolicy

Restrict rules to use for current analysis.

Properties

Link copied to clipboard
abstract val activateAllRules: Boolean

Activates all rules which do not have the active property set to 'true' by default.

Link copied to clipboard
abstract val autoCorrect: Boolean

Should detekt create mutable ASTs which io.gitlab.arturbosch.detekt.api.Rules can manipulate?

Link copied to clipboard
abstract val excludeCorrectable: Boolean

Issues which were corrected should not be taken into account for calculating the max issue threshold.

Link copied to clipboard
abstract val failurePolicy: RulesSpec.FailurePolicy

Sets the policy to handle issues found during the analysis.

Link copied to clipboard
abstract val runPolicy: RulesSpec.RunPolicy

Allows to programmatically restrict the execution of certain rules.