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

Package-level declarations

Types

class AnnotationExcluder(root: KtFile, excludes: List<Regex>, context: BindingContext)

Primary use case for an AnnotationExcluder is to decide if a KtElement should be excluded from further analysis. This is done by checking if a special annotation is present over the element.

BaseRule

abstract class BaseRule(context: Context = DefaultContext()) : DetektVisitor, Context

Defines the visiting mechanism for KtFile's.

CodeSmell

open class CodeSmell(val issue: Issue, val entity: Entity, val message: String, val metrics: List<Metric> = emptyList(), val references: List<Entity> = emptyList()) : Finding

A code smell indicates any possible design problem inside a program's source code. The type of a code smell is described by an Issue.

Compactable

interface Compactable

Provides a compact string representation.

Config

interface Config

A configuration holds information about how to configure specific rules.

ConfigAware

interface ConfigAware : Config

Interface which is implemented by each Rule class to provide utility functions to retrieve specific or generic properties from the underlying detekt configuration file.

ConfigValidator

interface ConfigValidator : Extension

An extension which allows users to validate parts of the configuration.

ConsoleReport

abstract class ConsoleReport : Extension

Extension point which describes how findings should be printed on the console.

Context

interface Context

A context describes the storing and reporting mechanism of Finding's inside a Rule. Additionally it handles suppression and aliases management.

CorrectableCodeSmell

open class CorrectableCodeSmell(val issue: Issue, val entity: Entity, val message: String, val metrics: List<Metric> = emptyList(), val references: List<Entity> = emptyList(), val autoCorrectEnabled: Boolean) : CodeSmell

Represents a code smell for that can be auto corrected.

Debt

data class Debt(val days: Int = 0, val hours: Int = 0, val mins: Int = 0)

Debt describes the estimated amount of work needed to fix a given issue.

DefaultContext

open class ~~DefaultContext~~ : Context

Default Context implementation.

Detektion

interface Detektion

Storage for all kinds of findings and additional information which needs to be transferred from the detekt engine to the user.

DetektVisitor

open class DetektVisitor : KtTreeVisitorVoid

Basic visitor which is used inside detekt. Guarantees a better looking name as the extended base class :).

Entity

data class Entity(name: String, val signature: String, val location: Location, val ktElement: KtElement? = null) : Compactable

Stores information about a specific code fragment.

Extension

interface Extension

Defines extension points in detekt. Currently supported extensions are:

FileProcessListener

interface FileProcessListener : Extension

Gather additional metrics about the analyzed kotlin file. Pay attention to the thread policy of each function!

Finding

interface Finding : Compactable, HasEntity, HasMetrics

Base interface of detection findings. Inherits a bunch of useful behaviour from sub interfaces.

HasEntity

interface HasEntity

Describes a source code position.

HasMetrics

interface HasMetrics

Adds metric container behaviour.

Issue

data class Issue(val id: String, val severity: Severity, val description: String, val debt: Debt)

An issue represents a problem in the codebase.

LazyRegex

class ~~LazyRegex~~(key: String, default: String) : ReadOnlyProperty<Rule, Regex>

LazyRegex class provides a lazy evaluation of a Regex pattern for usages inside Rules. It computes the value once when reaching the point of its usage and returns the same value when requested again.

Location

data class Location @JvmOverloads constructor(val source: SourceLocation, val text: TextLocation, val file: String, val filePath: FilePath = FilePath.fromAbsolute(Path(file))) : Compactable

Specifies a position within a source code fragment.

Metric

data class Metric(val type: String, val value: Int, val threshold: Int, val isDouble: Boolean = false, val conversionFactor: Int = DEFAULT_FLOAT_CONVERSION_FACTOR)

Metric type, can be an integer or double value. Internally it is stored as an integer, but the conversion factor and is double attributes can be used to retrieve it as a double value.

MultiRule

abstract class ~~MultiRule~~ : BaseRule

Composite rule which delegates work to child rules. Can be used to combine different rules which do similar work like scanning the source code line by line to increase performance.

Notification

interface Notification

Any kind of notification which should be printed to the console. For example when using the formatting rule set, any change to your kotlin file is a notification.

OutputReport

abstract class OutputReport : Extension

Translates detekt's result container - Detektion - into an output report which is written inside a file.

ProjectMetric

open class ProjectMetric(val type: String, val value: Int, val priority: Int = -1, val isDouble: Boolean = false, val conversionFactor: Int = DEFAULT_FLOAT_CONVERSION_FACTOR)

Anything that can be expressed as a numeric value for projects.

PropertiesAware

interface PropertiesAware

Properties holder. Allows to store and retrieve any data.

ReportingExtension

interface ReportingExtension : Extension

Allows to intercept detekt's result container by listening to the initial and final state and manipulate the reported findings.

Rule

abstract class Rule(val ruleSetConfig: Config = Config.empty, ruleContext: Context = DefaultContext()) : BaseRule, ConfigAware

A rule defines how one specific code structure should look like. If code is found which does not meet this structure, it is considered as harmful regarding maintainability or readability.

RuleId

typealias RuleId = String

The type to use when referring to rule ids giving it more context then a String would.

RuleSet

class RuleSet(val id: RuleSetId, val rules: List<BaseRule>)

A rule set is a collection of rules and must be defined within a rule set provider implementation.

RuleSetId

typealias RuleSetId = String

RuleSetProvider

interface RuleSetProvider

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

SetupContext

interface SetupContext : PropertiesAware

Context providing useful processing settings to initialize extensions.

Severity

enum Severity : Enum<Severity>

Note: This will be replaced by SeverityLevel in future versions of detekt.

SeverityLevel

enum SeverityLevel : Enum<SeverityLevel>

The severity level for each Issue. This will be printed to the output, such as XML or Sarif.

SingleAssign

class SingleAssign<T : Any>

Allows to assign a property just once. Further assignments result in IllegalStateException's.

SourceLocation

data class SourceLocation(val line: Int, val column: Int)

Stores line and column information of a location.

SplitPattern

open class SplitPattern(text: String, delimiters: String = ",", removeTrailingAsterisks: Boolean = true)

Splits given text into parts and provides testing utilities for its elements. Basic use cases are to specify different function or class names in the detekt yaml config and test for their appearance in specific rules.

TextLocation

data class TextLocation(val start: Int, val end: Int)

Stores character start and end positions of a text file.

ThresholdedCodeSmell

open class ThresholdedCodeSmell(val issue: Issue, val entity: Entity, val metric: Metric, val message: String, val references: List<Entity> = emptyList()) : CodeSmell

Represents a code smell for which a specific metric can be determined which is responsible for the existence of this rule violation.

ThresholdRule

abstract class ~~ThresholdRule~~(config: Config, defaultThreshold: Int) : Rule

Provides a threshold attribute for this rule, which is specified manually for default values but can be also obtained from within a configuration object.

UnstableApi

annotation class UnstableApi(val reason: String = "")

Experimental detekt api which may change on minor or patch versions.

ValuesWithReason

data class ValuesWithReason : Iterable<ValueWithReason>

ValuesWithReason is essentially the same as List of ValueWithReason. Due to type erasure we cannot use the list directly. Instances of this type should always created using the valuesWithReason factory method.

ValueWithReason

data class ValueWithReason(val value: String, val reason: String? = null)

A ValueWithReason represents a single configuration value that may have an explanation as to why it is used.

Functions

commaSeparatedPattern

fun String.commaSeparatedPattern(vararg delimiters: String = arrayOf(",")): Sequence<String>

Splits given String into a sequence of strings split by the provided delimiters ("," by default).

config

fun <T : Any> config(defaultValue: T): ReadOnlyProperty<ConfigAware, T>

Creates a delegated read-only property that can be used in ConfigAware objects. The name of the property is the key that is used during configuration lookup. The value of the property is evaluated only once.

fun <T : Any, U : Any> config(defaultValue: T, transformer: (T) -> U): ReadOnlyProperty<ConfigAware, U>

configWithAndroidVariants

fun <T : Any> configWithAndroidVariants(defaultValue: T, defaultAndroidValue: T): ReadOnlyProperty<ConfigAware, T>

fun <T : Any, U : Any> configWithAndroidVariants(defaultValue: T, defaultAndroidValue: T, transformer: (T) -> U): ReadOnlyProperty<ConfigAware, U>

configWithFallback

fun <T : Any> configWithFallback(fallbackProperty: KProperty0<T>, defaultValue: T): ReadOnlyProperty<ConfigAware, T>

Creates a delegated read-only property that can be used in ConfigAware objects. The name of the property is the key that is used during configuration lookup. If there is no such property, the value of the supplied fallbackProperty is also considered before using the defaultValue. The value of the property is evaluated only once.

fun <T : Any, U : Any> configWithFallback(fallbackProperty: KProperty0<U>, defaultValue: T, transformer: (T) -> U): ReadOnlyProperty<ConfigAware, U>

getOrNull

inline fun <T : Any> PropertiesAware.getOrNull(key: String): T?

Allows to retrieve stored properties in a type safe way.

simplePatternToRegex

fun String.simplePatternToRegex(): Regex

Convert a simple pattern String to a Regex

valuesWithReason

fun valuesWithReason(vararg values: Pair<String, String?>): ValuesWithReason

This factory method can be used by rule authors to specify one or many configuration values along with an explanation for each value. For example:

fun valuesWithReason(values: List<ValueWithReason>): ValuesWithReason

This factory method can be used by rule authors to specify one or many configuration values along with an explanation for each value.

Properties

DEFAULT_FLOAT_CONVERSION_FACTOR

const val DEFAULT_FLOAT_CONVERSION_FACTOR: Int = 100

To represent a value of 0.5, use the metric value 50 and the conversion factor of 100. (50 / 100 = 0.5)