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,63 @@
+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:
+      contents: read  # for actions/checkout to fetch code
+      security-events: write  # for github/codeql-action/upload-sarif to upload SARIF results
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Java
+        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 Detekt Analysis
+        run: |
+          ./gradlew detekt --no-daemon --stacktrace
+        continue-on-error: true
+
+      - name: Upload SARIF
+        if: always()
+        uses: github/codeql-action/upload-sarif@v3
+        with:
+          sarif_file: app/build/reports/detekt/detekt.sarif
+        continue-on-error: true
+
+      - name: Upload lint report
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: lint_report_${{ github.run_number }}
+          path: |
+            app/build/reports/detekt/
+          retention-days: 30

LINTING.md

@@ -0,0 +1,25 @@
+# 🔍 Linting Setup
+
+This project uses detekt with default configurations for linting Kotlin and Jetpack Compose code.
+
+## 🛠️ Tools
+
+- **Detekt** - Static code analysis + formatting (includes ktlint rules via detekt-formatting & compose-rules)
+- **Detekt Compose** - Compose-specific rules
+- **GitHub Actions** - via `.github/workflows/lint.yml`
+- **GitHub Advanced Security** - Code scanning with SARIF reports
+
+Recommended Android Studio plugins:
+- **Detekt** - code analysis and formatting feedback
+
+## Commands
+
+```sh
+./gradlew detekt # analysis + formatting check
+./gradlew detekt --auto-correct # auto-fix formatting issues
+```
+
+## 📊 Reports
+
+Reports are generated in:
+- **Detekt**: `app/build/reports/detekt/` (HTML, SARIF, XML, Markdown)

app/build.gradle.kts

@@ -12,6 +12,7 @@ plugins {
     alias(libs.plugins.google.services)
     alias(libs.plugins.protobuf)
     alias(libs.plugins.room)
+    alias(libs.plugins.detekt)
 }
 
 // https://developer.android.com/studio/publish/app-signing#secure-key
@@ -83,8 +84,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 +109,7 @@ android {
             isShrinkResources = false
             proguardFiles(
                 getDefaultProguardFile("proguard-android-optimize.txt"),
-                "proguard-rules.pro"
+                "proguard-rules.pro",
             )
             signingConfig = signingConfigs.getByName("release")
             ndk {
@@ -137,7 +141,7 @@ android {
     }
     testOptions {
         unitTests {
-            isReturnDefaultValues = true     // mockito
+            isReturnDefaultValues = true // mockito
             isIncludeAndroidResources = true // robolectric
         }
     }
@@ -171,12 +175,32 @@ 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)
+    }
+}
+
+
+
+
+
 dependencies {
     implementation(fileTree("libs") { include("*.aar") })
     implementation(libs.jna) { artifact { type = "aar" } }
@@ -273,10 +297,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 {