detekt.yml

config:
  warningsAsErrors: true

complexity:
  active: true
  LongParameterList:
    # It is suggested to increase this for Compose: https://detekt.dev/docs/introduction/compose/#longparameterlist
    functionThreshold: 8
    constructorThreshold: 20
    ignoreDefaultParameters: true
    ignoreAnnotated:
      - "Composable"
  LongMethod:
    active: true
    excludes: [ "*/generated/**" ]
    threshold: 100
    ignoreAnnotated:
      - "Composable"
  CyclomaticComplexMethod:
    active: true
    threshold: 15
    ignoreAnnotated:
      - "Composable"
  TooManyFunctions:
    active: true
    thresholdInClasses: 20
    ignoreAnnotated:
      - "InstallIn"
      - "TestInstallIn"

naming:
  active: true
  FunctionNaming:
    active: true
    functionPattern: '([a-z][a-zA-Z0-9]*)|(`.*`)'
    excludeClassPattern: '$^'
    ignoreAnnotated: [ 'Composable' ]
  TopLevelPropertyNaming:
    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_]*)*'

style:
  MagicNumber:
    ignoreAnnotated: [ 'Preview', 'PreviewScreenSizes', 'PreviewFontScale', 'PreviewLightDark', 'PreviewDynamicColors' ]
    excludes: [ '**/test/**', '**/*Test.kt', '**/demos/**', '**/androidUnitTest/**', '**/commonTest/**', '**/desktopTest/**' , '**/jsTest/**' ]
  MaxLineLength:
    excludes: [ '**/test/**', '**/*.Test.kt', '**/*.Spec.kt', '**/androidUnitTest/**', '**/commonTest/**', '**/desktopTest/**' , '**/jsTest/**' ]
    ignoreAnnotated:
      - "InstallIn"
      - "TestInstallIn"
    excludeCommentStatements: true
  UnusedPrivateMember:
    # https://detekt.dev/docs/introduction/compose#unusedprivatemember
    ignoreAnnotated: [ 'Preview', 'PreviewScreenSizes', 'PreviewFontScale', 'PreviewLightDark', 'PreviewDynamicColors' ]
  WildcardImport:
    active: true
    excludeImports: [ ]
  ReturnCount:
    active: true
    max: 3
    ignoreAnnotated: [ 'Composable' ]

exceptions:
  # TODO: Add this back when exceptions are caught correctly
  TooGenericExceptionCaught:
    active: false