detekt.yml

console-reports:
  active: true
  exclude:
    - '' # Exclude nothing -> Enable all workaround

# https://detekt.dev/docs/rules/comments
comments:
  active: true
  KDocReferencesNonPublicProperty:
    active: true
  OutdatedDocumentation:
    active: true

# https://detekt.dev/docs/rules/complexity/#complexcondition
complexity:
  active: true
  # kinda an experiment, let's see how it works
  CognitiveComplexMethod:
    active: true
  ComplexCondition:
    active: true
  ComplexInterface:
    active: true
  CyclomaticComplexMethod:
    active: true
    ignoreSingleWhenExpression: true
  LabeledExpression:
    active: true
  LongMethod:
    active: true
    excludes: [ '**/test/**' ]
  LargeClass:
    active: true
  MethodOverloading:
    active: true
  NamedArguments:
    active: true
  NestedBlockDepth:
    active: true
  NestedScopeFunctions:
    active: true
  StringLiteralDuplication:
    active: true
    excludes: [ '**/test/**' ]
    # TODO
    threshold: 7
    ignoreAnnotation: true
    excludeStringsWithLessThan5Characters: true

# https://detekt.dev/docs/rules/coroutines
coroutines:
  active: true
  GlobalCoroutineUsage:
    active: true
  InjectDispatcher:
    active: true
  RedundantSuspendModifier:
    active: true
  SleepInsteadOfDelay:
    active: true
  SuspendFunSwallowedCancellation:
    active: true
  SuspendFunWithCoroutineScopeReceiver:
    active: true
  SuspendFunWithFlowReturnType:
    active: true

# https://detekt.dev/docs/rules/empty-blocks
empty-blocks:
  active: true
  EmptyCatchBlock:
    active: true
  EmptyClassBlock:
    active: true
  EmptyDefaultConstructor:
    active: true
  EmptyDoWhileBlock:
    active: true
  EmptyElseBlock:
    active: true
  EmptyFinallyBlock:
    active: true
  EmptyForBlock:
    active: true
  EmptyFunctionBlock:
    active: true
    ignoreOverridden: true
  EmptyIfBlock:
    active: true
  EmptyInitBlock:
    active: true
  EmptyKtFile:
    active: true
  EmptySecondaryConstructor:
    active: true
  EmptyTryBlock:
    active: true
  EmptyWhenBlock:
    active: true
  EmptyWhileBlock:
    active: true

# https://detekt.dev/docs/rules/exceptions
exceptions:
  active: true
  ExceptionRaisedInUnexpectedLocation:
    active: true
  # todo
  InstanceOfCheckForException:
    active: false
  # todo
  NotImplementedDeclaration:
    active: false
  ObjectExtendsThrowable:
    active: true
  RethrowCaughtException:
    active: true
  ReturnFromFinally:
    active: true
  # todo
  SwallowedException:
    active: false
  ThrowingExceptionFromFinally:
    active: true
  ThrowingExceptionInMain:
    active: true
  ThrowingExceptionsWithoutMessageOrCause:
    active: true
  ThrowingNewInstanceOfSameException:
    active: true
  # todo
  TooGenericExceptionCaught:
    active: false
  TooGenericExceptionThrown:
    active: true

# https://detekt.dev/docs/rules/formatting
formatting:
  active: true
  AnnotationOnSeparateLine:
    active: true
    indentSize: 2
  AnnotationSpacing:
    active: true
  # todo
  ArgumentListWrapping:
    active: false
  BlockCommentInitialStarAlignment:
    active: true
  ChainWrapping:
    active: true
    indentSize: 2
  ClassName:
    active: true
  CommentSpacing:
    active: true
  CommentWrapping:
    active: true
  DiscouragedCommentLocation:
    active: true
  EnumEntryNameCase:
    active: true
  EnumWrapping:
    active: true
  FunKeywordSpacing:
    active: true
  # todo
  FunctionReturnTypeSpacing:
    active: true
  # todo
  FunctionSignature:
    active: false
  FunctionStartOfBodySpacing:
    active: true
  FunctionTypeReferenceSpacing:
    active: true
  # todo
  IfElseBracing:
    active: false
  # todo
  IfElseWrapping:
    active: false
  ImportOrdering:
    active: true
  Indentation:
    active: true
    indentSize: 2
  KdocWrapping:
    active: true
    indentSize: 2
  ModifierListSpacing:
    active: true
  NoBlankLineBeforeRbrace:
    active: true
  NoBlankLinesInChainedMethodCalls:
    active: true
  NoConsecutiveBlankLines:
    active: true
  NoEmptyClassBody:
    active: true
  NoEmptyFirstLineInClassBody:
    active: true
  NoEmptyFirstLineInMethodBlock:
    active: true
  NoLineBreakAfterElse:
    active: true
  NoLineBreakBeforeAssignment:
    active: true
  NoMultipleSpaces:
    active: true
  NoSemicolons:
    active: true
  NoSingleLineBlockComment:
    active: true
  NoTrailingSpaces:
    active: true
  NoUnitReturn:
    active: true
  NoUnusedImports:
    active: true
  NoWildcardImports:
    active: true
  NullableTypeSpacing:
    active: true
  PackageName:
    active: true
  ParameterListSpacing:
    active: true
  ParameterListWrapping:
    active: true
    indentSize: 2
  SpacingAroundAngleBrackets:
    active: true
  SpacingAroundComma:
    active: true
  SpacingAroundCurly:
    active: true
  SpacingAroundDot:
    active: true
  SpacingAroundDoubleColon:
    active: true
  SpacingAroundKeyword:
    active: true
  SpacingAroundOperators:
    active: true
  SpacingAroundParens:
    active: true
  SpacingAroundRangeOperator:
    active: true
  SpacingAroundUnaryOperator:
    active: true
  SpacingBetweenDeclarationsWithAnnotations:
    active: true
  SpacingBetweenDeclarationsWithComments:
    active: true
  SpacingBetweenFunctionNameAndOpeningParenthesis:
    active: true
  StringTemplate:
    active: true
  StringTemplateIndent:
    active: true
    indentSize: 2
  TrailingCommaOnCallSite:
    active: true
  TrailingCommaOnDeclarationSite:
    active: true
  TryCatchFinallySpacing:
    active: true
    indentSize: 2
  TypeArgumentListSpacing:
    active: true
    indentSize: 2
  TypeParameterListSpacing:
    active: true
    indentSize: 2
  UnnecessaryParenthesesBeforeTrailingLambda:
    active: true
  # todo
  Wrapping:
    active: false

# https://detekt.dev/docs/rules/naming
naming:
  BooleanPropertyNaming:
    active: true
  ClassNaming:
    active: true
  ConstructorParameterNaming:
    active: true
  EnumNaming:
    active: true
  FunctionParameterNaming:
    active: true
  InvalidPackageDeclaration:
    active: true
  LambdaParameterNaming:
    active: true
  MatchingDeclarationName:
    active: true
  MemberNameEqualsClassName:
    active: true
  NoNameShadowing:
    active: true
  NonBooleanPropertyPrefixedWithIs:
    active: true
  ObjectPropertyNaming:
    active: true
  PackageNaming:
    active: true
  # todo
  TopLevelPropertyNaming:
    active: false
  VariableNaming:
    active: true

# https://detekt.dev/docs/rules/performance
performance:
  ArrayPrimitive:
    active: true
  CouldBeSequence:
    active: true
  ForEachOnRange:
    active: true
  # todo
  SpreadOperator:
    active: false
  UnnecessaryPartOfBinaryExpression:
    active: true
  UnnecessaryTemporaryInstantiation:
    active: true

# https://detekt.dev/docs/rules/potential-bugs
potential-bugs:
  AvoidReferentialEquality:
    active: true
  CastToNullableType:
    active: true
  Deprecation:
    active: true
  DontDowncastCollectionTypes:
    active: true
  DoubleMutabilityForCollection:
    active: true
  ElseCaseInsteadOfExhaustiveWhen:
    active: true
  EqualsAlwaysReturnsTrueOrFalse:
    active: true
  EqualsWithHashCodeExist:
    active: true
  ExitOutsideMain:
    active: true
  HasPlatformType:
    active: true
  IgnoredReturnValue:
    active: true
  ImplicitDefaultLocale:
    active: true
  ImplicitUnitReturnType:
    active: true
  InvalidRange:
    active: true
  IteratorHasNextCallsNextMethod:
    active: true
  IteratorNotThrowingNoSuchElementException:
    active: true
  MapGetWithNotNullAssertionOperator:
    active: true
  MissingPackageDeclaration:
    active: true
  NullCheckOnMutableProperty:
    active: true
  NullableToStringCall:
    active: true
  PropertyUsedBeforeDeclaration:
    active: true
  UnconditionalJumpStatementInLoop:
    active: true
  UnnecessaryNotNullOperator:
    active: true
  UnnecessarySafeCall:
    active: true
  UnreachableCatchBlock:
    active: true
  UnreachableCode:
    active: true
  UnsafeCallOnNullableType:
    active: true
  UnsafeCast:
    active: true
  UnusedUnaryOperator:
    active: true
  UselessPostfixExpression:
    active: true
  WrongEqualsTypeParameter:
    active: true

# https://detekt.dev/docs/rules/style
style:
  AlsoCouldBeApply:
    active: true
  CanBeNonNullable:
    active: true
  CascadingCallWrapping:
    active: true
    includeElvis: false
  # todo
  ClassOrdering:
    active: false
  CollapsibleIfStatements:
    active: true
  # todo
  DataClassContainsFunctions:
    active: false
    allowOperators: true
  DestructuringDeclarationWithTooManyEntries:
    active: true
  DoubleNegativeLambda:
    active: true
  EqualsNullCall:
    active: true
  EqualsOnSignatureLine:
    active: true
  ExplicitCollectionElementAccessMethod:
    active: true
  ExplicitItLambdaParameter:
    active: true
  ExpressionBodySyntax:
    active: true
  ForbiddenVoid:
    active: true
  FunctionOnlyReturningConstant:
    active: true
  LoopWithTooManyJumpStatements:
    active: true
  # todo
  MagicNumber:
    active: false
  MandatoryBracesLoops:
    active: true
  MaxChainedCallsOnSameLine:
    active: true
  MaxLineLength:
    active: true
    maxLineLength: 120
    excludes:
      - '**/test/**'
    excludeCommentStatements: true
  MayBeConst:
    active: true
  ModifierOrder:
    active: true
  MultilineLambdaItParameter:
    active: true
  MultilineRawStringIndentation:
    active: true
    indentSize: 2
  NestedClassesVisibility:
    active: true
  NewLineAtEndOfFile:
    active: true
  NoTabs:
    active: true
  NullableBooleanCheck:
    active: true
  ObjectLiteralToLambda:
    active: true
  OptionalAbstractKeyword:
    active: true
  # todo
  OptionalUnit:
    active: false
  PreferToOverPairSyntax:
    active: true
  ProtectedMemberInFinalClass:
    active: true
  RedundantExplicitType:
    active: true
  RedundantHigherOrderMapUsage:
    active: true
  SafeCast:
    active: true
  SerialVersionUIDInSerializableClass:
    active: true
  SpacingBetweenPackageAndImports:
    active: true
  StringShouldBeRawString:
    active: true
  TrailingWhitespace:
    active: true
  TrimMultilineRawString:
    active: true
  UnderscoresInNumericLiterals:
    active: true
  UnnecessaryAbstractClass:
    active: true
  UnnecessaryAnnotationUseSiteTarget:
    active: true
  UnnecessaryApply:
    active: true
  UnnecessaryBackticks:
    active: true
  UnnecessaryBracesAroundTrailingLambda:
    active: true
  UnnecessaryFilter:
    active: true
  UnnecessaryInheritance:
    active: true
  UnnecessaryInnerClass:
    active: true
  UnnecessaryLet:
    active: true
  UnnecessaryParentheses:
    active: true
  UntilInsteadOfRangeTo:
    active: true
  UnusedImports:
    active: true
  UnusedParameter:
    active: true
  UnusedPrivateClass:
    active: true
  UnusedPrivateMember:
    active: true
  UnusedPrivateProperty:
    active: true
  UseAnyOrNoneInsteadOfFind:
    active: true
  UseArrayLiteralsInAnnotations:
    active: true
  UseCheckNotNull:
    active: true
  UseCheckOrError:
    active: true
  # TODO
  UseDataClass:
    active: true
    allowVars: true
  UseEmptyCounterpart:
    active: true
  UseIfEmptyOrIfBlank:
    active: true
  UseIsNullOrEmpty:
    active: true
  UseOrEmpty:
    active: true
  UseRequire:
    active: true
  UseRequireNotNull:
    active: true
  UseSumOfInsteadOfFlatMapSize:
    active: true
  UselessCallOnNotNull:
    active: true
  UtilityClassWithPublicConstructor:
    active: true
  VarCouldBeVal:
    active: true
    ignoreLateinitVar: false
  WildcardImport:
    active: true