detekt-api/io.gitlab.arturbosch.detekt.api.internal/DefaultRuleSetProvider

DefaultRuleSetProvider

interface DefaultRuleSetProvider : RuleSetProvider

Interface which marks sub-classes as provided by detekt via the rules sub-module.

Allows to implement "--disable-default-rulesets" effectively without the need to manage a list of rule set names.

Properties

Link copied to clipboard
abstract val ruleSetId: String

Every rule set must be pre-configured with an ID to validate if this rule set must be created for current analysis.

Functions

Link copied to clipboard
abstract fun instance(config: Config): RuleSet

This function must be implemented to provide custom rule sets. Make sure to pass the configuration to each rule to allow rules to be self configurable.