Rule

open class Rule(val config: Config, val description: String, val url: URI? = null) : DetektVisitor

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.

A rule is implemented using the visitor pattern and should be started using the visit(KtFile) function. If calculations must be done before or after the visiting process, here are two predefined (preVisit/postVisit) functions which can be overridden to setup/teardown additional data.

Constructors

Link copied to clipboard
constructor(config: Config, description: String, url: URI? = null)

Properties

Link copied to clipboard

Whether this rule should correct the code it reports on.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open val ruleName: RuleName

An id this rule is identified with.

Link copied to clipboard
val url: URI?

An url pointing to the documentation of this rule

Functions

Link copied to clipboard
fun report(finding: Finding)

Adds a new finding

Link copied to clipboard
open fun visit(root: KtFile)

Init function to start visiting the KtFile. Can be overridden to start a different visiting process.

Link copied to clipboard
open fun visitAnnotatedExpression(expression: KtAnnotatedExpression)
fun visitAnnotatedExpression(expression: KtAnnotatedExpression, data: Void?): Void?
Link copied to clipboard
open fun visitAnnotation(annotation: KtAnnotation)
fun visitAnnotation(annotation: KtAnnotation, data: Void?): Void?
Link copied to clipboard
open fun visitAnnotationEntry(annotationEntry: KtAnnotationEntry)
fun visitAnnotationEntry(annotationEntry: KtAnnotationEntry, data: Void?): Void?
Link copied to clipboard
open fun visitAnnotationUseSiteTarget(@NotNull annotationTarget: KtAnnotationUseSiteTarget, data: Void?): Void?
Link copied to clipboard
open fun visitAnonymousInitializer(initializer: KtAnonymousInitializer)
fun visitAnonymousInitializer(initializer: KtAnonymousInitializer, data: Void?): Void?
Link copied to clipboard
open fun visitArgument(argument: KtValueArgument)
fun visitArgument(argument: KtValueArgument, data: Void?): Void?
Link copied to clipboard
open fun visitArrayAccessExpression(expression: KtArrayAccessExpression)
fun visitArrayAccessExpression(expression: KtArrayAccessExpression, data: Void?): Void?
Link copied to clipboard
open fun visitBackingField(@NotNull accessor: KtBackingField, data: Void?): Void?
Link copied to clipboard
open fun visitBinaryExpression(expression: KtBinaryExpression)
fun visitBinaryExpression(expression: KtBinaryExpression, data: Void?): Void?
Link copied to clipboard
open fun visitBinaryFile(file: @NotNull PsiBinaryFile)
Link copied to clipboard
open fun visitBinaryWithTypeRHSExpression(expression: KtBinaryExpressionWithTypeRHS)
fun visitBinaryWithTypeRHSExpression(expression: KtBinaryExpressionWithTypeRHS, data: Void?): Void?
Link copied to clipboard
open fun visitBlockExpression(expression: KtBlockExpression)
fun visitBlockExpression(expression: KtBlockExpression, data: Void?): Void?
Link copied to clipboard
open fun visitBlockStringTemplateEntry(entry: KtBlockStringTemplateEntry)
fun visitBlockStringTemplateEntry(entry: KtBlockStringTemplateEntry, data: Void?): Void?
Link copied to clipboard
open fun visitBreakExpression(expression: KtBreakExpression)
fun visitBreakExpression(expression: KtBreakExpression, data: Void?): Void?
Link copied to clipboard
open fun visitCallableReferenceExpression(expression: KtCallableReferenceExpression)
fun visitCallableReferenceExpression(expression: KtCallableReferenceExpression, data: Void?): Void?
Link copied to clipboard
open fun visitCallExpression(expression: KtCallExpression)
fun visitCallExpression(expression: KtCallExpression, data: Void?): Void?
Link copied to clipboard
open fun visitCatchSection(catchClause: KtCatchClause)
fun visitCatchSection(catchClause: KtCatchClause, data: Void?): Void?
Link copied to clipboard
open fun visitClass(klass: KtClass)
fun visitClass(klass: KtClass, data: Void?): Void?
Link copied to clipboard
open fun visitClassBody(classBody: KtClassBody)
fun visitClassBody(classBody: KtClassBody, data: Void?): Void?
Link copied to clipboard
open fun visitClassInitializer(initializer: KtClassInitializer)
open fun visitClassInitializer(initializer: KtClassInitializer, data: Void?): Void?
Link copied to clipboard
open fun visitClassLiteralExpression(expression: KtClassLiteralExpression)
fun visitClassLiteralExpression(expression: KtClassLiteralExpression, data: Void?): Void?
Link copied to clipboard
open fun visitClassOrObject(classOrObject: KtClassOrObject)
fun visitClassOrObject(classOrObject: KtClassOrObject, data: Void?): Void?
Link copied to clipboard
open fun visitCollectionLiteralExpression(expression: KtCollectionLiteralExpression)
fun visitCollectionLiteralExpression(expression: KtCollectionLiteralExpression, data: Void?): Void?
Link copied to clipboard
open fun visitComment(comment: @NotNull PsiComment)
Link copied to clipboard
open fun visitCompanionBlock(companionBlock: KtCompanionBlock)
open fun visitCompanionBlock(companionBlock: KtCompanionBlock, data: Void?): Void?
Link copied to clipboard
open fun visitConstantExpression(expression: KtConstantExpression)
fun visitConstantExpression(expression: KtConstantExpression, data: Void?): Void?
Link copied to clipboard
open fun visitConstructor(constructor: KtConstructor)
open fun visitConstructor(constructor: KtConstructor, data: Void?): Void?
Link copied to clipboard
open fun visitConstructorCalleeExpression(constructorCalleeExpression: KtConstructorCalleeExpression)
fun visitConstructorCalleeExpression(constructorCalleeExpression: KtConstructorCalleeExpression, data: Void?): Void?
Link copied to clipboard
open fun visitConstructorDelegationCall(call: KtConstructorDelegationCall)
fun visitConstructorDelegationCall(call: KtConstructorDelegationCall, data: Void?): Void?
Link copied to clipboard
open fun visitContextParameterList(contextParameterList: KtContextParameterList)
open fun visitContextParameterList(contextParameterList: KtContextParameterList, data: Void?): Void?
Link copied to clipboard
open fun visitContextReceiver(contextReceiver: KtContextReceiver)
open fun visitContextReceiver(contextReceiver: KtContextReceiver, data: Void?): Void?
Link copied to clipboard
open fun visitContextReceiverList(contextReceiverList: KtContextReceiverList)
fun visitContextReceiverList(contextReceiverList: KtContextReceiverList, data: Void?): Void?
Link copied to clipboard
open fun visitContinueExpression(expression: KtContinueExpression)
fun visitContinueExpression(expression: KtContinueExpression, data: Void?): Void?
Link copied to clipboard
open fun visitDeclaration(dcl: KtDeclaration)
fun visitDeclaration(dcl: KtDeclaration, data: Void?): Void?
Link copied to clipboard
open fun visitDelegatedSuperTypeEntry(specifier: KtDelegatedSuperTypeEntry)
fun visitDelegatedSuperTypeEntry(specifier: KtDelegatedSuperTypeEntry, data: Void?): Void?
Link copied to clipboard
open fun visitDestructuringDeclaration(destructuringDeclaration: KtDestructuringDeclaration)
fun visitDestructuringDeclaration(multiDeclaration: KtDestructuringDeclaration, data: Void?): Void?
Link copied to clipboard
open fun visitDestructuringDeclarationEntry(multiDeclarationEntry: KtDestructuringDeclarationEntry)
fun visitDestructuringDeclarationEntry(multiDeclarationEntry: KtDestructuringDeclarationEntry, data: Void?): Void?
Link copied to clipboard
open fun visitDirectory(dir: @NotNull PsiDirectory)
Link copied to clipboard
open fun visitDotQualifiedExpression(expression: KtDotQualifiedExpression)
fun visitDotQualifiedExpression(expression: KtDotQualifiedExpression, data: Void?): Void?
Link copied to clipboard
open fun visitDoubleColonExpression(expression: KtDoubleColonExpression)
fun visitDoubleColonExpression(expression: KtDoubleColonExpression, data: Void?): Void?
Link copied to clipboard
open fun visitDoWhileExpression(expression: KtDoWhileExpression)
fun visitDoWhileExpression(expression: KtDoWhileExpression, data: Void?): Void?
Link copied to clipboard
open fun visitDynamicType(type: KtDynamicType)
open fun visitDynamicType(type: KtDynamicType, data: Void?): Void?
Link copied to clipboard
open fun visitElement(element: PsiElement)
Link copied to clipboard
open fun visitEnumEntry(enumEntry: KtEnumEntry)
fun visitEnumEntry(enumEntry: KtEnumEntry, data: Void?): Void?
Link copied to clipboard
open fun visitErrorElement(element: @NotNull PsiErrorElement)
Link copied to clipboard
open fun visitEscapeStringTemplateEntry(entry: KtEscapeStringTemplateEntry)
fun visitEscapeStringTemplateEntry(entry: KtEscapeStringTemplateEntry, data: Void?): Void?
Link copied to clipboard
open fun visitExpression(expression: KtExpression)
fun visitExpression(expression: KtExpression, data: Void?): Void?
Link copied to clipboard
open fun visitExpressionWithLabel(expression: KtExpressionWithLabel)
fun visitExpressionWithLabel(expression: KtExpressionWithLabel, data: Void?): Void?
Link copied to clipboard
open fun visitFile(file: @NotNull PsiFile)

fun visitFile(root: KtFile, languageVersionSettings: LanguageVersionSettings): List<Finding>

Before starting visiting kotlin elements, a check is performed if this rule should be triggered. Pre- and post-visit-hooks are executed before/after the visiting process.

Link copied to clipboard
open fun visitFileAnnotationList(@NotNull fileAnnotationList: KtFileAnnotationList, data: Void?): Void?
Link copied to clipboard
open fun visitFinallySection(finallySection: KtFinallySection)
fun visitFinallySection(finallySection: KtFinallySection, data: Void?): Void?
Link copied to clipboard
open fun visitForExpression(expression: KtForExpression)
fun visitForExpression(expression: KtForExpression, data: Void?): Void?
Link copied to clipboard
open fun visitFunctionType(type: KtFunctionType)
fun visitFunctionType(type: KtFunctionType, data: Void?): Void?
Link copied to clipboard
open fun visitIfExpression(expression: KtIfExpression)
fun visitIfExpression(expression: KtIfExpression, data: Void?): Void?
Link copied to clipboard
open fun visitImportAlias(@NotNull importAlias: KtImportAlias, data: Void?): Void?
open fun visitImportAlias(importAlias: KtImportAlias)
Link copied to clipboard
open fun visitImportDirective(importDirective: KtImportDirective)
fun visitImportDirective(importDirective: KtImportDirective, data: Void?): Void?
Link copied to clipboard
open fun visitImportList(importList: KtImportList)
fun visitImportList(importList: KtImportList, data: Void?): Void?
Link copied to clipboard
open fun visitInitializerList(list: KtInitializerList)
fun visitInitializerList(list: KtInitializerList, data: Void?): Void?
Link copied to clipboard
open fun visitIntersectionType(intersectionType: KtIntersectionType)
open fun visitIntersectionType(intersectionType: KtIntersectionType, data: Void?): Void?
Link copied to clipboard
open fun visitIsExpression(expression: KtIsExpression)
fun visitIsExpression(expression: KtIsExpression, data: Void?): Void?
Link copied to clipboard
fun visitKtCommonFile(@NotNull file: KtCommonFile): Void?
Link copied to clipboard
open fun visitKtElement(element: KtElement)
fun visitKtElement(element: KtElement, data: Void?): Void?
Link copied to clipboard
open fun visitKtFile(file: KtFile)
fun visitKtFile(file: KtFile, data: Void?): Void?
Link copied to clipboard
open fun visitLabeledExpression(expression: KtLabeledExpression)
fun visitLabeledExpression(expression: KtLabeledExpression, data: Void?): Void?
Link copied to clipboard
open fun visitLambdaExpression(lambdaExpression: KtLambdaExpression)
fun visitLambdaExpression(expression: KtLambdaExpression, data: Void?): Void?
Link copied to clipboard
open fun visitLiteralStringTemplateEntry(entry: KtLiteralStringTemplateEntry)
fun visitLiteralStringTemplateEntry(entry: KtLiteralStringTemplateEntry, data: Void?): Void?
Link copied to clipboard
open fun visitLoopExpression(loopExpression: KtLoopExpression)
fun visitLoopExpression(loopExpression: KtLoopExpression, data: Void?): Void?
Link copied to clipboard
open fun visitModifierList(list: KtModifierList)
fun visitModifierList(list: KtModifierList, data: Void?): Void?
Link copied to clipboard
open fun visitNamedDeclaration(declaration: KtNamedDeclaration)
fun visitNamedDeclaration(declaration: KtNamedDeclaration, data: Void?): Void?
Link copied to clipboard
open fun visitNamedFunction(function: KtNamedFunction)
fun visitNamedFunction(function: KtNamedFunction, data: Void?): Void?
Link copied to clipboard
open fun visitNullableType(nullableType: KtNullableType)
fun visitNullableType(nullableType: KtNullableType, data: Void?): Void?
Link copied to clipboard
open fun visitObjectDeclaration(declaration: KtObjectDeclaration)
fun visitObjectDeclaration(declaration: KtObjectDeclaration, data: Void?): Void?
Link copied to clipboard
open fun visitObjectLiteralExpression(expression: KtObjectLiteralExpression)
fun visitObjectLiteralExpression(expression: KtObjectLiteralExpression, data: Void?): Void?
Link copied to clipboard
open fun visitOuterLanguageElement(element: @NotNull OuterLanguageElement)
Link copied to clipboard
open fun visitPackageDirective(directive: KtPackageDirective)
open fun visitPackageDirective(directive: KtPackageDirective, data: Void?): Void?
Link copied to clipboard
open fun visitParameter(parameter: KtParameter)
fun visitParameter(parameter: KtParameter, data: Void?): Void?
Link copied to clipboard
open fun visitParameterList(list: KtParameterList)
fun visitParameterList(list: KtParameterList, data: Void?): Void?
Link copied to clipboard
open fun visitParenthesizedExpression(expression: KtParenthesizedExpression)
fun visitParenthesizedExpression(expression: KtParenthesizedExpression, data: Void?): Void?
Link copied to clipboard
open fun visitPlainText(content: @NotNull PsiPlainText)
Link copied to clipboard
open fun visitPlainTextFile(file: @NotNull PsiPlainTextFile)
Link copied to clipboard
open fun visitPostfixExpression(expression: KtPostfixExpression)
fun visitPostfixExpression(expression: KtPostfixExpression, data: Void?): Void?
Link copied to clipboard
open fun visitPrefixExpression(expression: KtPrefixExpression)
fun visitPrefixExpression(expression: KtPrefixExpression, data: Void?): Void?
Link copied to clipboard
open fun visitPrimaryConstructor(constructor: KtPrimaryConstructor)
fun visitPrimaryConstructor(constructor: KtPrimaryConstructor, data: Void?): Void?
Link copied to clipboard
open fun visitProperty(property: KtProperty)
fun visitProperty(property: KtProperty, data: Void?): Void?
Link copied to clipboard
open fun visitPropertyAccessor(accessor: KtPropertyAccessor)
fun visitPropertyAccessor(accessor: KtPropertyAccessor, data: Void?): Void?
Link copied to clipboard
open fun visitPropertyDelegate(delegate: KtPropertyDelegate)
fun visitPropertyDelegate(delegate: KtPropertyDelegate, data: Void?): Void?
Link copied to clipboard
open fun visitQualifiedExpression(expression: KtQualifiedExpression)
fun visitQualifiedExpression(expression: KtQualifiedExpression, data: Void?): Void?
Link copied to clipboard
open fun visitReferenceExpression(expression: KtReferenceExpression)
fun visitReferenceExpression(expression: KtReferenceExpression, data: Void?): Void?
Link copied to clipboard
open fun visitReturnExpression(expression: KtReturnExpression)
fun visitReturnExpression(expression: KtReturnExpression, data: Void?): Void?
Link copied to clipboard
open fun visitSafeQualifiedExpression(expression: KtSafeQualifiedExpression)
fun visitSafeQualifiedExpression(expression: KtSafeQualifiedExpression, data: Void?): Void?
Link copied to clipboard
open fun visitScript(script: KtScript)
fun visitScript(script: KtScript, data: Void?): Void?
Link copied to clipboard
open fun visitScriptInitializer(initializer: KtScriptInitializer)
open fun visitScriptInitializer(initializer: KtScriptInitializer, data: Void?): Void?
Link copied to clipboard
open fun visitSecondaryConstructor(constructor: KtSecondaryConstructor)
fun visitSecondaryConstructor(constructor: KtSecondaryConstructor, data: Void?): Void?
Link copied to clipboard
open fun visitSelfType(type: KtSelfType)
fun visitSelfType(type: KtSelfType, data: Void?): Void?
Link copied to clipboard
open fun visitSimpleNameExpression(expression: KtSimpleNameExpression)
fun visitSimpleNameExpression(expression: KtSimpleNameExpression, data: Void?): Void?
Link copied to clipboard
open fun visitSimpleNameStringTemplateEntry(entry: KtSimpleNameStringTemplateEntry)
fun visitSimpleNameStringTemplateEntry(entry: KtSimpleNameStringTemplateEntry, data: Void?): Void?
Link copied to clipboard
open fun visitStringInterpolationPrefix(@NotNull prefix: KtStringInterpolationPrefix, data: Void?): Void?
Link copied to clipboard
open fun visitStringTemplateEntry(entry: KtStringTemplateEntry)
fun visitStringTemplateEntry(entry: KtStringTemplateEntry, data: Void?): Void?
Link copied to clipboard
open fun visitStringTemplateEntryWithExpression(entry: KtStringTemplateEntryWithExpression)
fun visitStringTemplateEntryWithExpression(entry: KtStringTemplateEntryWithExpression, data: Void?): Void?
Link copied to clipboard
open fun visitStringTemplateExpression(expression: KtStringTemplateExpression)
fun visitStringTemplateExpression(expression: KtStringTemplateExpression, data: Void?): Void?
Link copied to clipboard
open fun visitSuperExpression(expression: KtSuperExpression)
fun visitSuperExpression(expression: KtSuperExpression, data: Void?): Void?
Link copied to clipboard
open fun visitSuperTypeCallEntry(call: KtSuperTypeCallEntry)
fun visitSuperTypeCallEntry(call: KtSuperTypeCallEntry, data: Void?): Void?
Link copied to clipboard
open fun visitSuperTypeEntry(specifier: KtSuperTypeEntry)
fun visitSuperTypeEntry(specifier: KtSuperTypeEntry, data: Void?): Void?
Link copied to clipboard
open fun visitSuperTypeList(list: KtSuperTypeList)
fun visitSuperTypeList(list: KtSuperTypeList, data: Void?): Void?
Link copied to clipboard
open fun visitSuperTypeListEntry(specifier: KtSuperTypeListEntry)
fun visitSuperTypeListEntry(specifier: KtSuperTypeListEntry, data: Void?): Void?
Link copied to clipboard
open fun visitThisExpression(expression: KtThisExpression)
fun visitThisExpression(expression: KtThisExpression, data: Void?): Void?
Link copied to clipboard
open fun visitThrowExpression(expression: KtThrowExpression)
fun visitThrowExpression(expression: KtThrowExpression, data: Void?): Void?
Link copied to clipboard
open fun visitTryExpression(expression: KtTryExpression)
fun visitTryExpression(expression: KtTryExpression, data: Void?): Void?
Link copied to clipboard
open fun visitTypeAlias(typeAlias: KtTypeAlias)
fun visitTypeAlias(typeAlias: KtTypeAlias, data: Void?): Void?
Link copied to clipboard
open fun visitTypeArgumentList(typeArgumentList: KtTypeArgumentList)
fun visitTypeArgumentList(typeArgumentList: KtTypeArgumentList, data: Void?): Void?
Link copied to clipboard
open fun visitTypeConstraint(constraint: KtTypeConstraint)
fun visitTypeConstraint(constraint: KtTypeConstraint, data: Void?): Void?
Link copied to clipboard
open fun visitTypeConstraintList(list: KtTypeConstraintList)
fun visitTypeConstraintList(list: KtTypeConstraintList, data: Void?): Void?
Link copied to clipboard
open fun visitTypeParameter(parameter: KtTypeParameter)
fun visitTypeParameter(parameter: KtTypeParameter, data: Void?): Void?
Link copied to clipboard
open fun visitTypeParameterList(list: KtTypeParameterList)
fun visitTypeParameterList(list: KtTypeParameterList, data: Void?): Void?
Link copied to clipboard
open fun visitTypeProjection(typeProjection: KtTypeProjection)
fun visitTypeProjection(typeProjection: KtTypeProjection, data: Void?): Void?
Link copied to clipboard
open fun visitTypeReference(typeReference: KtTypeReference)
fun visitTypeReference(typeReference: KtTypeReference, data: Void?): Void?
Link copied to clipboard
open fun visitUnaryExpression(expression: KtUnaryExpression)
fun visitUnaryExpression(expression: KtUnaryExpression, data: Void?): Void?
Link copied to clipboard
open fun visitUserType(type: KtUserType)
fun visitUserType(type: KtUserType, data: Void?): Void?
Link copied to clipboard
open fun visitValueArgumentList(list: KtValueArgumentList)
fun visitValueArgumentList(list: KtValueArgumentList, data: Void?): Void?
Link copied to clipboard
open fun visitWhenConditionInRange(condition: KtWhenConditionInRange)
fun visitWhenConditionInRange(condition: KtWhenConditionInRange, data: Void?): Void?
Link copied to clipboard
open fun visitWhenConditionIsPattern(condition: KtWhenConditionIsPattern)
fun visitWhenConditionIsPattern(condition: KtWhenConditionIsPattern, data: Void?): Void?
Link copied to clipboard
open fun visitWhenConditionWithExpression(condition: KtWhenConditionWithExpression)
fun visitWhenConditionWithExpression(condition: KtWhenConditionWithExpression, data: Void?): Void?
Link copied to clipboard
open fun visitWhenEntry(ktWhenEntry: KtWhenEntry)
fun visitWhenEntry(ktWhenEntry: KtWhenEntry, data: Void?): Void?
Link copied to clipboard
open fun visitWhenExpression(expression: KtWhenExpression)
fun visitWhenExpression(expression: KtWhenExpression, data: Void?): Void?
Link copied to clipboard
open fun visitWhileExpression(expression: KtWhileExpression)
fun visitWhileExpression(expression: KtWhileExpression, data: Void?): Void?
Link copied to clipboard
open fun visitWhiteSpace(space: @NotNull PsiWhiteSpace)