detekt.yml

# Merged with changes to the default:
# https://github.com/arturbosch/detekt/commits/master/detekt-cli/src/main/resources/default-detekt-config.yml
#
# Up through: Feb 17, 2019
#

test-pattern: # Configure exclusions for test sources
  # like default list, but with 'WildcardImport' removed
  exclude-rules:
    - 'NamingRules'
    - 'MagicNumber'
    - 'MaxLineLength'
    - 'LateinitUsage'
    - 'StringLiteralDuplication'
    - 'SpreadOperator'
    - 'TooManyFunctions'
    - 'ForEachOnRange'
    - 'FunctionMaxLength'
    - 'TooGenericExceptionCaught'
    - 'InstanceOfCheckForException'

build:
  maxIssues: 0

processors:
  active: false

console-reports:
  active: true
  exclude:
    #  - 'ProjectStatisticsReport'
    - 'ComplexityReport'
  #  - 'NotificationReport'
  #  - 'FindingsReport'
  #  - 'BuildFailureReport'

output-reports:
  active: true
  exclude:
    #  - 'HtmlOutputReport'
    #  - 'TxtOutputReport'
    - 'XmlOutputReport'

comments:
  UndocumentedPublicClass:
    active: true
  UndocumentedPublicFunction:
    active: true

complexity:
  ComplexCondition:
    threshold: 6
  ComplexMethod:
    threshold: 10
    ignoreSingleWhenExpression: true
    ignoreSimpleWhenEntries: true
  LongParameterList:
    threshold: 6
    ignoreDefaultParameters: true
  NestedBlockDepth:
    threshold: 5
  TooManyFunctions:
    thresholdInFiles: 15
    thresholdInClasses: 15
    thresholdInInterfaces: 15
    thresholdInObjects: 15
    thresholdInEnums: 15
    ignoreDeprecated: true
    ignorePrivate: false

exceptions:
  active: true
  ExceptionRaisedInUnexpectedLocation:
    active: true
  PrintStackTrace:
    active: true
  RethrowCaughtException:
    active: true
  ReturnFromFinally:
    active: true
  SwallowedException:
    active: true
  ThrowingExceptionFromFinally:
    active: true
  ThrowingExceptionsWithoutMessageOrCause:
    active: true
  ThrowingNewInstanceOfSameException:
    active: true
  TooGenericExceptionCaught:
    active: true
    exceptionNames:
      - ArrayIndexOutOfBoundsException
      - Error
      - Exception
      - IllegalMonitorStateException
      - NullPointerException
      - IndexOutOfBoundsException
      - RuntimeException
      - Throwable

formatting:
  ImportOrdering:
    active: false # https://github.com/shyiko/ktlint/issues/189
    autoCorrect: true
  MaximumLineLength:
    maxLineLength: 125
  PackageName:
    active: false

naming:
  PackageNaming:
    packagePattern: '^[a-z]+(\.[a-z][_A-Za-z0-9]*)*$'
  TopLevelPropertyNaming:
    privatePropertyPattern: '(_)?[A-Za-z][_A-Za-z0-9]*'

performance:
  active: true
  ArrayPrimitive:
    active: true

potential-bugs:
  EqualsAlwaysReturnsTrueOrFalse:
    active: true
  InvalidRange:
    active: true
  UselessPostfixExpression:
    active: true

style:
  EqualsNullCall:
    active: true
  EqualsOnSignatureLine:
    active: true
  ExplicitItLambdaParameter:
    active: true
  ExpressionBodySyntax:
    active: true
    includeLineWrapping: false
  ForbiddenComment:
    active: false
  ForbiddenImport: # TODO
    active: true
    imports: 'com.sun'
  ForbiddenVoid:
    active: true
  MagicNumber:
    active: false
  MandatoryBracesIfStatements:
    active: true
  MaxLineLength:
    maxLineLength: 125
  NewLineAtEndOfFile:
    active: false
  NoTabs:
    active: true
  PreferToOverPairSyntax:
    active: true
  ProtectedMemberInFinalClass:
    active: true
  RedundantVisibilityModifierRule:
    active: true
  ReturnCount:
    active: false
  ThrowsCount:
    active: true
    max: 4
  UnnecessaryInheritance:
    active: true
  UnnecessaryLet:
    active: true
  UntilInsteadOfRangeTo:
    active: true
  UnusedImports:
    active: true
  UnusedPrivateClass:
    active: true
  UnusedPrivateMember:
    active: true
    allowedNames: "(_|ignored|expected|serialVersionUID)"
  UseDataClass:
    active: true
    excludeAnnotatedClasses: ""
  VarCouldBeVal:
    active: true
  WildcardImport:
    active: false
    excludeImports: 'java.util.*,kotlinx.android.synthetic.*'