Add detekt script and workflow

Author: afarber

.github/workflows/_detekt.yml

@@ -0,0 +1,38 @@
+name: Detekt Static Analysis
+
+on:
+  workflow_call:
+
+permissions:
+  contents: read
+
+jobs:
+  detekt:
+    name: Run Detekt Analysis
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v4
+        with:
+          distribution: temurin
+          java-version: 17
+
+      - name: Cache Gradle
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.gradle/caches
+            ~/.gradle/wrapper
+          key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
+          restore-keys: |
+            ${{ runner.os }}-gradle-
+
+      - name: Grant execute permission for Gradle wrapper
+        run: chmod +x gradlew
+
+      - name: Run Detekt
+        run: ./gradlew detekt

.github/workflows/ci.yml

@@ -18,29 +18,33 @@ jobs:
     name: Check Copyright Headers
     uses: ./.github/workflows/_copyright.yml
 
+  detekt:
+    name: Static Analysis
+    uses: ./.github/workflows/_detekt.yml
+
   test:
     name: Unit Tests
-    needs: [format, copyright]
+    needs: [format, copyright, detekt]
     uses: ./.github/workflows/_test.yml
 
   coverage:
     name: Test Coverage
-    needs: [format, copyright]
+    needs: [format, copyright, detekt]
     uses: ./.github/workflows/_coverage.yml
 
   docs:
     name: Documentation
-    needs: [format, copyright]
+    needs: [format, copyright, detekt]
     uses: ./.github/workflows/_docs.yml
 
   build-library:
     name: Build Library
-    needs: [format, copyright, test, coverage, docs]
+    needs: [format, copyright, detekt, test, coverage, docs]
     uses: ./.github/workflows/_build-library.yml
 
   build-examples:
     name: Build Examples
-    needs: [format, copyright, test, coverage, docs]
+    needs: [format, copyright, detekt, test, coverage, docs]
     uses: ./.github/workflows/_build-examples.yml
 
   instrumented-test:

.github/workflows/release.yml

@@ -13,25 +13,29 @@ jobs:
     name: Check Formatting
     uses: ./.github/workflows/_format.yml
 
+  detekt:
+    name: Static Analysis
+    uses: ./.github/workflows/_detekt.yml
+
   test:
     name: Unit Tests
-    needs: format
+    needs: [format, detekt]
     uses: ./.github/workflows/_test.yml
 
   build-library:
     name: Build Library
-    needs: [format, test]
+    needs: [format, detekt, test]
     uses: ./.github/workflows/_build-library.yml
 
   build-examples:
     name: Build Examples
-    needs: [format, test]
+    needs: [format, detekt, test]
     uses: ./.github/workflows/_build-examples.yml
 
   publish:
     name: Publish to Maven Central
     runs-on: ubuntu-latest
-    needs: [format, test, build-library, build-examples]
+    needs: [format, detekt, test, build-library, build-examples]
 
     steps:
       - name: Checkout repository

build.gradle.kts

@@ -24,6 +24,7 @@ plugins {
     alias(libs.plugins.kotlin.compose) apply false
     alias(libs.plugins.spotless) apply false
     alias(libs.plugins.dokka) apply false
+    alias(libs.plugins.detekt) apply false
     alias(libs.plugins.nmcp)
 }
 
@@ -37,3 +38,24 @@ nmcpAggregation {
     publishAllProjectsProbablyBreakingProjectIsolation()
 }
 
+subprojects {
+    afterEvaluate {
+        if (plugins.hasPlugin("org.jetbrains.kotlin.android")) {
+            apply(plugin = "io.gitlab.arturbosch.detekt")
+
+            extensions.configure<io.gitlab.arturbosch.detekt.extensions.DetektExtension> {
+                buildUponDefaultConfig = true
+                config.setFrom(files("$rootDir/config/detekt/detekt.yml"))
+            }
+
+            tasks.withType<io.gitlab.arturbosch.detekt.Detekt>().configureEach {
+                reports {
+                    html.required.set(true)
+                    xml.required.set(true)
+                    sarif.required.set(true)
+                }
+            }
+        }
+    }
+}
+

config/detekt/detekt.yml

@@ -0,0 +1,34 @@
+build:
+  maxIssues: 0
+
+formatting:
+  active: false
+
+complexity:
+  active: true
+  LongMethod:
+    threshold: 60
+  LongParameterList:
+    threshold: 6
+  ComplexMethod:
+    threshold: 15
+
+style:
+  active: true
+  MagicNumber:
+    ignoreNumbers:
+      - '-1'
+      - '0'
+      - '1'
+      - '2'
+    ignorePropertyDeclaration: true
+    ignoreAnnotation: true
+
+naming:
+  active: true
+
+potential-bugs:
+  active: true
+
+performance:
+  active: true

docs/GITHUB_WORKFLOWS.md

@@ -38,6 +38,13 @@ Located in `.github/workflows/`:
 - **Usage**: Called by CI and Release workflows
 - **Fast**: ~30 seconds
 
+#### `_detekt.yml`
+- **Purpose**: Run Detekt static code analysis
+- **Runs**: `./gradlew detekt`
+- **Usage**: Called by CI and Release workflows
+- **Duration**: ~1-2 minutes
+- **Reports**: HTML, XML, and SARIF reports generated
+
 #### `_coverage.yml`
 - **Purpose**: Check test coverage meets minimum threshold
 - **Runs**: `./scripts/check-coverage.sh` (minimum threshold defined in [Contributing Guide](CONTRIBUTING.md#test-coverage))
@@ -89,41 +96,26 @@ Located in `.github/workflows/`:
 
 **Execution Flow**:
 ```
-format (Check formatting)
-   |
-   v
-copyright (Check headers)
-   |
-   v
-   +----------------+----------------+----------------+
-   |                |                                 |
-   v                v                                 v
-test            docs                       coverage
-(Unit tests)    (Build API docs)           (Test coverage)
-   |                |                                 |
-   +----------------+----------------+----------------+
-                              |
-   +--------------------------+-------------------------+
-   |                                                    |
-   v                                                    v
-build-library                                  build-examples
-(Build AAR)                                    (Build 3 APKs)
+format ────┐
+           │
+copyright ─┼──→ test/coverage/docs ──→ build-library
+           │                          │
+detekt ────┘                          └──→ build-examples
 
 For Pull Requests only:
-   v
-instrumented-test (Phone + Automotive)
-(Runs in parallel, not blocking)
+instrumented-test (Phone + Automotive) runs in parallel
 ```
 
 **Jobs**:
 1. **format** - Runs Spotless formatting check
 2. **copyright** - Verifies MIT license headers
-3. **test** - Runs unit tests (depends on format + copyright)
-4. **docs** - Builds API documentation with Dokka (depends on format + copyright)
-5. **coverage** - Checks test coverage meets 20% minimum (depends on format + copyright)
-6. **build-library** - Builds library AAR (depends on format + copyright + test + docs + coverage, runs in parallel with build-examples)
-7. **build-examples** - Builds example APKs (depends on format + copyright + test + docs + coverage, runs in parallel with build-library)
-8. **instrumented-test** - Runs instrumentation tests on phone and automotive emulators (PR only, required status check)
+3. **detekt** - Runs Detekt static code analysis
+4. **test** - Runs unit tests (depends on format + copyright + detekt)
+5. **docs** - Builds API documentation with Dokka (depends on format + copyright + detekt)
+6. **coverage** - Checks test coverage meets 20% minimum (depends on format + copyright + detekt)
+7. **build-library** - Builds library AAR (depends on all above, runs in parallel with build-examples)
+8. **build-examples** - Builds example APKs (depends on all above, runs in parallel with build-library)
+9. **instrumented-test** - Runs instrumentation tests on phone and automotive emulators (PR only)
 
 **Total Duration**:
 - **Maintainer pushes to main**: ~3-4 minutes (no instrumentation tests)
@@ -143,30 +135,19 @@ instrumented-test (Phone + Automotive)
 
 **Execution Flow**:
 ```
-format (Check formatting)
-   |
-   v
-test (Run unit tests)
-   |
-   v
-   +----------------+----------------+
-   |                                 |
-   v                                 v
-build-library              build-examples
-   |                                 |
-   +-----------------+---------------+
-                     |
-                     v
-                 publish
-      (Maven Central + GitHub Release)
+format ────┐
+           ├──→ test ──→ build-library ──┐
+detekt ────┘           │                 ├──→ publish
+                       └──→ build-examples ──┘
 ```
 
 **Jobs**:
 1. **format** - Runs Spotless formatting check
-2. **test** - Runs unit tests (depends on format)
-3. **build-library** - Builds library AAR (depends on format + test)
-4. **build-examples** - Builds example APKs (depends on format + test)
-5. **publish** - Publishes to Maven Central and creates GitHub Release (depends on all above)
+2. **detekt** - Runs Detekt static code analysis
+3. **test** - Runs unit tests (depends on format + detekt)
+4. **build-library** - Builds library AAR (depends on format + detekt + test)
+5. **build-examples** - Builds example APKs (depends on format + detekt + test)
+6. **publish** - Publishes to Maven Central and creates GitHub Release (depends on all above)
 
 **Publish Job Details**:
 - Validates tag format (must be `vMAJOR.MINOR.PATCH`)
@@ -310,6 +291,9 @@ Before pushing, developers can run the same checks locally:
 # Auto-fix formatting
 ./gradlew spotlessApply
 
+# Static analysis
+./gradlew detekt
+
 # Run unit tests
 ./gradlew :openmapview:test
 
@@ -375,6 +359,7 @@ Artifacts are retained for 30 days.
 
 **Common Failures**:
 - **Format check fails**: Run `./gradlew spotlessApply` locally and commit
+- **Detekt fails**: Run `./gradlew detekt` locally to see issues
 - **Test fails**: Run `./gradlew :openmapview:test` locally to debug
 - **Build fails**: Check for compilation errors in logs
 - **Publish fails**: Verify GitHub Secrets are configured correctly
@@ -390,34 +375,19 @@ Developer creates PR with code changes
 GitHub triggers ci.yml workflow
    |
    v
-format job: Check Spotless formatting (30 sec) - PASS
+format/copyright/detekt jobs run in parallel (30-60 sec each) - PASS
    |
    v
-copyright job: Check license headers (30 sec) - PASS
+test/coverage/docs jobs run (1-2 min each) - PASS
+   |
+   v
+build-library + build-examples run in parallel (2-3 min) - PASS
    |
    v
-   +-------------+--------------+
-   |                            |
-   v                            v
-test job: Unit tests       coverage job: Test coverage
-   (1 min) - PASS               (1 min) - PASS (>20%)
-   |                            |
-   +-------------+--------------+
-                 |
-   +-------------+--------------+
-   |                            |
-   v                            v
-build-library: Build AAR  build-examples: Build 3 APKs
-   (2 min) - PASS               (3 min) - PASS
-   |                            |
-   +-------------+--------------+
-                 |
-                 v
 All core checks pass (3-4 min)
 
 Meanwhile (in parallel, PR only):
-instrumented-test: Phone + Automotive tests
-   (10-15 min) - PASS
+instrumented-test: Phone + Automotive tests (10-15 min) - PASS
    |
    v
 All checks complete -> PR is ready to merge
@@ -432,21 +402,15 @@ Developer tags v0.2.0 and pushes
 GitHub triggers release.yml workflow
    |
    v
-format job: Check Spotless formatting - PASS
+format + detekt jobs run in parallel - PASS
    |
    v
 test job: Run unit tests - PASS
    |
    v
-   +-------------+--------------+
-   |                            |
-   v                            v
-build-library: Build AAR  build-examples: Build 3 APKs
-   - PASS                       - PASS
-   |                            |
-   +-------------+--------------+
-                 |
-                 v
+build-library + build-examples run in parallel - PASS
+   |
+   v
 publish job:
    - Validate tag format - PASS
    - Sign artifacts with GPG - PASS

gradle/libs.versions.toml

@@ -36,6 +36,7 @@ kotlinx-coroutines = "1.10.2"
 # Code Quality
 ktlint = "1.3.1"
 license-report = "3.0.1"
+detekt = "1.23.7"
 
 [libraries]
 # AndroidX Core
@@ -80,6 +81,7 @@ spotless = { id = "com.diffplug.spotless", version.ref = "spotless" }
 dokka = { id = "org.jetbrains.dokka", version.ref = "dokka" }
 nmcp = { id = "com.gradleup.nmcp.aggregation", version.ref = "nmcp" }
 license-report = { id = "com.github.jk1.dependency-license-report", version.ref = "license-report" }
+detekt = { id = "io.gitlab.arturbosch.detekt", version.ref = "detekt" }
 
 [bundles]
 # Common dependencies for example apps