.detekt.yml

# Configuration of detekt rule sets, see https://arturbosch.github.io/detekt/comments.html.
# This file only lists the differences to the default configuration at
# https://github.com/arturbosch/detekt/blob/master/detekt-cli/src/main/resources/default-detekt-config.yml.

complexity:
  CyclomaticComplexMethod:
    threshold: 25
  LongMethod:
    threshold: 158
  LongParameterList:
    constructorThreshold: 11
    functionThreshold: 8
  NestedBlockDepth:
    threshold: 10
  TooManyFunctions:
    thresholdInClasses: 19
    thresholdInObjects: 14

coroutines:
  InjectDispatcher:
    active: false

# Formatting rules are implemented via the ktlint plugin. As ktlint does not allow exceptions, we need to disable
# respective rules completely.
formatting:
  AnnotationOnSeparateLine:
    active: false
  ArgumentListWrapping:
    active: false
  ChainWrapping:
    active: false
  CommentWrapping:
    active: false
  FinalNewline:
    active: false
  FunctionSignature:
    active: true
    functionBodyExpressionWrapping: multiline
  ImportOrdering:
    active: false
  MaximumLineLength:
    active: false
  NoUnusedImports:
    active: false
  NoWildcardImports:
    active: false
  ParameterListWrapping:
    active: false
  SpacingBetweenDeclarationsWithAnnotations:
    active: false
  TrailingCommaOnCallSite:
    active: true
    useTrailingCommaOnCallSite: false
  TrailingCommaOnDeclarationSite:
    active: true
    useTrailingCommaOnDeclarationSite: false

naming:
  ConstructorParameterNaming:
    excludes: ["**/clients/github-graphql/build/generated/**"]
  InvalidPackageDeclaration:
    active: false

performance:
  SpreadOperator:
    active: false

style:
  DestructuringDeclarationWithTooManyEntries:
    maxDestructuringEntries: 4
  ForbiddenComment:
    active: false
  ForbiddenMethodCall:
    active: true
    # Use org.ossreviewtoolkit.utils.ort.runBlocking instead in all code that can be used as a library.
    # One exception to that are the CLI commands.
    methods: ['kotlinx.coroutines.runBlocking']
  LoopWithTooManyJumpStatements:
    active: false
  MagicNumber:
    active: false
  MaxLineLength:
    excludes: ["**/clients/github-graphql/build/generated/**"]
  ReturnCount:
    active: false
  SpacingBetweenPackageAndImports:
    active: true
  ThrowsCount:
    max: 5
  UnusedImports:
    active: true
  WildcardImport:
    excludes: ''
    excludeImports:
      - org.ossreviewtoolkit.helper.commands.*
      - org.ossreviewtoolkit.utils.spdx.SpdxLicense.*
      - org.ossreviewtoolkit.utils.spdx.SpdxLicenseException.*
      - kotlinx.html.*
      - kotlinx.html.dom.*

potential-bugs:
  MissingPackageDeclaration:
    active: true
    excludes: ["**/GradleModel.kt", "**/build.gradle.kts"]

ORT:
  OrtEmptyLineAfterBlock:
    active: true
  OrtImportOrder:
    active: true
    excludes: ["**/clients/github-graphql/build/generated/**"]
  OrtPackageNaming:
    active: true