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

Package-level declarations

Types

Link copied to clipboard
@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.

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

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

Link copied to clipboard
class PathFilters

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

Functions

Link copied to clipboard
fun KtElement.isSuppressedBy(id: Rule.Id, aliases: Set<String>, ruleSetId: RuleSet.Id? = 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
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.

Link copied to clipboard
fun whichDetekt(): String

Returns the bundled detekt version.

Link copied to clipboard
fun whichJava(): String

Returns the version of the running JVM.

Link copied to clipboard
fun whichKotlin(): String

Returns the version of Kotlin that detekt was compiled with

Link copied to clipboard
fun whichOS(): String

Returns the name of the running OS.