build:

maxIssues: 10

excludeCorrectable: false

weights:

# complexity: 2

# LongParameterList: 1

# style: 1

# comments: 1

config:

validation: true

# when writing own rules with new properties, exclude the property path e.g.: "my_rule_set,.*>.*>[my_property]"

excludes: ""

processors:

active: true

exclude:

# - 'DetektProgressListener'

# - 'FunctionCountProcessor'

# - 'PropertyCountProcessor'

# - 'ClassCountProcessor'

# - 'PackageCountProcessor'

# - 'KtFileCountProcessor'

console-reports:

active: true

exclude:

# - 'ProjectStatisticsReport'

# - 'ComplexityReport'

# - 'NotificationReport'

# - 'FindingsReport'

- 'FileBasedFindingsReport'

# - 'BuildFailureReport'

comments:

active: true

excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"

CommentOverPrivateFunction:

active: false

CommentOverPrivateProperty:

active: false

EndOfSentenceFormat:

active: false

endOfSentenceFormat: ([.?!][ \t\n\r\f<])|([.?!:]$)

UndocumentedPublicClass:

active: false

searchInNestedClass: true

searchInInnerClass: true

searchInInnerObject: true

searchInInnerInterface: true

UndocumentedPublicFunction:

active: false

UndocumentedPublicProperty:

active: false

complexity:

active: true

ComplexCondition:

active: true

threshold: 4

ComplexInterface:

active: false

threshold: 10

includeStaticDeclarations: false

ComplexMethod:

active: true

threshold: 20

ignoreSingleWhenExpression: false

ignoreSimpleWhenEntries: false

ignoreNestingFunctions: false

nestingFunctions: run,let,apply,with,also,use,forEach,isNotNull,ifNull

LabeledExpression:

active: false

ignoredLabels: ""

LargeClass:

active: true

threshold: 600

LongMethod:

active: true

threshold: 60

LongParameterList:

active: true

threshold: 6

ignoreDefaultParameters: false

MethodOverloading:

active: false

threshold: 6

NestedBlockDepth:

active: true

threshold: 4

StringLiteralDuplication:

active: false

excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"

threshold: 3

ignoreAnnotation: true

excludeStringsWithLessThan5Characters: true

ignoreStringsRegex: '$^'

TooManyFunctions:

active: true

excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"

thresholdInFiles: 15

thresholdInClasses: 15

thresholdInInterfaces: 15

thresholdInObjects: 15

thresholdInEnums: 15

ignoreDeprecated: false

ignorePrivate: false

ignoreOverridden: false

empty-blocks:

active: true

EmptyCatchBlock:

active: true

allowedExceptionNameRegex: "^(_|(ignore|expected).*)"

EmptyClassBlock:

active: true

EmptyDefaultConstructor:

active: true

EmptyDoWhileBlock:

active: true

EmptyElseBlock:

active: true

EmptyFinallyBlock:

active: true

EmptyForBlock:

active: true

EmptyFunctionBlock:

active: true

ignoreOverriddenFunctions: false

EmptyIfBlock:

active: true

EmptyInitBlock:

active: true

EmptyKtFile:

active: true

EmptySecondaryConstructor:

active: true

EmptyWhenBlock:

active: true

EmptyWhileBlock:

active: true

exceptions:

active: true

ExceptionRaisedInUnexpectedLocation:

active: false

methodNames: 'toString,hashCode,equals,finalize'

InstanceOfCheckForException:

active: false

excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"

NotImplementedDeclaration:

active: false

PrintStackTrace:

active: false

RethrowCaughtException:

active: false

ReturnFromFinally:

active: false

ignoreLabeled: false

SwallowedException:

active: false

ignoredExceptionTypes: 'InterruptedException,NumberFormatException,ParseException,MalformedURLException'

allowedExceptionNameRegex: "^(_|(ignore|expected).*)"

ThrowingExceptionFromFinally:

active: false

ThrowingExceptionInMain:

active: false

ThrowingExceptionsWithoutMessageOrCause:

active: false

exceptions: 'IllegalArgumentException,IllegalStateException,IOException'

ThrowingNewInstanceOfSameException:

active: false

TooGenericExceptionCaught:

active: true

excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"

exceptionNames:

- ArrayIndexOutOfBoundsException

- Error

- Exception

- IllegalMonitorStateException

- NullPointerException

- IndexOutOfBoundsException

- RuntimeException

- Throwable

allowedExceptionNameRegex: "^(_|(ignore|expected).*)"

TooGenericExceptionThrown:

active: true

exceptionNames:

- Error

- Exception

- Throwable

- RuntimeException

formatting:

active: true

android: false

autoCorrect: true

AnnotationOnSeparateLine:

active: false

autoCorrect: true

ChainWrapping:

active: true

autoCorrect: true

CommentSpacing:

active: true

autoCorrect: true

Filename:

active: true

FinalNewline:

active: true

autoCorrect: true

ImportOrdering:

active: false

autoCorrect: true

Indentation:

active: false

autoCorrect: true

indentSize: 4

continuationIndentSize: 4

MaximumLineLength:

active: true

maxLineLength: 120

ModifierOrdering:

active: true

autoCorrect: true

MultiLineIfElse:

active: true

autoCorrect: true

NoBlankLineBeforeRbrace:

active: true

autoCorrect: true

NoConsecutiveBlankLines:

active: false

autoCorrect: false

NoEmptyClassBody:

active: true

autoCorrect: true

NoLineBreakAfterElse:

active: true

autoCorrect: true

NoLineBreakBeforeAssignment:

active: true

autoCorrect: true

NoMultipleSpaces:

active: true

autoCorrect: true

NoSemicolons:

active: true

autoCorrect: true

NoTrailingSpaces:

active: true

autoCorrect: true

NoUnitReturn:

active: true

autoCorrect: true

NoUnusedImports:

active: true

autoCorrect: true

NoWildcardImports:

active: false

PackageName:

active: true

autoCorrect: true

ParameterListWrapping:

active: true

autoCorrect: true

indentSize: 4

SpacingAroundColon:

active: true

autoCorrect: true

SpacingAroundComma:

active: true

autoCorrect: true

SpacingAroundCurly:

active: true

autoCorrect: true

SpacingAroundDot:

active: true

autoCorrect: true

SpacingAroundKeyword:

active: true

autoCorrect: true

SpacingAroundOperators:

active: true

autoCorrect: true

SpacingAroundParens:

active: true

autoCorrect: true

SpacingAroundRangeOperator:

active: true

autoCorrect: true

StringTemplate:

active: true

autoCorrect: true

naming:

active: true

ClassNaming:

active: true

excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"

classPattern: '[A-Z$][a-zA-Z0-9$]*'

ConstructorParameterNaming:

active: true

excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"

parameterPattern: '[a-z][A-Za-z0-9]*'

privateParameterPattern: '[a-z][A-Za-z0-9]*'

excludeClassPattern: '$^'

ignoreOverridden: true

EnumNaming:

active: true

excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"

enumEntryPattern: '^[A-Z][_a-zA-Z0-9]*'

ForbiddenClassName:

active: false

excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"

forbiddenName: ''

FunctionMaxLength:

active: false

excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"

maximumFunctionNameLength: 30

FunctionMinLength:

active: false

excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"

minimumFunctionNameLength: 3

FunctionNaming:

active: true

excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"

functionPattern: '^([a-z$][a-zA-Z$0-9]*)|(`.*`)$'

excludeClassPattern: '$^'

ignoreOverridden: true

FunctionParameterNaming:

active: true

excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"

parameterPattern: '[a-z][A-Za-z0-9]*'

excludeClassPattern: '$^'

ignoreOverriddenFunctions: true

InvalidPackageDeclaration:

active: false

rootPackage: ''

MatchingDeclarationName:

active: true

MemberNameEqualsClassName:

active: false

ignoreOverriddenFunction: true

ObjectPropertyNaming:

active: true

excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"

constantPattern: '[A-Za-z][_A-Za-z0-9]*'

propertyPattern: '[A-Za-z][_A-Za-z0-9]*'

privatePropertyPattern: '(_)?[A-Za-z][_A-Za-z0-9]*'

PackageNaming:

active: true

excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"

packagePattern: '^[a-z]+(\.[a-z][A-Za-z0-9]*)*$'

TopLevelPropertyNaming:

active: true

excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"

constantPattern: '[A-Z][_A-Z0-9]*'

propertyPattern: '[A-Za-z][_A-Za-z0-9]*'

privatePropertyPattern: '_?[A-Za-z][_A-Za-z0-9]*'

VariableMaxLength:

active: false

excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"

maximumVariableNameLength: 64

VariableMinLength:

active: false

excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"

minimumVariableNameLength: 1

VariableNaming:

active: true

excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"

variablePattern: '[a-z][A-Za-z0-9]*'

privateVariablePattern: '(_)?[a-z][A-Za-z0-9]*'

excludeClassPattern: '$^'

ignoreOverridden: true

performance:

active: true

ArrayPrimitive:

active: true

ForEachOnRange:

active: true

excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"

SpreadOperator:

active: true

excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"

UnnecessaryTemporaryInstantiation:

active: true

potential-bugs:

active: true

Deprecation:

active: false

DuplicateCaseInWhenExpression:

active: true

EqualsAlwaysReturnsTrueOrFalse:

active: true

EqualsWithHashCodeExist:

active: true

ExplicitGarbageCollectionCall:

active: true

HasPlatformType:

active: false

ImplicitDefaultLocale:

active: false

InvalidRange:

active: true

IteratorHasNextCallsNextMethod:

active: true

IteratorNotThrowingNoSuchElementException:

active: true

LateinitUsage:

active: false

excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"

excludeAnnotatedProperties: ""

ignoreOnClassesPattern: ""

MapGetWithNotNullAssertionOperator:

active: false

MissingWhenCase:

active: true

RedundantElseInWhen:

active: true

UnconditionalJumpStatementInLoop:

active: false

UnreachableCode:

active: true

UnsafeCallOnNullableType:

active: true

UnsafeCast:

active: false

UselessPostfixExpression:

active: false

WrongEqualsTypeParameter:

active: true

style:

active: true

CollapsibleIfStatements:

active: false

DataClassContainsFunctions:

active: false

conversionFunctionPrefix: 'to'

DataClassShouldBeImmutable:

active: false

EqualsNullCall:

active: true

EqualsOnSignatureLine:

active: false

ExplicitItLambdaParameter:

active: false

ExpressionBodySyntax:

active: false

includeLineWrapping: false

ForbiddenComment:

active: true

values: 'TODO:,FIXME:,STOPSHIP:'

allowedPatterns: ""

ForbiddenImport:

active: false

imports: ''

forbiddenPatterns: ""

ForbiddenMethodCall:

active: false

methods: ''

ForbiddenPublicDataClass:

active: false

ignorePackages: '*.internal,*.internal.*'

ForbiddenVoid:

active: false

ignoreOverridden: false

ignoreUsageInGenerics: false

FunctionOnlyReturningConstant:

active: true

ignoreOverridableFunction: true

excludedFunctions: 'describeContents'

excludeAnnotatedFunction: "dagger.Provides"

LibraryCodeMustSpecifyReturnType:

active: true

LoopWithTooManyJumpStatements:

active: false

maxJumpCount: 1

MagicNumber:

active: true

excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"

ignoreNumbers: '-1,0,1,2'

ignoreHashCodeFunction: true

ignorePropertyDeclaration: false

ignoreLocalVariableDeclaration: false

ignoreConstantDeclaration: true

ignoreCompanionObjectPropertyDeclaration: true

ignoreAnnotation: false

ignoreNamedArgument: true

ignoreEnums: false

ignoreRanges: false

MandatoryBracesIfStatements:

active: false

MaxLineLength:

active: true

maxLineLength: 120

excludePackageStatements: true

excludeImportStatements: true

excludeCommentStatements: false

MayBeConst:

active: true

ModifierOrder:

active: true

NestedClassesVisibility:

active: false

NewLineAtEndOfFile:

active: true

NoTabs:

active: false

OptionalAbstractKeyword:

active: true

OptionalUnit:

active: false

OptionalWhenBraces:

active: false

PreferToOverPairSyntax:

active: false

ProtectedMemberInFinalClass:

active: true

RedundantExplicitType:

active: false

RedundantVisibilityModifierRule:

active: false

ReturnCount:

active: false

max: 2

excludedFunctions: "equals"

excludeLabeled: false

excludeReturnFromLambda: true

excludeGuardClauses: false

SafeCast:

active: true

SerialVersionUIDInSerializableClass:

active: false

SpacingBetweenPackageAndImports:

active: false

ThrowsCount:

active: false

max: 2

TrailingWhitespace:

active: false

UnderscoresInNumericLiterals:

active: false

acceptableDecimalLength: 5

UnnecessaryAbstractClass:

active: true

excludeAnnotatedClasses: "dagger.Module"

UnnecessaryAnnotationUseSiteTarget:

active: false

UnnecessaryApply:

active: false

UnnecessaryInheritance:

active: true

UnnecessaryLet:

active: false

UnnecessaryParentheses:

active: false

UntilInsteadOfRangeTo:

active: false

UnusedImports:

active: false

UnusedPrivateClass:

active: true

UnusedPrivateMember:

active: false

allowedNames: "(_|ignored|expected|serialVersionUID)"

UseArrayLiteralsInAnnotations:

active: false

UseCheckOrError:

active: false

UseDataClass:

active: false

excludeAnnotatedClasses: ""

allowVars: false

UseIfInsteadOfWhen:

active: false

UseRequire:

active: false

UselessCallOnNotNull:

active: true

UtilityClassWithPublicConstructor:

active: true

VarCouldBeVal:

active: false

WildcardImport:

active: false

excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"

excludeImports: 'java.util.*,kotlinx.android.synthetic.*'