Package-level declarations

Types

Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.CLASS])
annotation class ActiveByDefault(val since: String)
Link copied to clipboard
Link copied to clipboard
class CommaSeparatedPattern(text: String, delimiters: String = ",") : SplitPattern
Link copied to clipboard
data class CompilerResources(val languageVersionSettings: LanguageVersionSettings, val dataFlowValueFactory: DataFlowValueFactory)

Provides compiler resources.

Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.PROPERTY])
annotation class Configuration(val description: String)

Annotate the target to specify a configuration for io.gitlab.arturbosch.detekt.api.Rule or io.gitlab.arturbosch.detekt.api.RuleSetProvider.

Link copied to clipboard

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

Link copied to clipboard

Path filters to explicitly include and/or exclude paths for rules.

Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.CLASS])
annotation class RequiresTypeResolution

Annotated io.gitlab.arturbosch.detekt.api.Rule requires type resolution to work.

Link copied to clipboard
class RuleSetConfigProperty<T : Any>(val key: String, val defaultValue: T)
Link copied to clipboard
data class SimpleNotification(val message: String, val level: Notification.Level = Notification.Level.Error) : Notification

Functions

Link copied to clipboard
Link copied to clipboard
fun KtAnnotated.isSuppressedBy(id: RuleId, aliases: Set<String>, ruleSetId: RuleSetId? = null): Boolean

Checks if this kt element is suppressed by @Suppress or @SuppressWarnings annotations.

fun KtElement.isSuppressedBy(id: String, aliases: Set<String>, ruleSetId: RuleSetId? = null): Boolean

Checks if this psi element is suppressed by @Suppress or @SuppressWarnings annotations. If this element cannot have annotations, the first annotative parent is searched.

Link copied to clipboard

Converts given pattern into a PathMatcher specified by FileSystem.getPathMatcher. We only support the "glob:" syntax to stay os independently. Internally a globbing pattern is transformed to a regex respecting the Windows file system.

Link copied to clipboard
Link copied to clipboard

Returns the bundled detekt version.

Link copied to clipboard

Returns the version of the running JVM.

Link copied to clipboard

Returns the name of the running OS.