detekt.yml

#
# The MIT License
#
# Copyright 2022 Noor Dawod. All rights reserved.
#
# Permission is hereby granted, free of charge, to any person obtaining a copy of
# this software and associated documentation files (the "Software"), to deal in
# the Software without restriction, including without limitation the rights to
# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
# of the Software, and to permit persons to whom the Software is furnished to do
# so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
#

build:
  maxIssues: 0
  excludeCorrectable: false

config:
  validation: true
  # When writing own rules with new properties, exclude the property path e.g.:
  # "my_rule_set,.*>.*>[my_property]"
  excludes: ""

processors:
  active: true
  exclude:
    - "DetektProgressListener"

console-reports:
  active: true
  exclude:
    - "ProjectStatisticsReport"
    - "ComplexityReport"
    - "NotificationReport"
    - "FileBasedFindingsReport"

comments:
  active: true
  excludes:
    - "**/test/**"
    - "**/androidTest/**"
    - "**/*.Test.kt"
    - "**/*.Spec.kt"
    - "**/*.Spek.kt"
  CommentOverPrivateFunction:
    active: false
  CommentOverPrivateProperty:
    active: false
  EndOfSentenceFormat:
    active: true
    endOfSentenceFormat: ([.?!][ \t\n\r\f<])|([.?!:]$)
  UndocumentedPublicClass:
    active: true
    searchInNestedClass: true
    searchInInnerClass: true
    searchInInnerObject: true
    searchInInnerInterface: true
  UndocumentedPublicFunction:
    active: false
  UndocumentedPublicProperty:
    active: true

complexity:
  active: true
  ComplexCondition:
    active: true
    threshold: 4
  ComplexInterface:
    active: true
    threshold: 15
    includeStaticDeclarations: false
  CyclomaticComplexMethod:
    active: true
    threshold: 15
    ignoreSingleWhenExpression: false
    ignoreSimpleWhenEntries: false
    ignoreNestingFunctions: false
    nestingFunctions:
      - "run"
      - "let"
      - "apply"
      - "with"
      - "also"
      - "use"
      - "forEach"
      - "isNotNull"
      - "ifNull"
  LabeledExpression:
    active: true
  LargeClass:
    active: true
    threshold: 600
  LongMethod:
    active: true
    threshold: 60
  LongParameterList:
    active: true
    functionThreshold: 6
    constructorThreshold: 6
    ignoreDefaultParameters: false
  MethodOverloading:
    active: false
  NestedBlockDepth:
    active: true
    threshold: 4
  StringLiteralDuplication:
    active: true
    excludes:
      - "**/test/**"
      - "**/androidTest/**"
      - "**/*.Test.kt"
      - "**/*.Spec.kt"
      - "**/*.Spek.kt"
    threshold: 3
    ignoreAnnotation: true
    excludeStringsWithLessThan5Characters: true
    ignoreStringsRegex: '$^'
  TooManyFunctions:
    active: false

coroutines:
  active: true
  GlobalCoroutineUsage:
    active: true
  RedundantSuspendModifier:
    active: true

empty-blocks:
  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: false
  EmptyIfBlock:
    active: true
  EmptyInitBlock:
    active: true
  EmptyKtFile:
    active: true
  EmptySecondaryConstructor:
    active: true
  EmptyWhenBlock:
    active: true
  EmptyWhileBlock:
    active: true

exceptions:
  active: true
  ExceptionRaisedInUnexpectedLocation:
    active: true
    methodNames:
      - "toString"
      - "hashCode"
      - "equals"
      - "finalize"
  InstanceOfCheckForException:
    active: true
    excludes:
      - "**/test/**"
      - "**/androidTest/**"
      - "**/*.Test.kt"
      - "**/*.Spec.kt"
      - "**/*.Spek.kt"
  NotImplementedDeclaration:
    active: true
  PrintStackTrace:
    active: true
  RethrowCaughtException:
    active: true
  ReturnFromFinally:
    active: true
    ignoreLabeled: false
  SwallowedException:
    active: true
    ignoredExceptionTypes:
      - "InterruptedException"
      - "NumberFormatException"
      - "ParseException"
      - "MalformedURLException"
    allowedExceptionNameRegex: '^(_|(ignore|expected).*)'
  ThrowingExceptionFromFinally:
    active: true
  ThrowingExceptionInMain:
    active: true
  ThrowingExceptionsWithoutMessageOrCause:
    active: true
    exceptions:
      - "IllegalArgumentException"
      - "IllegalStateException"
      - "IOException"
  ThrowingNewInstanceOfSameException:
    active: true
  TooGenericExceptionCaught:
    active: true
    excludes:
      - "**/test/**"
      - "**/androidTest/**"
      - "**/*.Test.kt"
      - "**/*.Spec.kt"
      - "**/*.Spek.kt"
    exceptionNames:
      - ArrayIndexOutOfBoundsException
      - Error
      - Exception
      - IllegalMonitorStateException
      - NullPointerException
      - IndexOutOfBoundsException
      - RuntimeException
      - Throwable
    allowedExceptionNameRegex: '^(_|(ignore|expected).*)'
  TooGenericExceptionThrown:
    active: true
    exceptionNames:
      - Error
      - Exception
      - Throwable
      - RuntimeException

libraries:
  active: true
  ForbiddenPublicDataClass:
    active: false
  LibraryEntitiesShouldNotBePublic:
    active: false
  LibraryCodeMustSpecifyReturnType:
    active: true

formatting:
  active: true
  android: false
  autoCorrect: true
  AnnotationOnSeparateLine:
    active: false
  ChainWrapping:
    active: true
    autoCorrect: true
  CommentSpacing:
    active: true
    autoCorrect: true
  EnumEntryNameCase:
    active: true
    autoCorrect: true
  Filename:
    active: true
  FinalNewline:
    active: true
    autoCorrect: true
  ImportOrdering:
    active: true
    autoCorrect: true
    layout: "*" # Keep it the same as value of "ij_kotlin_imports_layout" in .editorconfig.
  Indentation:
    active: true
    autoCorrect: true
    indentSize: 2
  FunctionReturnTypeSpacing:
    active: true
  FunctionStartOfBodySpacing:
    active: true
  MaximumLineLength:
    active: true
    maxLineLength: 100
  NullableTypeSpacing:
    active: true
  ParameterListSpacing:
    active: true
  SpacingBetweenFunctionNameAndOpeningParenthesis:
    active: true
  TypeParameterListSpacing:
    active: true
  ModifierOrdering:
    active: true
    autoCorrect: true
  MultiLineIfElse:
    active: true
    autoCorrect: true
  NoBlankLineBeforeRbrace:
    active: true
    autoCorrect: true
  NoConsecutiveBlankLines:
    active: true
    autoCorrect: true
  NoEmptyClassBody:
    active: true
    autoCorrect: true
  NoEmptyFirstLineInMethodBlock:
    active: true
    autoCorrect: 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
  PackageName:
    active: true
    autoCorrect: true
  ParameterListWrapping:
    active: true
    autoCorrect: true
  SpacingAroundColon:
    active: true
    autoCorrect: true
  SpacingAroundComma:
    active: true
    autoCorrect: true
  SpacingAroundCurly:
    active: true
    autoCorrect: true
  SpacingAroundDot:
    active: true
    autoCorrect: true
  SpacingAroundKeyword:
    active: true
    autoCorrect: true
  SpacingAroundOperators:
    active: true
    autoCorrect: true
  SpacingAroundParens:
    active: true
    autoCorrect: true
  SpacingAroundRangeOperator:
    active: true
    autoCorrect: true
  StringTemplate:
    active: true
    autoCorrect: true

naming:
  active: true
  ClassNaming:
    active: true
    excludes:
      - "**/test/**"
      - "**/androidTest/**"
      - "**/*.Test.kt"
      - "**/*.Spec.kt"
      - "**/*.Spek.kt"
    classPattern: '[A-Z$][a-zA-Z0-9$]*'
  ConstructorParameterNaming:
    active: true
    excludes:
      - "**/test/**"
      - "**/androidTest/**"
      - "**/*.Test.kt"
      - "**/*.Spec.kt"
      - "**/*.Spek.kt"
    parameterPattern: '[a-z][A-Za-z0-9]*'
    privateParameterPattern: '[a-z][A-Za-z0-9]*'
    excludeClassPattern: '$^'
  EnumNaming:
    active: true
    excludes:
      - "**/test/**"
      - "**/androidTest/**"
      - "**/*.Test.kt"
      - "**/*.Spec.kt"
      - "**/*.Spek.kt"
    enumEntryPattern: '^[A-Z][_a-zA-Z0-9]*'
  ForbiddenClassName:
    active: true
    excludes:
      - "**/test/**"
      - "**/androidTest/**"
      - "**/*.Test.kt"
      - "**/*.Spec.kt"
      - "**/*.Spek.kt"
  FunctionMaxLength:
    active: true
    excludes:
      - "**/test/**"
      - "**/androidTest/**"
      - "**/*.Test.kt"
      - "**/*.Spec.kt"
      - "**/*.Spek.kt"
    maximumFunctionNameLength: 30
  FunctionMinLength:
    active: true
    excludes:
      - "**/test/**"
      - "**/androidTest/**"
      - "**/*.Test.kt"
      - "**/*.Spec.kt"
      - "**/*.Spek.kt"
    minimumFunctionNameLength: 2
  FunctionNaming:
    active: true
    excludes:
      - "**/test/**"
      - "**/androidTest/**"
      - "**/*.Test.kt"
      - "**/*.Spec.kt"
      - "**/*.Spek.kt"
    functionPattern: '^([a-z$][a-zA-Z$0-9]*)|(`.*`)$'
    excludeClassPattern: '$^'
  FunctionParameterNaming:
    active: true
    excludes:
      - "**/test/**"
      - "**/androidTest/**"
      - "**/*.Test.kt"
      - "**/*.Spec.kt"
      - "**/*.Spek.kt"
    parameterPattern: '[a-z][A-Za-z0-9]*'
    excludeClassPattern: '$^'
  InvalidPackageDeclaration:
    active: true
    rootPackage: ''
  MatchingDeclarationName:
    active: true
  MemberNameEqualsClassName:
    active: true
    ignoreOverridden: true
  ObjectPropertyNaming:
    active: true
    excludes:
      - "**/test/**"
      - "**/androidTest/**"
      - "**/*.Test.kt"
      - "**/*.Spec.kt"
      - "**/*.Spek.kt"
    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
    excludes:
      - "**/test/**"
      - "**/androidTest/**"
      - "**/*.Test.kt"
      - "**/*.Spec.kt"
      - "**/*.Spek.kt"
    packagePattern: '^[a-z]+(\.[a-z][A-Za-z0-9]*)*$'
  TopLevelPropertyNaming:
    active: true
    excludes:
      - "**/test/**"
      - "**/androidTest/**"
      - "**/*.Test.kt"
      - "**/*.Spec.kt"
      - "**/*.Spek.kt"
    constantPattern: '[A-Z][_A-Z0-9]*'
    propertyPattern: '[A-Za-z][_A-Za-z0-9]*'
    privatePropertyPattern: '_?[A-Za-z][_A-Za-z0-9]*'
  VariableMaxLength:
    active: true
    excludes:
      - "**/test/**"
      - "**/androidTest/**"
      - "**/*.Test.kt"
      - "**/*.Spec.kt"
      - "**/*.Spek.kt"
    maximumVariableNameLength: 32
  VariableMinLength:
    active: true
    excludes:
      - "**/test/**"
      - "**/androidTest/**"
      - "**/*.Test.kt"
      - "**/*.Spec.kt"
      - "**/*.Spek.kt"
    minimumVariableNameLength: 3
  VariableNaming:
    active: true
    excludes:
      - "**/test/**"
      - "**/androidTest/**"
      - "**/*.Test.kt"
      - "**/*.Spec.kt"
      - "**/*.Spek.kt"
    variablePattern: '[a-z][A-Za-z0-9]*'
    privateVariablePattern: '(_)?[a-z][A-Za-z0-9]*'
    excludeClassPattern: '$^'

performance:
  active: true
  ArrayPrimitive:
    active: true
  ForEachOnRange:
    active: true
    excludes:
      - "**/test/**"
      - "**/androidTest/**"
      - "**/*.Test.kt"
      - "**/*.Spec.kt"
      - "**/*.Spek.kt"
  SpreadOperator:
    active: true
    excludes:
      - "**/test/**"
      - "**/androidTest/**"
      - "**/*.Test.kt"
      - "**/*.Spec.kt"
      - "**/*.Spek.kt"
  UnnecessaryPartOfBinaryExpression:
    active: true
  UnnecessaryTemporaryInstantiation:
    active: true

potential-bugs:
  active: true
  Deprecation:
    active: false
  EqualsAlwaysReturnsTrueOrFalse:
    active: true
  EqualsWithHashCodeExist:
    active: true
  ExplicitGarbageCollectionCall:
    active: true
  HasPlatformType:
    active: true
  ImplicitDefaultLocale:
    active: true
  InvalidRange:
    active: true
  IteratorHasNextCallsNextMethod:
    active: true
  IteratorNotThrowingNoSuchElementException:
    active: true
  LateinitUsage:
    active: false
  MapGetWithNotNullAssertionOperator:
    active: true
  UnconditionalJumpStatementInLoop:
    active: true
  UnnecessaryNotNullCheck:
    active: true
  UnreachableCode:
    active: true
  UnsafeCallOnNullableType:
    active: true
  UnsafeCast:
    active: true
  UselessPostfixExpression:
    active: true
  WrongEqualsTypeParameter:
    active: true

style:
  active: true
  AlsoCouldBeApply:
    active: true
  CollapsibleIfStatements:
    active: true
  DataClassContainsFunctions:
    active: true
    conversionFunctionPrefix:
      - "to"
  DataClassShouldBeImmutable:
    active: true
  EqualsNullCall:
    active: true
  EqualsOnSignatureLine:
    active: true
  ExplicitCollectionElementAccessMethod:
    active: true
  ExplicitItLambdaParameter:
    active: false
  ExpressionBodySyntax:
    active: true
    includeLineWrapping: false
  ForbiddenComment:
    active: true
    comments:
      - reason: 'Format: TODO(name): Start with a verb, end with a dot.'
        value: 'TODO'
      - reason: 'Format: TODO(name): Start with a verb, end with a dot.'
        value: 'FIXME'
      - reason: 'Format: TODO(name): Start with a verb, end with a dot.'
        value: 'STOPSHIP'
    allowedPatterns: 'TODO\([a-z0-9_-]+\): [A-Z]{1}[^\.]+\.$'
  ForbiddenImport:
    active: false
    forbiddenPatterns: ""
  ForbiddenMethodCall:
    active: false
  ForbiddenVoid:
    active: true
    ignoreOverridden: false
    ignoreUsageInGenerics: false
  FunctionOnlyReturningConstant:
    active: true
    ignoreOverridableFunction: true
    excludedFunctions:
      - "describeContents"
    ignoreAnnotated:
      - "dagger.Provides"
  LoopWithTooManyJumpStatements:
    active: false
  MagicNumber:
    active: true
    excludes:
      - "**/test/**"
      - "**/androidTest/**"
      - "**/*.Test.kt"
      - "**/*.Spec.kt"
      - "**/*.Spek.kt"
    ignoreNumbers:
      - "-1"
      - "0"
      - "1"
      - "2"
    ignoreHashCodeFunction: true
    ignorePropertyDeclaration: false
    ignoreLocalVariableDeclaration: false
    ignoreConstantDeclaration: true
    ignoreCompanionObjectPropertyDeclaration: true
    ignoreAnnotation: false
    ignoreNamedArgument: true
    ignoreEnums: false
    ignoreRanges: false
  MaxLineLength:
    active: true
    maxLineLength: 100
    excludePackageStatements: true
    excludeImportStatements: true
    excludeCommentStatements: false
  MayBeConst:
    active: true
  ModifierOrder:
    active: true
  MultilineLambdaItParameter:
    active: true
  MultilineRawStringIndentation:
    active: true
    indentSize: 2
  NestedClassesVisibility:
    active: true
  NewLineAtEndOfFile:
    active: true
  NoTabs:
    active: true
  OptionalAbstractKeyword:
    active: true
  OptionalUnit:
    active: false
  BracesOnWhenStatements:
    active: true
    singleLine: "never"
    multiLine: "necessary"
  PreferToOverPairSyntax:
    active: true
  ProtectedMemberInFinalClass:
    active: true
  RedundantExplicitType:
    active: true
  RedundantVisibilityModifierRule:
    active: true
  ReturnCount:
    active: false
  SafeCast:
    active: true
  SerialVersionUIDInSerializableClass:
    active: false
  SpacingBetweenPackageAndImports:
    active: true
  ThrowsCount:
    active: true
    max: 3
  TrailingWhitespace:
    active: true
  TrimMultilineRawString:
    active: true
  UnderscoresInNumericLiterals:
    active: true
    acceptableLength: 5
  UnnecessaryAbstractClass:
    active: true
    ignoreAnnotated:
      - "dagger.Module"
  UnnecessaryAnnotationUseSiteTarget:
    active: true
  UnnecessaryApply:
    active: true
  UnnecessaryInheritance:
    active: true
  UnnecessaryLet:
    active: true
  UnnecessaryParentheses:
    active: true
  UntilInsteadOfRangeTo:
    active: true
  UnusedImports:
    active: true
  UnusedPrivateClass:
    active: true
  UnusedPrivateMember:
    active: true
    allowedNames: "(_|ignored|expected|serialVersionUID)"
  UseArrayLiteralsInAnnotations:
    active: true
  UseCheckOrError:
    active: true
  UseDataClass:
    active: true
    allowVars: false
  UseIfInsteadOfWhen:
    active: false
  UseRequire:
    active: true
  UseRequireNotNull:
    active: true
  UseSumOfInsteadOfFlatMapSize:
    active: true
  UselessCallOnNotNull:
    active: true
  UtilityClassWithPublicConstructor:
    active: true
  VarCouldBeVal:
    active: true
  WildcardImport:
    active: true
    excludes:
      - "**/test/**"
      - "**/androidTest/**"
      - "**/*.Test.kt"
      - "**/*.Spec.kt"
      - "**/*.Spek.kt"