detekt.yaml

complexity:
  active: true
  ComplexCondition:
    active: true
    threshold: 9
  ComplexInterface:
    active: true
    threshold: 10
    includeStaticDeclarations: false
  CyclomaticComplexMethod:
    active: true
    threshold: 180
    ignoreSingleWhenExpression: false
    ignoreSimpleWhenEntries: false
  LabeledExpression:
    active: false
  LargeClass:
    active: true
    threshold: 300
    excludes: ["**/*Test.kt"]
  LongMethod:
    active: true
    threshold: 100
    excludes:
      ["**/*Test.kt"]
  LongParameterList:
    active: false
    ignoreDefaultParameters: false
  MethodOverloading:
    active: false
    threshold: 6
  NestedBlockDepth:
    active: false
    threshold: 4
  StringLiteralDuplication:
    active: false
    threshold: 3
    ignoreAnnotation: true
    excludeStringsWithLessThan5Characters: true
    ignoreStringsRegex: $^
  TooManyFunctions:
    active: false
    thresholdInFiles: 11
    thresholdInClasses: 11
    thresholdInInterfaces: 11
    thresholdInObjects: 11
    thresholdInEnums: 11
    ignoreDeprecated: false
    ignorePrivate: false

empty-blocks:
  EmptyTryBlock:
    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
    ignoreOverridden: true
  EmptyIfBlock:
    active: true
  EmptyInitBlock:
    active: true
  EmptyKtFile:
    active: true
    excludes: ["**/build.gradle.kts"]
  EmptySecondaryConstructor:
    active: true
  EmptyWhenBlock:
    active: true
  EmptyWhileBlock:
    active: true

exceptions:
  active: false

FaireRuleSet:
  active: true
  AlwaysUseIsTrueOrIsFalse:
    active: true
    autoCorrect: true
  DoNotAccessVisibleForTesting:
    active: true
    excludes: ["**/*Test.kt"]
  DoNotSplitByRegex:
    active: true
  DoNotUseDirectReceiverReferenceInsideWith:
    active: true
  DoNotUseHasSizeForEmptyListInAssert:
    active: true
    autoCorrect: true
  DoNotUseIsEqualToWhenArgumentIsOne:
    active: true
    autoCorrect: true
  DoNotUseIsEqualToWhenArgumentIsZero:
    active: true
    autoCorrect: true
  DoNotUsePropertyAccessInAssert:
    active: true
    autoCorrect: true
  DoNotUseSingleOnFilter:
    active: true
    autoCorrect: true
  DoNotUseSizePropertyInAssert:
    active: true
  GetOrDefaultShouldBeReplacedWithGetOrElse:
    active: true
  NoDuplicateKeysInMapOf:
    active: true
  NoExtensionFunctionOnNullableReceiver:
    active: true
  NoNonPrivateGlobalVariables:
    active: true
  NoNullableLambdaWithDefaultNull:
    active: true
  NoPairWithAmbiguousTypes:
    active: true
  PreferIgnoreCase:
    active: true
    autoCorrect: true
  PreventBannedImports:
    # until we have an import to prevent, just disable this rule
    active: false
    autoCorrect: true
  ReturnValueOfLetMustBeUsed:
    active: true
  UseEntriesInsteadOfValuesOnEnum:
    active: true
  UseFirstOrNullInsteadOfFind:
    active: true
    autoCorrect: true
  UseMapNotNullInsteadOfFilterNotNull:
    active: true
    autoCorrect: true
  UseOfCollectionInsteadOfEmptyCollection:
    active: true
    autoCorrect: true
  UseSetInsteadOfListToSet:
    active: true
    autoCorrect: true

formatting:
  active: true
  android: false
  autoCorrect: true
  AnnotationOnSeparateLine:
    active: false
  AnnotationSpacing:
    active: false
  ArgumentListWrapping:
    active: false
  ChainWrapping:
    active: false
    autoCorrect: true
  CommentSpacing:
    active: true
    autoCorrect: true
  EnumEntryNameCase:
    active: true
    ignoreAnnotated: [kotlin.Deprecated]
  # Use MatchingDeclarationName instead.
  Filename:
    active: false
  FinalNewline:
    active: true
    autoCorrect: true
  ImportOrdering:
    active: true
    autoCorrect: true
  Indentation:
    active: false
    autoCorrect: true
    indentSize: 4
  # Use MaxLineLength instead.
  MaximumLineLength:
    active: false
    maxLineLength: 120
  ModifierOrdering:
    active: true
    autoCorrect: true
  MultiLineIfElse:
    active: true
    autoCorrect: true
  NoAnonymousArgumentAfterNamedArguments:
    active: true
  NoBlankLineBeforeRbrace:
    active: true
    autoCorrect: true
  NoConsecutiveBlankLines:
    active: true
    autoCorrect: true
  NoCreateWithPrefix:
    active: true
  NoEmptyClassBody:
    active: true
    autoCorrect: true
  NoEmptyFirstLineInMethodBlock:
    active: 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: true
    autoCorrect: true
  PackageName:
    active: false
    autoCorrect: true
  ParameterListWrapping:
    active: true
    autoCorrect: true
  SpacingAroundAngleBrackets:
    active: true
    autoCorrect: true
  SpacingAroundColon:
    active: true
    autoCorrect: true
  SpacingAroundComma:
    active: true
    autoCorrect: true
  SpacingAroundCurly:
    active: true
    autoCorrect: true
  SpacingAroundKeyword:
    active: true
    autoCorrect: true
  SpacingAroundOperators:
    active: true
    autoCorrect: true
  SpacingAroundParens:
    active: true
    autoCorrect: true
  SpacingAroundRangeOperator:
    active: true
    autoCorrect: true
  SpacingBetweenDeclarationsWithAnnotations:
    active: false
  SpacingBetweenDeclarationsWithComments:
    active: false
  StringTemplate:
    active: true
    autoCorrect: true
  TrailingCommaOnCallSite:
    active: true
    autoCorrect: true
  TrailingCommaOnDeclarationSite:
    active: true
    autoCorrect: true
  Wrapping:
    active: true
  UnnecessaryParenthesesBeforeTrailingLambda:
    active: true
  PropertyWrapping:
    active: true
    excludes:
      - "**/*Test.kt"
  FunctionReturnTypeSpacing:
    active: true
  BlockCommentInitialStarAlignment:
    active: true
  CommentWrapping:
    active: true

naming:
  active: true
  ClassNaming:
    active: true
    classPattern: "[A-Z$][a-zA-Z0-9$]*"
  ConstructorParameterNaming:
    active: false
    parameterPattern: "[a-z][A-Za-z0-9]*"
    privateParameterPattern: "[a-z][A-Za-z0-9]*"
    excludeClassPattern: $^
  EnumNaming:
    active: false
    enumEntryPattern: ^[A-Z][_a-zA-Z0-9]*
  ForbiddenClassName:
    active: false
  FunctionMaxLength:
    active: false
    maximumFunctionNameLength: 30
  FunctionMinLength:
    active: false
    minimumFunctionNameLength: 3
  FunctionNaming:
    active: false
    functionPattern: ^([a-z$][a-zA-Z$0-9]*)|(`.*`)$
    excludeClassPattern: $^
  FunctionParameterNaming:
    active: false
    parameterPattern: "[a-z][A-Za-z0-9]*"
    excludeClassPattern: $^
  InvalidPackageDeclaration:
    active: true
  MatchingDeclarationName:
    active: true
  MemberNameEqualsClassName:
    active: false
    ignoreOverridden: true
  NoNameShadowing:
    active: true
  ObjectPropertyNaming:
    active: true
    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
    packagePattern: ^[a-z]+(\.[a-z][a-zA-Z0-9_]*)*$
  TopLevelPropertyNaming:
    active: false
    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: 64
  VariableMinLength:
    active: false
    minimumVariableNameLength: 1
  VariableNaming:
    active: false
    variablePattern: "[a-z][A-Za-z0-9]*"
    privateVariablePattern: (_)?[a-z][A-Za-z0-9]*
    excludeClassPattern: $^

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

potential-bugs:
  active: true
  AvoidReferentialEquality:
    active: true
  CastToNullableType:
    active: false
  DoubleMutabilityForCollection:
    active: false
  EqualsAlwaysReturnsTrueOrFalse:
    active: true
  EqualsWithHashCodeExist:
    active: false
  ExplicitGarbageCollectionCall:
    active: true
  HasPlatformType:
    active: true
    excludes: ["**/*Test.kt"]
  IgnoredReturnValue:
    active: true
  ImplicitDefaultLocale:
    active: false
  InvalidRange:
    active: true
  IteratorHasNextCallsNextMethod:
    active: false
  IteratorNotThrowingNoSuchElementException:
    active: false
  LateinitUsage:
    active: false
    ignoreAnnotated: [""]
    ignoreOnClassesPattern: ""
  MapGetWithNotNullAssertionOperator:
    active: true
  MissingPackageDeclaration:
    active: true
  UnconditionalJumpStatementInLoop:
    active: false
  UnnecessaryNotNullOperator:
    active: true
  UnnecessarySafeCall:
    active: true
  UnreachableCode:
    active: true
  UnsafeCallOnNullableType:
    active: false
  UnsafeCast:
    active: false
  UselessPostfixExpression:
    active: true
  WrongEqualsTypeParameter:
    active: true

style:
  active: true
  ClassOrdering:
    active: false
  CollapsibleIfStatements:
    active: false
  DataClassContainsFunctions:
    active: false
    conversionFunctionPrefix: [to]
  DataClassShouldBeImmutable:
    active: false
  DestructuringDeclarationWithTooManyEntries:
    active: false
  EqualsNullCall:
    active: true
  EqualsOnSignatureLine:
    active: false
  ExplicitItLambdaParameter:
    active: true
  ExpressionBodySyntax:
    active: false
    includeLineWrapping: false
  ForbiddenComment:
    active: false
    comments:
      - reason: ""
        value: "TODO:"
      - reason: ""
        value: "FIXME:"
      - reason: ""
        value: "STOPSHIP:"
  # We use PreventBannedImports instead which has autocorrect.
  ForbiddenImport:
    active: false
    imports: []
  ForbiddenMethodCall:
    active: false
  ForbiddenVoid:
    active: false
  FunctionOnlyReturningConstant:
    active: false
    ignoreOverridableFunction: true
    excludedFunctions: [describeContents]
  LoopWithTooManyJumpStatements:
    active: false
    maxJumpCount: 1
  MagicNumber:
    active: false
    ignoreNumbers: ["-1", "0", "1", "2"]
    ignoreHashCodeFunction: true
    ignorePropertyDeclaration: false
    ignoreConstantDeclaration: true
    ignoreCompanionObjectPropertyDeclaration: true
    ignoreAnnotation: false
    ignoreNamedArgument: true
    ignoreEnums: false
  BracesOnIfStatements:
    active: false
    singleLine: always
    multiLine: always
  MaxLineLength:
    active: true
    maxLineLength: 120
    excludePackageStatements: true
    excludeImportStatements: true
    excludeCommentStatements: false
  MayBeConst:
    active: false
  ModifierOrder:
    active: true
  MultilineLambdaItParameter:
    active: true
  NestedClassesVisibility:
    active: false
  # Use FinalNewLine instead.
  NewLineAtEndOfFile:
    active: false
  NoTabs:
    active: false
  ObjectLiteralToLambda:
    active: true
  OptionalAbstractKeyword:
    active: true
  OptionalUnit:
    active: false
  PreferToOverPairSyntax:
    active: false
  ProtectedMemberInFinalClass:
    active: false
  RedundantVisibilityModifierRule:
    active: true
  ReturnCount:
    active: false
    max: 2
    excludedFunctions: [equals]
    excludeLabeled: false
    excludeReturnFromLambda: true
  SafeCast:
    active: true
  SerialVersionUIDInSerializableClass:
    active: false
  SpacingBetweenPackageAndImports:
    active: false
  ThrowsCount:
    active: false
    max: 2
  TrailingWhitespace:
    active: true
  UnnecessaryFilter:
    active: true
  UnderscoresInNumericLiterals:
    active: false
  UnnecessaryAbstractClass:
    active: false
    ignoreAnnotated: [dagger.Module]
  UnnecessaryApply:
    active: false
  UnnecessaryInheritance:
    active: false
  UnnecessaryAnnotationUseSiteTarget:
    active: false
  UnnecessaryLet:
    active: true
  UnnecessaryParentheses:
    active: false
  UntilInsteadOfRangeTo:
    active: false
  UnusedImports:
    # Has false positives with type resolution enabled. Redundant with NoUnusedImports rule.
    active: false
  UnusedPrivateClass:
    active: false
  UnusedPrivateMember:
    active: true
    allowedNames: (_|i|ignored|expected|serialVersionUID|session|module)
  # Replaced by UseFirstOrNullInsteadOfFind
  UseAnyOrNoneInsteadOfFind:
    active: false
  UseCheckNotNull:
    active: true
  UseCheckOrError:
    active: false
  UseDataClass:
    active: false
    ignoreAnnotated: [""]
  UseIfInsteadOfWhen:
    active: false
  UseIsNullOrEmpty:
    active: true
  UseOrEmpty:
    active: true
  UseRequire:
    active: true
  UseRequireNotNull:
    active: true
  UselessCallOnNotNull:
    active: true
  UtilityClassWithPublicConstructor:
    active: false
  VarCouldBeVal:
    active: true
    ignoreAnnotated: [Column, Inject, JoinColumn, OneToMany, Parameter]
  WildcardImport:
    active: true
    excludeImports: [java.util.*, kotlinx.android.synthetic.*]
  UnusedPrivateProperty:
    active: true
    allowedNames: _|ignored|expected|serialVersionUID|module|i|gson|env
  UnusedParameter:
    active: true
    allowedNames: session|witness

coroutines:
  active: false

compiler:
  CompilerWarning:
    active: true
    ignoreDiagnostic:
      - OPT_IN_IS_NOT_ENABLED
      - DEPRECATION
      - OVERRIDE_DEPRECATION
      - UNCHECKED_CAST
      - NAME_SHADOWING
      - PARAMETER_NAME_CHANGED_ON_OVERRIDE
      - JAVA_CLASS_ON_COMPANION
      - EXTENSION_SHADOWED_BY_MEMBER
      - TYPEALIAS_EXPANSION_DEPRECATION
      - WRONG_TYPE_PARAMETER_NULLABILITY_FOR_JAVA_OVERRIDE
      - NULLABLE_TYPE_PARAMETER_AGAINST_NOT_NULL_TYPE_PARAMETER
      - OPT_IN_USAGE
      - OPT_IN_OVERRIDE
      - DANGEROUS_CHARACTERS
      - NO_REFLECTION_IN_CLASS_PATH
      - UNNECESSARY_LATEINIT