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

Package-level declarations

Types

ActiveByDefault

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class ActiveByDefault(val since: String)

Annotated io.gitlab.arturbosch.detekt.api.Rule or io.gitlab.arturbosch.detekt.api.RuleSetProvider is active by default.

AutoCorrectable

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class AutoCorrectable(val since: String)

Annotated io.gitlab.arturbosch.detekt.api.Rule or io.gitlab.arturbosch.detekt.api.RuleSetProvider is auto-correctable.

CommaSeparatedPattern

class CommaSeparatedPattern(text: String, delimiters: String = ",") : SplitPattern

CompilerResources

data class CompilerResources(val languageVersionSettings: LanguageVersionSettings, val dataFlowValueFactory: DataFlowValueFactory)

Provides compiler resources.

Configuration

@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.

DefaultRuleSetProvider

interface DefaultRuleSetProvider : RuleSetProvider

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

PathFilters

class PathFilters

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

RequiresTypeResolution

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class RequiresTypeResolution

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

RuleSetConfigProperty

class RuleSetConfigProperty<T : Any>(val key: String, val defaultValue: T)

SimpleNotification

data class SimpleNotification(val message: String, val level: Notification.Level = Notification.Level.Error) : Notification

Functions

createPathFilters

fun Config.createPathFilters(): PathFilters?

isSuppressedBy

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.

pathMatcher

fun pathMatcher(pattern: String): PathMatcher

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.

ruleSetConfig

fun <T : Any> ruleSetConfig(defaultValue: T): ReadOnlyProperty<Any?, RuleSetConfigProperty<T>>

valueOrDefaultCommaSeparated

fun Config.valueOrDefaultCommaSeparated(key: String, default: List<String>): List<String>

whichDetekt

fun whichDetekt(): String

Returns the bundled detekt version.

whichJava

fun whichJava(): String

Returns the version of the running JVM.

whichKotlin

fun whichKotlin(): String

Returns the version of Kotlin that detekt was compiled with

whichOS

fun whichOS(): String

Returns the name of the running OS.