Merge remote-tracking branch 'origin/AAT-32/more_setup_cleanup' into …

…AAT-32/more_setup_cleanup

.github/workflows/android_build.yml

@@ -20,4 +20,4 @@ jobs:
         run: ./gradlew test
 
       - name: Lint Checks
-        run: ./gradlew detekt lintKotlin lint
+        run: ./gradlew detektAll lintKotlin lint

build.gradle.kts

@@ -21,6 +21,7 @@ buildscript {
 plugins {
     // https://github.com/jeremymailen/kotlinter-gradle/releases
     id("org.jmailen.kotlinter") version "3.13.0" apply false
+    id("io.gitlab.arturbosch.detekt").version(libs.versions.detektGradlePlugin)
 }
 
 apply(from = "buildscripts/githooks.gradle")
@@ -41,3 +42,23 @@ afterEvaluate {
         dependsOn(":installGitHooks")
     }
 }
+
+tasks {
+    /**
+     * The detektAll tasks enables parallel usage for detekt so if this project
+     * expands to multi module support, detekt can continue to run quickly.
+     *
+     * https://proandroiddev.com/how-to-use-detekt-in-a-multi-module-android-project-6781937fbef2
+     */
+    @Suppress("UnusedPrivateMember")
+    val detektAll by registering(io.gitlab.arturbosch.detekt.Detekt::class) {
+        parallel = true
+        setSource(files(projectDir))
+        include("**/*.kt")
+        include("**/*.kts")
+        exclude("**/resources/**")
+        exclude("**/build/**")
+        config.setFrom(files("$rootDir/config/detekt/detekt.yml"))
+        buildUponDefaultConfig = false
+    }
+}

documentation/StaticAnalysis.md

@@ -6,10 +6,11 @@ This project leverages static analysis to ensure that the codebase meets certain
 
 [Detekt](https://github.com/detekt/detekt) is a static analysis tool that checks for code smells. Examples include magic numbers, complicated conditionals, long methods, long parameter lists, and so much more. It is highly configurable, and if you choose to turn off any checks or customize thresholds you can do so in the [config file](/config/detekt/detekt.yml).
 
-To run a detekt validation, use the following Gradle command:
+To run a detekt validation, use the one of the following Gradle commands:
 
 ```
-./gradlew detekt
+./gradlew detekt # Runs over each module synchronously
+./gradlew detektAll # Runs over each module in parallel.
 ```
 
 ## Ktlint

git-hooks/pre-push.sh

@@ -3,4 +3,4 @@
 echo "Running static analysis."
 
 ./gradlew lintKotlin
-./gradlew detekt
+./gradlew detektAll