Merge pull request #30 from auth0/task/detekt-setup

Setup detekt lint for UI-components Android

Author: pacific-ring

build.gradle

@@ -1,3 +1,6 @@
+import io.gitlab.arturbosch.detekt.Detekt
+import io.gitlab.arturbosch.detekt.DetektCreateBaselineTask
+
 // Top-level build file where you can add configuration options common to all sub-projects/modules.
 plugins {
     alias(libs.plugins.android.application) apply false
@@ -6,13 +9,42 @@ plugins {
     alias(libs.plugins.android.library) apply false
     alias(libs.plugins.kotlin.parcelize) apply false
     alias(libs.plugins.dokka)
+    alias(libs.plugins.detekt) apply false
     id 'io.github.gradle-nexus.publish-plugin' version '2.0.0'
 }
 
 subprojects {
     apply plugin: 'org.jetbrains.dokka'
 }
 
+configure(project(':universal_components')) {
+    apply plugin: 'io.gitlab.arturbosch.detekt'
+
+    detekt {
+        buildUponDefaultConfig = true
+        parallel = true
+        source.setFrom(files('src/main/java', 'src/main/kotlin', 'src/test/java', 'src/test/kotlin'))
+    }
+
+    tasks.withType(Detekt).configureEach {
+        jvmTarget = '17'
+        reports {
+            html.required.set(true)
+            xml.required.set(true)
+            sarif.required.set(true)
+            txt.required.set(false)
+        }
+    }
+
+    tasks.withType(DetektCreateBaselineTask).configureEach {
+        jvmTarget = '17'
+    }
+
+    dependencies {
+        detektPlugins libs.detekt.formatting
+    }
+}
+
 nexusPublishing {
     repositories {
         sonatype{

config/detekt/detekt.yml

@@ -0,0 +1,101 @@
+build:
+  maxIssues: 0
+  excludeCorrectable: false
+
+config:
+  validation: true
+  warningsAsErrors: false
+  checkExhaustiveness: false
+
+processors:
+  active: true
+
+console-reports:
+  active: true
+
+# ktlint-based rules (detekt-formatting plugin)
+formatting:
+  active: true
+  android: true
+  autoCorrect: true
+  Indentation:
+    active: true
+    indentSize: 4
+  MaximumLineLength:
+    active: true
+    maxLineLength: 200
+  FunctionName:
+    active: false # Composable functions use PascalCase
+  ImportOrdering:
+    active: true
+  NoWildcardImports:
+    active: true
+
+complexity:
+  active: true
+  LargeClass:
+    active: true
+    excludes: [ '**/test/**', '**/androidTest/**' ]
+  LongMethod:
+    active: true
+    threshold: 100
+    ignoreAnnotated: [ 'Composable' ]
+  LongParameterList:
+    active: true
+    functionThreshold: 10
+    constructorThreshold: 10
+    ignoreDefaultParameters: true
+    ignoreAnnotatedParameter: [ 'Composable' ]
+  TooManyFunctions:
+    active: true
+    thresholdInClasses: 30
+    thresholdInFiles: 30
+    thresholdInObjects: 30
+    thresholdInInterfaces: 30
+  CyclomaticComplexMethod:
+    active: true
+    threshold: 30
+
+naming:
+  active: true
+  FunctionNaming:
+    active: true
+    functionPattern: '[a-zA-Z][a-zA-Z0-9]*'
+    ignoreAnnotated: [ 'Composable' ]
+  TopLevelPropertyNaming:
+    active: true
+    constantPattern: '[A-Z][_A-Z0-9]*'
+
+style:
+  active: true
+  MaxLineLength:
+    active: true
+    maxLineLength: 140
+    excludes: [ '**/test/**', '**/androidTest/**' ]
+  MagicNumber:
+    active: true
+    excludes: [ '**/theme/Auth0Sizes.kt',
+                '**/theme/Auth0Dimensions.kt',
+                '**/theme/Auth0Color.kt',
+                '**/theme/Auth0Shapes.kt',
+                '**/test/**',
+                '**/androidTest/**' ]
+    ignoreNumbers: [ '-1', '0', '1', '2' ]
+    ignoreAnnotated: [ 'Composable', 'Preview' ]
+    ignorePropertyDeclaration: true
+    ignoreCompanionObjectPropertyDeclaration: true
+  ReturnCount:
+    active: true
+    max: 8
+  UnusedPrivateMember:
+    active: true
+    ignoreAnnotated: [ 'Preview' ]
+
+comments:
+  active: true
+  UndocumentedPublicClass:
+    active: false
+  UndocumentedPublicFunction:
+    active: false
+  UndocumentedPublicProperty:
+    active: false

gradle/libs.versions.toml

@@ -18,6 +18,7 @@ truth = "1.1.5"
 junit4 = "4.13.2"
 credentials = "1.5.0"
 dokka = "2.0.0"
+detekt = "1.23.8"
 
 [libraries]
 androidx-core-ktx = { group = "androidx.core", name = "core-ktx", version.ref = "coreKtx" }
@@ -46,6 +47,7 @@ truth = { group = "com.google.truth", name = "truth", version.ref = "truth" }
 junit4 = { group = "junit", name = "junit", version.ref = "junit4" }
 androidx-credentials = { module = "androidx.credentials:credentials", version.ref = "credentials" }
 androidx-credentials-play-services-auth = { module = "androidx.credentials:credentials-play-services-auth", version.ref = "credentials" }
+detekt-formatting = { group = "io.gitlab.arturbosch.detekt", name = "detekt-formatting", version.ref = "detekt" }
 
 [plugins]
 android-application = { id = "com.android.application", version.ref = "agp" }
@@ -55,4 +57,5 @@ android-library = { id = "com.android.library", version.ref = "agp" }
 kotlin-serialization = { id = "org.jetbrains.kotlin.plugin.serialization", version.ref = "kotlin" }
 kotlin-parcelize = { id = "org.jetbrains.kotlin.plugin.parcelize", version.ref = "kotlin" }
 dokka = { id = "org.jetbrains.dokka", version.ref = "dokka" }
+detekt = { id = "io.gitlab.arturbosch.detekt", version.ref = "detekt" }