detekt.yml

build:
  maxIssues: 0

processors:
  active: false

potential-bugs:
  active: true
  DuplicateCaseInWhenExpression:
    active: true
  EqualsAlwaysReturnsTrueOrFalse:
    active: false
  EqualsWithHashCodeExist:
    active: true
  WrongEqualsTypeParameter:
    active: false
  IteratorHasNextCallsNextMethod:
    active: false
  ExplicitGarbageCollectionCall:
    active: true
  UnconditionalJumpStatementInLoop:
    active: false
  IteratorNotThrowingNoSuchElementException:
    active: false
  UnreachableCode:
    active: true
  LateinitUsage:
    active: false
    excludeAnnotatedProperties: ''
    ignoreOnClassesPattern: ''
  UnsafeCallOnNullableType:
    active: false
  UnsafeCast:
    active: false
  UselessPostfixExpression:
    active: false

performance:
  active: true
  ForEachOnRange:
    active: true
  SpreadOperator:
    active: false
  UnnecessaryTemporaryInstantiation:
    active: true

exceptions:
  active: true
  ExceptionRaisedInUnexpectedLocation:
    active: false
    methodNames: 'toString,hashCode,equals,finalize'
  SwallowedException:
    active: false
  TooGenericExceptionCaught:
    active: true
    excludes: "**/test/**,**/androidTest/**,**/*Test.kt,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"
    exceptionNames:
      - ArrayIndexOutOfBoundsException
      - Error
      - Exception
      - IllegalMonitorStateException
      - IndexOutOfBoundsException
      - InterruptedException
      - NullPointerException
      - RuntimeException
      - Throwable
  TooGenericExceptionThrown:
    active: true
    excludes: "**/test/**,**/androidTest/**,**/*Test.kt,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"
    exceptionNames:
      - Error
      - Exception
      - NullPointerException
      - RuntimeException
      - Throwable
  InstanceOfCheckForException:
    active: false
  NotImplementedDeclaration:
    active: true
  ThrowingExceptionsWithoutMessageOrCause:
    active: true
    exceptions: 'IllegalArgumentException,IllegalStateException,IOException'
  PrintStackTrace:
    active: false
  RethrowCaughtException:
    active: false
  ReturnFromFinally:
    active: true
  ThrowingExceptionFromFinally:
    active: true
  ThrowingExceptionInMain:
    active: false
  ThrowingNewInstanceOfSameException:
    active: false

empty-blocks:
  active: true
  EmptyCatchBlock:
    active: true
  EmptyClassBlock:
    active: false
  EmptyDefaultConstructor:
    active: true
  EmptyDoWhileBlock:
    active: true
  EmptyElseBlock:
    active: true
  EmptyFinallyBlock:
    active: true
  EmptyForBlock:
    active: true
  EmptyFunctionBlock:
    active: true
  EmptyIfBlock:
    active: true
  EmptyInitBlock:
    active: true
  EmptyKtFile:
    active: true
  EmptySecondaryConstructor:
    active: true
  EmptyWhenBlock:
    active: true
  EmptyWhileBlock:
    active: true

complexity:
  active: true
  LongMethod:
    active: true
    threshold: 60
  NestedBlockDepth:
    active: true
    threshold: 4 # TODO: create custom rule that doesn't count run/let/apply/etc.
  LongParameterList:
    excludes: "**/test/**,**/androidTest/**,**/*Test.kt,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"
    active: true
    functionThreshold: 5
    constructorThreshold: 5
  LargeClass:
    active: true
    threshold: 600
  ComplexInterface:
    active: false
    threshold: 10
    includeStaticDeclarations: false
  ComplexMethod:
    active: false
    threshold: 10
  MethodOverloading:
    active: false
    threshold: 5
  TooManyFunctions:
    active: false
  ComplexCondition:
    active: true
    threshold: 5
  LabeledExpression:
    active: false
  StringLiteralDuplication:
    active: false
    threshold: 2
    ignoreAnnotation: true
    excludeStringsWithLessThan5Characters: true
    ignoreStringsRegex: '$^'

naming:
  active: true
  PackageNaming:
    active: true
    packagePattern: '^[a-z]+(\.[a-z][a-z0-9_]*)*$'
  ClassNaming:
    active: true
    classPattern: '[A-Z$][a-zA-Z$0-9]*'
  EnumNaming:
    active: true
    enumEntryPattern: '^[A-Z$][a-zA-Z_$0-9]*$'
  FunctionNaming:
    active: true
    functionPattern: '^([a-z$][a-zA-Z$0-9]*)|(`.*`)$'
  VariableNaming:
    active: true
    variablePattern: '^(_)?[a-z$][a-zA-Z$0-9]*$'
  TopLevelPropertyNaming:
    active: true
    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
    maximumVariableNameLength: 30
  VariableMinLength:
    active: false
    minimumVariableNameLength: 3
  ForbiddenClassName:
    active: false
    forbiddenName: ''
  InvalidPackageDeclaration:
    active: true
  FunctionMaxLength:
    active: false
    maximumFunctionNameLength: 30
  FunctionMinLength:
    active: false
    minimumFunctionNameLength: 3
  MemberNameEqualsClassName:
    active: false
    ignoreOverridden: true

style:
  active: true
  ReturnCount:
    active: true
    max: 3
  ThrowsCount:
    active: true
    max: 2
  NewLineAtEndOfFile:
    active: true
  OptionalAbstractKeyword:
    active: true
  OptionalWhenBraces:
    active: false
  CollapsibleIfStatements:
    active: false
  EqualsNullCall:
    active: false
  EqualsOnSignatureLine:
    active: true
  ForbiddenComment:
    active: true
    values: 'STOPSHIP'
  ForbiddenImport:
    active: false
    imports: ''
  LoopWithTooManyJumpStatements:
    active: true
    maxJumpCount: 1
  ModifierOrder:
    active: true
  MagicNumber:
    active: true
    excludes: "**/test/**,**/androidTest/**,**/*Test.kt,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"
    ignoreNumbers: '-1,0,1,2'
    ignoreHashCodeFunction: false
    ignorePropertyDeclaration: false
    ignoreConstantDeclaration: true
    ignoreCompanionObjectPropertyDeclaration: true
    ignoreAnnotation: false
    ignoreNamedArgument: true
    ignoreEnums: false
  WildcardImport:
    excludes: "**/test/**,**/androidTest/**,**/*Test.kt,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"
    active: true
  SafeCast:
    active: true
  MaxLineLength:
    active: true
    excludes: "**/test/**,**/androidTest/**,**/*Test.kt,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"
    maxLineLength: 160
    excludePackageStatements: false
    excludeImportStatements: false
  ProtectedMemberInFinalClass:
    active: false
  SerialVersionUIDInSerializableClass:
    active: false
  UnnecessaryParentheses:
    active: false
  UnnecessaryInheritance:
    active: false
  UtilityClassWithPublicConstructor:
    active: false
  DataClassContainsFunctions:
    active: false
    conversionFunctionPrefix: 'to'
  UseDataClass:
    active: false
  UnnecessaryAbstractClass:
    active: false
  OptionalUnit:
    active: true
  ExpressionBodySyntax:
    active: true
  UnusedImports:
    active: true
  NestedClassesVisibility:
    active: false # TODO: Activate when https://github.com/arturbosch/detekt/issues/1075 is solved or don't activate at all
  RedundantVisibilityModifierRule:
    active: true
  FunctionOnlyReturningConstant:
    active: true
    ignoreOverridableFunction: true
    excludedFunctions: 'describeContents'
  LibraryCodeMustSpecifyReturnType:
    active: true
    excludes: "**/test/**,**/androidTest/**,**/*Test.kt,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt,**/*InstrumentationTestUtils/**"
  MandatoryBracesIfStatements:
    active: false

comments:
  active: true
  excludes: "**/test/**,**/androidTest/**,**/*Test.kt,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt,**/*InstrumentationTestUtils/**"
  CommentOverPrivateFunction:
    active: false
  CommentOverPrivateProperty:
    active: true
  UndocumentedPublicClass:
    active: false
    searchInNestedClass: true
    searchInInnerClass: true
    searchInInnerObject: true
    searchInInnerInterface: true
  UndocumentedPublicFunction:
    active: false