Merge pull request #246 from synonymdev/feat/lint

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/ci.yml

@@ -6,41 +6,33 @@ on:
   pull_request:
     branches: [ "master" ]
 
-  workflow_dispatch:
+env:
+  TERM: xterm-256color
+  FORCE_COLOR: 1
 
 jobs:
   build:
     runs-on: ubuntu-latest
 
     steps:
-      - name: Checkout the code
+      - name: Checkout
         uses: actions/checkout@v4
 
-      - name: Set up JDK 17
+      - name: Setup Java
         uses: actions/setup-java@v4
         with:
           java-version: '17'
           distribution: 'adopt'
 
-      - name: Cache gradle
-        uses: actions/cache@v4
-        with:
-          path: |
-            ~/.gradle/caches
-            ~/.gradle/wrapper
-          key: gradle-${{ runner.os }}-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
-          restore-keys: |
-            gradle-${{ runner.os }}-
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v4
 
       - name: Decode google-services.json
         run: echo "$GOOGLE_SERVICES_JSON_BASE64" | base64 -d > app/google-services.json
         env:
           GOOGLE_SERVICES_JSON_BASE64: ${{ secrets.GOOGLE_SERVICES_JSON_BASE64 }}
 
-      - name: Make gradlew executable
-        run: chmod +x gradlew
-
-      - name: Build for debug with gradle
+      - name: Build debug app
         env:
           CHATWOOT_API: ${{ secrets.CHATWOOT_API }}
         run: ./gradlew assembleDevDebug
@@ -51,5 +43,6 @@ jobs:
       - name: Upload test report
         uses: actions/upload-artifact@v4
         with:
-          name: unit_test_report
+          name: unit_test_report_${{ github.run_number }}
           path: app/build/reports/tests/testDevDebugUnitTest/
+          retention-days: 30

.github/workflows/lint.yml

@@ -0,0 +1,56 @@
+name: Lint
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  TERM: xterm-256color
+  FORCE_COLOR: 1
+
+jobs:
+  lint:
+    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
+
+      - 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
+        uses: actions/upload-artifact@v4
+        with:
+          name: lint_report_${{ github.run_number }}
+          path: app/build/reports/detekt/
+          retention-days: 30

README.md

@@ -14,6 +14,22 @@ Bitkit Android Native app.
 - To communicate from emulator to host use:
   `10.0.2.2` instead of `localhost`
 
+### Linting
+
+This project uses detekt with default ktlint and compose-rules for linting Kotlin and Compose code.
+
+Recommended Android Studio plugins:
+- EditorConfig
+- Detekt
+
+#### Commands
+
+```sh
+./gradlew detekt # run analysis + formatting check
+./gradlew detekt --auto-correct # auto-fix formatting issues
+```
+Lint reports are generated in: `app/build/reports/detekt/`.
+
 ## Localization
 See repo: https://github.com/synonymdev/bitkit-transifex-sync
 

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
@@ -96,7 +97,7 @@ android {
         debug {
             signingConfig = signingConfigs.getByName("debug")
             ndk {
-                //noinspection ChromeOsAbiSupport
+                // noinspection ChromeOsAbiSupport
                 abiFilters += listOf("armeabi-v7a", "arm64-v8a", "x86_64")
             }
         }
@@ -105,11 +106,11 @@ android {
             isShrinkResources = false
             proguardFiles(
                 getDefaultProguardFile("proguard-android-optimize.txt"),
-                "proguard-rules.pro"
+                "proguard-rules.pro",
             )
             signingConfig = signingConfigs.getByName("release")
             ndk {
-                //noinspection ChromeOsAbiSupport
+                // noinspection ChromeOsAbiSupport
                 abiFilters += listOf("armeabi-v7a", "arm64-v8a")
             }
         }
@@ -137,7 +138,7 @@ android {
     }
     testOptions {
         unitTests {
-            isReturnDefaultValues = true     // mockito
+            isReturnDefaultValues = true // mockito
             isIncludeAndroidResources = true // robolectric
         }
     }
@@ -177,6 +178,18 @@ composeCompiler {
     )
     reportsDestination = layout.buildDirectory.dir("compose_compiler")
 }
+
+tasks.withType<io.gitlab.arturbosch.detekt.Detekt>().configureEach {
+    ignoreFailures = true
+    reports {
+        html.required.set(true)
+        sarif.required.set(true)
+        md.required.set(false)
+        txt.required.set(false)
+        xml.required.set(false)
+    }
+}
+
 dependencies {
     implementation(fileTree("libs") { include("*.aar") })
     implementation(libs.jna) { artifact { type = "aar" } }
@@ -273,10 +286,8 @@ dependencies {
     testImplementation(libs.test.mockito.kotlin)
     testImplementation(libs.test.robolectric)
     testImplementation(libs.test.turbine)
-}
-ksp {
-    // cool but strict: https://developer.android.com/jetpack/androidx/releases/room#2.6.0
-    // arg("room.generateKotlin", "true")
+    detektPlugins(libs.detekt.formatting)
+    detektPlugins(libs.detekt.compose.rules)
 }
 // https://developer.android.com/jetpack/androidx/releases/room#gradle-plugin
 room {