# io.gitlab.arturbosch.detekt.api.internal

detekt-api
1.21.0-RC2

# Package io.gitlab.arturbosch.detekt.api.internal

## Types

ActiveByDefault
Link copied to clipboard
@ Target (allowedTargets = [ AnnotationTarget.CLASS ])
annotation class ActiveByDefault (val since: String )
Content copied to clipboard

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

AutoCorrectable
Link copied to clipboard
@ Target (allowedTargets = [ AnnotationTarget.CLASS ])
annotation class AutoCorrectable (val since: String )
Content copied to clipboard

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

CommaSeparatedPattern
Link copied to clipboard
class CommaSeparatedPattern (text: String , delimiters: String = ",") : SplitPattern
Content copied to clipboard
CompilerResources
Link copied to clipboard
data class CompilerResources (val languageVersionSettings: LanguageVersionSettings, val dataFlowValueFactory: DataFlowValueFactory)
Content copied to clipboard

Provides compiler resources.

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

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

DefaultRuleSetProvider
Link copied to clipboard
interface DefaultRuleSetProvider : RuleSetProvider
Content copied to clipboard

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

PathFilters
Link copied to clipboard
class PathFilters
Content copied to clipboard

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

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

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

RuleSetConfigProperty
Link copied to clipboard
class RuleSetConfigProperty < T : Any >(val key: String , val defaultValue: T )
Content copied to clipboard
SimpleGlob
Link copied to clipboard
class SimpleGlob
Content copied to clipboard

This simple globbing implementation allows users to define patterns with `?` (any single character) and `*` (zero or more characters) wildcards.

SimpleNotification
Link copied to clipboard
data class SimpleNotification (val message: String , val level: Notification.Level = Notification.Level.Error) : Notification
Content copied to clipboard

## Functions

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

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

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

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
Link copied to clipboard
fun pathMatcher (pattern: String ): PathMatcher
Content 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.

ruleSetConfig
Link copied to clipboard
fun < T : Any > ruleSetConfig (defaultValue: T ): ReadOnlyProperty < Any ?, RuleSetConfigProperty < T >>
Content copied to clipboard
valueOrDefaultCommaSeparated
Link copied to clipboard
fun Config . valueOrDefaultCommaSeparated (key: String , default: List < String >): List < String >
Content copied to clipboard
whichDetekt
Link copied to clipboard
fun whichDetekt (): String ?
Content copied to clipboard

Returns the bundled detekt version.

whichJava
Link copied to clipboard
fun whichJava (): String
Content copied to clipboard

Returns the version of the running JVM.

whichOS
Link copied to clipboard
fun whichOS (): String
Content copied to clipboard

Returns the name of the running OS.