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

RuleSetProvider

interface RuleSetProvider

A rule set provider, as the name states, is responsible for creating rule sets.

When writing own rule set providers make sure to register them according the ServiceLoader documentation. http://docs.oracle.com/javase/8/docs/api/java/util/ServiceLoader.html

Inheritors

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.

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.