Package-level declarations

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.

Defines the visiting mechanism for KtFile's.

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.

Provides a compact string representation.

A configuration holds information about how to configure specific rules.

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

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

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

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

Represents a code smell for that can be auto corrected.

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

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

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

Stores information about a specific code fragment.

Defines extension points in detekt. Currently supported extensions are:

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

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

Describes a source code position.

An issue represents a problem in the codebase.

Specifies a position within a source code fragment.

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.

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.

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

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

Properties holder. Allows to store and retrieve any data.

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

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.

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

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

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

Context providing useful processing settings to initialize extensions.

The severity for each Issue. This will be printed to the output, such as XML or Sarif. Depending on the severity of the issues found, the build process result is determined.

Stores line and column information of a location.

Stores character start and end positions of a text file.

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

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

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.

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

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

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

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.

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 and transformed only once.

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.

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 and transformed only once.

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.

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 and transformed only once.

Allows to retrieve stored properties in a type safe way.

Convert a simple pattern String to a Regex

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:

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