detekt.yml

# Overrides the defaults specified in https://github.com/detekt/detekt/blob/master/detekt-core/src/main/resources/default-detekt-config.yml

config:
  validation: true
  warningsAsErrors: true

import:
  EnforceStaticImport:
    active: true
    methods:
      - 'com.google.common.truth.Truth.assertThat'
      - 'org.junit.jupiter.params.provider.Arguments.arguments'

comments:
  active: true
  EndOfSentenceFormat:
    active: true
    excludes: ['**/test/**']
    endOfSentenceFormat: '([.?!][ \t\n\r\f<])|([.?!:]$)'
  UndocumentedPublicClass:
    active: true
    excludes: ['**/test/**']
    searchInNestedClass: true
    searchInInnerClass: true
    searchInInnerObject: true
    searchInInnerInterface: true
  UndocumentedPublicFunction:
    active: true
    excludes: ['**/test/**']
  UndocumentedPublicProperty:
    active: true
    excludes: ['**/test/**']

complexity:
  active: false

exceptions:
  active: true
  InstanceOfCheckForException:
    active: true
  ObjectExtendsThrowable:
    active: true
  ThrowingExceptionsWithoutMessageOrCause:
    active: true
  TooGenericExceptionCaught:
    active: true
    exceptionNames:
      - ArrayIndexOutOfBoundsException
      - Error
      - Exception
      - IllegalMonitorStateException
      - NullPointerException
      - IndexOutOfBoundsException
      - RuntimeException
      - Throwable
    allowedExceptionNameRegex: '_|(ignore|expected|cause).*'

# The naming rules exclude test classes by default. Since we want naming rules to apply
# to test classes, we need to override the default exclude rules with an empty list.
naming:
  active: true
  ClassNaming:
    excludes: []
  ConstructorParameterNaming:
    excludes: []
  EnumNaming:
    excludes: []
  InvalidPackageDeclaration:
    active: true
    excludes: ['*.kts']
  ObjectPropertyNaming:
    excludes: []
  PackageNaming:
    excludes: []
  TopLevelPropertyNaming:
    excludes: []
  VariableNaming:
    excludes: []

potential-bugs:
  active: true
  CastToNullableType:
    active: true
  DontDowncastCollectionTypes:
    active: true
  DoubleMutabilityForCollection:
    active: true
    # Test directories might want to reassign variables for result collections
    excludes: [ '**/test/**' ]
  ElseCaseInsteadOfExhaustiveWhen:
    active: true
  ExitOutsideMain:
    active: true
  IgnoredReturnValue:
    active: true
    restrictToConfig: true
    returnValueAnnotations: ['*.CheckReturnValue', '*.CheckResult']
  MapGetWithNotNullAssertionOperator:
    active: true
    # test directories will want to throw NPE's with maps
    excludes: [ '**/test/**' ]
  NullableToStringCall:
    active: true
    ignoreFunction:
      - 'toString()'
  NullCheckOnMutableProperty:
    active: true
  PropertyUsedBeforeDeclaration:
    active: true
  UnconditionalJumpStatementInLoop:
    active: true
  UnnecessaryNotNullCheck:
    active: true

style:
  active: true
  ClassOrdering:
    active: true
  CollapsibleIfStatements:
    active: true
  DataClassShouldBeImmutable:
    active: true
  DestructuringDeclarationWithTooManyEntries:
    active: true
    maxDestructuringEntries: 4
  DoubleNegativeLambda:
    active: true
  EqualsOnSignatureLine:
    active: true
  ExplicitCollectionElementAccessMethod:
    active: true
  ExpressionBodySyntax:
    active: true
    includeLineWrapping: true
  ForbiddenAnnotation:
    active: true
  ForbiddenImport:
    active: true
    imports:
      - 'org.junit.Assert'
      - 'org.junit.Test'
      - 'org.junit.Before'
      - 'org.junit.BeforeClass'
      - 'org.junit.After'
      - 'org.junit.AfterClass'
      - 'org.junit.jupiter.api.Assertions'
    forbiddenPatterns: '(?:junit\.framework|org\.junit\.jupiter\.api\.Assertions)\.(?!assertThrows).+'
  ForbiddenComment:
    comments:
      - reason: 'Forbidden FIXME todo marker in comment, please fix the problem.'
        value: 'FIXME'
      - reason: 'Forbidden STOPSHIP todo marker in comment, please address the problem before shipping the code.'
        value: 'STOPSHIP'
      - reason: 'Authors are not recorded in KDoc.'
        value: '@author'
  ForbiddenMethodCall:
    active: true
    excludes: [ '**/test/**' ]
    methods:
      - 'kotlin.io.println'
      - 'kotlin.io.print'
      - 'java.nio.file.Path.toFile'
  ForbiddenVoid:
    active: true
    ignoreOverridden: false
    ignoreUsageInGenerics: false
  LoopWithTooManyJumpStatements:
    maxJumpCount: 3
  BracesOnIfStatements:
    active: true
  BracesOnWhenStatements:
    active: true
    multiLine: 'necessary'
  MandatoryBracesLoops:
    active: true
  MaxLineLength:
    # Specified by editorconfig & enforced by ktlint
    active: false
  NewLineAtEndOfFile:
    # Specified by editorconfig & enforced by ktlint
    active: false
  NullableBooleanCheck:
    active: true
  RedundantExplicitType:
    active: true
  RedundantVisibilityModifierRule:
    active: false
  ReturnCount:
    active: false
  SpacingBetweenPackageAndImports:
    active: true
  UnderscoresInNumericLiterals:
    active: true
    acceptableLength: 5
  UnnecessaryBackticks:
    active: true
  # Disabled because it produces false positive when using JUnit's @Nested classes
  UnnecessaryInnerClass:
    active: false
  UnnecessaryLet:
    active: true
  UntilInsteadOfRangeTo:
    active: true
  UseEmptyCounterpart:
    active: true
  UseIfEmptyOrIfBlank:
    active: true
  UseIfInsteadOfWhen:
    active: true
    ignoreWhenContainingVariableDeclaration: true
  UseLet:
    active: true
  UseRequireNotNull:
    active: true
  UseSumOfInsteadOfFlatMapSize:
    active: true
  UnnecessaryBracesAroundTrailingLambda:
    active: true
  WildcardImport:
    # Specified by editorconfig and enforced by ktlint
    active: false
  MagicNumber:
    # We usually catch these in code review, and more often than not, the constants aren't very magical
    active: false

performance:
  UnnecessaryPartOfBinaryExpression:
    active: true