feat: lint setup

Author: ovitrif

.editorconfig

@@ -1,26 +1,34 @@
 root = true
 
-# Apply to all files
 [*]
+charset = utf-8
 end_of_line = lf
+indent_size = 4
+indent_style = space
 insert_final_newline = true
+max_line_length = 120
 trim_trailing_whitespace = true
-max_line_length=120
-indent_style = space
-indent_size = 4
+
+[*.{kt,kts}]
+ij_kotlin_allow_trailing_comma = true
+ij_kotlin_allow_trailing_comma_on_call_site = true
+ktlint_code_style = android_studio
+ktlint_experimental = enabled
+ktlint_function_naming_ignore_when_annotated_with = Composable
+ktlint_standard = enabled
 
 [*.md]
-max_line_length = off
 indent_size = 2
+max_line_length = off
 trim_trailing_whitespace = false
 
 [*.js]
 indent_size = 2
 
 [*.json]
-max_line_length = off
 indent_size = 2
-
-[*.yml]
 max_line_length = off
+
+[*.{yml,yaml}]
 indent_size = 2
+max_line_length = off

.github/workflows/lint.yml

@@ -0,0 +1,72 @@
+name: Lint
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  # Force colored output in CI
+  TERM: xterm-256color
+  FORCE_COLOR: 1
+  CI: true
+
+jobs:
+  lint:
+    name: Lint Checks
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+
+    permissions:
+      # Required for all workflows
+      contents: read
+      actions: read
+      # Required for SARIF upload to GitHub Security tab
+      security-events: write
+
+    steps:
+      - name: 📥 Checkout code
+        uses: actions/checkout@v4
+        with:
+
+      - name: ☕ Setup JDK 17
+        uses: actions/setup-java@v4
+        with:
+          java-version: '17'
+          distribution: 'adopt'
+
+      - name: 🐘 Setup Gradle
+        uses: gradle/actions/setup-gradle@v4
+        with:
+          cache-read-only: true
+
+      - name: 🎨 Run Spotless Check
+        run: |
+          ./gradlew spotlessCheck --no-daemon --stacktrace
+
+      - name: 🔍 Run Detekt Analysis
+        run: |
+          ./gradlew detekt --no-daemon --stacktrace
+        continue-on-error: true
+
+      - name: 🔒 Upload Detekt SARIF to GitHub Security
+        if: always()
+        uses: github/codeql-action/upload-sarif@v3
+        with:
+          sarif_file: app/build/reports/detekt/detekt.sarif
+          category: detekt
+        continue-on-error: true
+
+      - name: 📎 Upload Artifacts
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: lint-reports-${{ github.run_number }}
+          path: |
+            app/build/reports/detekt/
+          retention-days: 30

LINTING.md

@@ -0,0 +1,34 @@
+# 🔍 Linting Setup
+
+This project uses a linting setup with default configurations for Android development with Kotlin and Jetpack Compose.
+
+## 🛠️ Tools
+
+- **Detekt** - Static code analysis with default configuration + Compose rules plugin
+- **Spotless** - Code formatting orchestrator + ktlint with default rules
+- **GitHub Actions** - via `.github/workflows/lint.yml`
+- **GitHub Advanced Security** - Code scanning with SARIF reports
+
+Recommended Android Studio plugins:
+- **Detekt** - code analysis
+- **Ktlint** - formatting feedback and quick fixes
+
+## Commands
+
+```sh
+./gradlew preCommit # pre-commit check
+./gradlew formatAll # auto-fix formatting
+
+# Detekt
+./gradlew detekt
+./gradlew detektBaseline # update baseline with current violations
+
+# Spotless
+./gradlew spotlessCheck
+./gradlew spotlessApply
+```
+
+## 📊 Reports
+
+Reports are generated in:
+- **Detekt**: `app/build/reports/detekt/`

app/build.gradle.kts

@@ -12,6 +12,8 @@ plugins {
     alias(libs.plugins.google.services)
     alias(libs.plugins.protobuf)
     alias(libs.plugins.room)
+    alias(libs.plugins.detekt)
+    alias(libs.plugins.spotless)
 }
 
 // https://developer.android.com/studio/publish/app-signing#secure-key
@@ -83,8 +85,11 @@ android {
             keyPassword = "android"
         }
         create("release") {
-            val keystoreFile = keystoreProperties.getProperty("storeFile").takeIf { it.isNotBlank() }
-                ?.let { rootProject.file(it) }
+            val keystoreFile =
+                keystoreProperties
+                    .getProperty("storeFile")
+                    .takeIf { it.isNotBlank() }
+                    ?.let { rootProject.file(it) }
             storeFile = if (keystoreFile?.exists() == true) keystoreFile else null
             // storeFile = rootProject.file(keystoreProperties.getProperty("storeFile"))
             storePassword = keystoreProperties.getProperty("storePassword")
@@ -105,7 +110,7 @@ android {
             isShrinkResources = false
             proguardFiles(
                 getDefaultProguardFile("proguard-android-optimize.txt"),
-                "proguard-rules.pro"
+                "proguard-rules.pro",
             )
             signingConfig = signingConfigs.getByName("release")
             ndk {
@@ -137,7 +142,7 @@ android {
     }
     testOptions {
         unitTests {
-            isReturnDefaultValues = true     // mockito
+            isReturnDefaultValues = true // mockito
             isIncludeAndroidResources = true // robolectric
         }
     }
@@ -171,12 +176,46 @@ protobuf {
 }
 
 composeCompiler {
-    featureFlags = setOf(
-        ComposeFeatureFlag.StrongSkipping.disabled(),
-        ComposeFeatureFlag.OptimizeNonSkippingGroups,
-    )
+    featureFlags =
+        setOf(
+            ComposeFeatureFlag.StrongSkipping.disabled(),
+            ComposeFeatureFlag.OptimizeNonSkippingGroups,
+        )
     reportsDestination = layout.buildDirectory.dir("compose_compiler")
 }
+
+// Linting Configuration
+val isCI = System.getenv("CI").toBoolean()
+
+tasks.withType<io.gitlab.arturbosch.detekt.Detekt>().configureEach {
+    ignoreFailures = !isCI
+    reports {
+        html.required.set(!isCI)
+        md.required.set(!isCI)
+        sarif.required.set(true)
+        txt.required.set(false)
+        xml.required.set(isCI)
+    }
+}
+
+spotless {
+    val ktlintVersion = "1.0.1"
+    kotlin {
+        target("**/*.kt")
+        targetExclude("**/build/**/*.kt", "**/generated/**/*.kt")
+        ktlint(ktlintVersion).setEditorConfigPath(rootProject.file(".editorconfig").absolutePath)
+        trimTrailingWhitespace()
+        endWithNewline()
+    }
+
+    kotlinGradle {
+        target("*.gradle.kts")
+        ktlint(ktlintVersion)
+        trimTrailingWhitespace()
+        endWithNewline()
+    }
+}
+
 dependencies {
     implementation(fileTree("libs") { include("*.aar") })
     implementation(libs.jna) { artifact { type = "aar" } }
@@ -273,10 +312,14 @@ dependencies {
     testImplementation(libs.test.mockito.kotlin)
     testImplementation(libs.test.robolectric)
     testImplementation(libs.test.turbine)
+    // Linting
+    detektPlugins(libs.detekt.formatting)
+    detektPlugins(libs.detekt.compose.rules)
 }
 ksp {
-    // cool but strict: https://developer.android.com/jetpack/androidx/releases/room#2.6.0
-    // arg("room.generateKotlin", "true")
+    arg("room.schemaLocation", "$projectDir/schemas")
+    arg("room.incremental", "true")
+    arg("room.expandProjection", "true")
 }
 // https://developer.android.com/jetpack/androidx/releases/room#gradle-plugin
 room {
@@ -288,3 +331,24 @@ tasks.withType<Test> {
         // showStandardStreams = true
     }
 }
+
+tasks.register("lintAll") {
+    group = "verification"
+    description = "Run all linting tools"
+    dependsOn("detekt", "spotlessCheck")
+}
+
+tasks.register("formatAll") {
+    group = "formatting"
+    description = "Apply all formatting tools"
+    dependsOn("spotlessApply")
+}
+
+tasks.register("preCommit") {
+    group = "verification"
+    description = "Run checks that should pass before committing (fast subset)"
+    dependsOn("spotlessCheck")
+    doLast {
+        println("✅ Pre-commit checks passed!")
+    }
+}