Add spotless with ktlint and ktfmt

Author: newmskywalker

.editorconfig

@@ -0,0 +1,5 @@
+[*.{kt,kts}]
+# Compose allows PascalCase for @Composable functions
+ktlint_standard_function-naming = disabled
+# Filename should match class name is not always desired
+ktlint_standard_filename = disabled

.github/workflows/pr-check.yml

@@ -5,6 +5,22 @@ on:
     branches: [ "**" ]
 
 jobs:
+  spotless:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up JDK 17
+        uses: actions/setup-java@v4
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v4
+      - name: Grant execute permission for gradlew
+        run: chmod +x gradlew
+      - name: Run Spotless Check
+        run: ./gradlew spotlessCheck
+
   lint:
     runs-on: ubuntu-latest
     environment: staging

README.md

@@ -53,6 +53,26 @@
 * [Kotlin Multiplatform](https://kotlinlang.org/docs/multiplatform.html)
 * Native Android/iOS View and ViewModel layer
 
+### Code Quality & Formatting
+
+We use **Spotless** to maintain a consistent code style across the project. It integrates two main tools:
+- **ktfmt (Google Style):** A deterministic formatter that ensures all Kotlin code follows a unified structure.
+- **ktlint:** A linter that enforces additional best practices and code smells (e.g., forbidding wildcard imports).
+
+#### Formatting Commands
+- **Check formatting:** `./gradlew spotlessCheck`
+- **Apply formatting:** `./gradlew spotlessApply`
+
+#### Git Hooks
+To ensure code is formatted before every commit, we use a pre-commit hook. You can install it by running:
+```bash
+./scripts/install-git-hooks.sh
+```
+This hook will automatically run `spotlessApply` and stage any formatting changes whenever you commit.
+
+#### CI Integration
+Formatting is automatically verified on every Pull Request via GitHub Actions.
+
 <!-- GETTING STARTED -->
 
 ## 📖 Getting Started

android/app-newm/build.gradle.kts

@@ -2,162 +2,142 @@ import java.text.SimpleDateFormat
 import java.util.Date
 
 apply(from = "../../gradle_include/compose.gradle")
+
 apply(from = "../../gradle_include/circuit.gradle")
+
 apply(from = "../../gradle_include/flipper.gradle")
 
 plugins {
-    id("com.android.application")
-    id("com.google.gms.google-services")
-    id("kotlin-parcelize")
-    kotlin("android")
-    kotlin("kapt")
-    id("io.sentry.android.gradle") version "5.12.1"
-    alias(libs.plugins.compose.multiplatform)
+  id("com.android.application")
+  id("com.google.gms.google-services")
+  id("kotlin-parcelize")
+  kotlin("android")
+  kotlin("kapt")
+  id("io.sentry.android.gradle") version "5.12.1"
+  alias(libs.plugins.compose.multiplatform)
 }
 
-
 android {
-    compileSdk = libs.versions.android.compileSdk.get().toInt()
-    ndkVersion = "27.0.12077973"
-
-    namespace = "io.newm"
-    testNamespace = "io.newm.test"
-    defaultConfig {
-        applicationId = "io.newm"
-        minSdk = libs.versions.android.minSdk.get().toInt()
-        targetSdk = libs.versions.android.targetSdk.get().toInt()
-        versionCode = getCurrentDateTimeVersionCode()
-        versionName = getCustomVersionName(major = 1)
-        testInstrumentationRunner = "io.newm.NewmAndroidJUnitRunner"
-        testApplicationId = "io.newm.test"
+  compileSdk = libs.versions.android.compileSdk.get().toInt()
+  ndkVersion = "27.0.12077973"
+
+  namespace = "io.newm"
+  testNamespace = "io.newm.test"
+  defaultConfig {
+    applicationId = "io.newm"
+    minSdk = libs.versions.android.minSdk.get().toInt()
+    targetSdk = libs.versions.android.targetSdk.get().toInt()
+    versionCode = getCurrentDateTimeVersionCode()
+    versionName = getCustomVersionName(major = 1)
+    testInstrumentationRunner = "io.newm.NewmAndroidJUnitRunner"
+    testApplicationId = "io.newm.test"
+  }
+
+  lint { baseline = file("lint-baseline.xml") }
+
+  packaging {
+    resources {
+      merges += "META-INF/LICENSE.md"
+      merges += "META-INF/LICENSE-notice.md"
     }
-
-    lint {
-        baseline = file("lint-baseline.xml")
+    jniLibs { useLegacyPackaging = true }
+  }
+
+  buildTypes {
+    release {
+      isDebuggable = false
+      isMinifyEnabled = false
+      isMinifyEnabled = false
+      proguardFiles(getDefaultProguardFile("proguard-android-optimize.txt"), "proguard-rules.pro")
     }
-
-    packaging {
-        resources {
-            merges += "META-INF/LICENSE.md"
-            merges += "META-INF/LICENSE-notice.md"
-        }
-        jniLibs {
-            useLegacyPackaging = true
-        }
+    debug {
+      isDebuggable = true
+      isMinifyEnabled = false
+      isMinifyEnabled = false
     }
-
-    buildTypes {
-        release {
-            isDebuggable = false
-            isMinifyEnabled = false
-            isMinifyEnabled = false
-            proguardFiles(
-                getDefaultProguardFile("proguard-android-optimize.txt"),
-                "proguard-rules.pro"
-            )
-        }
-        debug {
-            isDebuggable = true
-            isMinifyEnabled = false
-            isMinifyEnabled = false
-        }
+  }
+  flavorDimensions += "version"
+
+  productFlavors {
+    create("production") {
+      namespace = "io.newm"
+      applicationId = "io.newm"
+      dimension = "version"
     }
-    flavorDimensions += "version"
-
-    productFlavors {
-        create("production") {
-            namespace = "io.newm"
-            applicationId = "io.newm"
-            dimension = "version"
-        }
-        create("development") {
-            namespace = "io.newm"
-            applicationId = "io.newm"
-            applicationIdSuffix = ".dev"
-            dimension = "version"
-        }
-        all {
-            resValue(
-                "string",
-                "account_type",
-                "$applicationId${applicationIdSuffix.orEmpty()}.account"
-            )
-        }
+    create("development") {
+      namespace = "io.newm"
+      applicationId = "io.newm"
+      applicationIdSuffix = ".dev"
+      dimension = "version"
     }
-
-    buildFeatures {
-        buildConfig = true
+    all {
+      resValue("string", "account_type", "$applicationId${applicationIdSuffix.orEmpty()}.account")
     }
+  }
 
-    compileOptions {
-        sourceCompatibility = JavaVersion.VERSION_11
-        targetCompatibility = JavaVersion.VERSION_11
-        isCoreLibraryDesugaringEnabled = true
-    }
+  buildFeatures { buildConfig = true }
 
-    kapt {
-        correctErrorTypes = true
-    }
+  compileOptions {
+    sourceCompatibility = JavaVersion.VERSION_11
+    targetCompatibility = JavaVersion.VERSION_11
+    isCoreLibraryDesugaringEnabled = true
+  }
+
+  kapt { correctErrorTypes = true }
 }
 
 dependencies {
-
-    implementation(libs.process.phoenix)
-    coreLibraryDesugaring(libs.desugar.jdk.libs)
-    implementation(libs.androidx.core.ktx)
-    implementation(libs.androidx.appcompat)
-    implementation(libs.androidx.constraintlayout)
-    implementation(libs.firebase.analytics)
-    implementation(libs.androidx.lifecycle.runtime.ktx)
-    implementation(compose.material)
-    implementation(libs.androidx.media3.datasource)
-    implementation(libs.androidx.media3.exoplayer)
-    implementation(libs.androidx.media3.database)
-    implementation(libs.androidx.navigation.ui.ktx)
-    implementation(libs.launchdarkly.client)
-    implementation(libs.play.services.auth)
-    implementation(libs.recaptcha)
-    implementation(libs.androidx.core.splashscreen)
-    implementation(libs.koin.android)
-    implementation(libs.kotlin.reflect)
-    implementation(libs.cmp.image.pick.n.crop)
-    implementation(platform(libs.firebase.bom))
-    implementation(libs.androidx.material.icons.extended)
-    implementation(project(Modules.barcodeScanner))
-    implementation(project(Modules.coreAndroidImplementations))
-    implementation(project(Modules.coreResources))
-    implementation(project(Modules.coreTheme))
-    implementation(project(Modules.coreUiUtils))
-    implementation(project(Modules.login))
-    implementation(project(Modules.musicPlayer))
-    implementation(project(Modules.shared))
-    implementation(project(Modules.sharedComposeFeatures))
-
-    testImplementation(libs.junit)
-    testImplementation(libs.mockk)
-
-    androidTestImplementation(libs.androidx.espresso.core)
-    androidTestImplementation(libs.androidx.test.junit)
-    androidTestImplementation(libs.mockk.android)
+  implementation(libs.process.phoenix)
+  coreLibraryDesugaring(libs.desugar.jdk.libs)
+  implementation(libs.androidx.core.ktx)
+  implementation(libs.androidx.appcompat)
+  implementation(libs.androidx.constraintlayout)
+  implementation(libs.firebase.analytics)
+  implementation(libs.androidx.lifecycle.runtime.ktx)
+  implementation(compose.material)
+  implementation(libs.androidx.media3.datasource)
+  implementation(libs.androidx.media3.exoplayer)
+  implementation(libs.androidx.media3.database)
+  implementation(libs.androidx.navigation.ui.ktx)
+  implementation(libs.launchdarkly.client)
+  implementation(libs.play.services.auth)
+  implementation(libs.recaptcha)
+  implementation(libs.androidx.core.splashscreen)
+  implementation(libs.koin.android)
+  implementation(libs.kotlin.reflect)
+  implementation(libs.cmp.image.pick.n.crop)
+  implementation(platform(libs.firebase.bom))
+  implementation(libs.androidx.material.icons.extended)
+  implementation(project(Modules.barcodeScanner))
+  implementation(project(Modules.coreAndroidImplementations))
+  implementation(project(Modules.coreResources))
+  implementation(project(Modules.coreTheme))
+  implementation(project(Modules.coreUiUtils))
+  implementation(project(Modules.login))
+  implementation(project(Modules.musicPlayer))
+  implementation(project(Modules.shared))
+  implementation(project(Modules.sharedComposeFeatures))
+
+  testImplementation(libs.junit)
+  testImplementation(libs.mockk)
+
+  androidTestImplementation(libs.androidx.espresso.core)
+  androidTestImplementation(libs.androidx.test.junit)
+  androidTestImplementation(libs.mockk.android)
 }
 
-kotlin {
-    compilerOptions {
-        jvmTarget.set(org.jetbrains.kotlin.gradle.dsl.JvmTarget.JVM_11)
-    }
-}
+kotlin { compilerOptions { jvmTarget.set(org.jetbrains.kotlin.gradle.dsl.JvmTarget.JVM_11) } }
 
 sentry {
-    org.set("project-newm")
-    projectName.set("android")
+  org.set("project-newm")
+  projectName.set("android")
 
-    // this will upload your source code to Sentry to show it as part of the stack traces
-    // disable if you don't want to expose your sources
-    includeSourceContext.set(true)
-    telemetry.set(true)
+  // this will upload your source code to Sentry to show it as part of the stack traces
+  // disable if you don't want to expose your sources
+  includeSourceContext.set(true)
+  telemetry.set(true)
 }
 
-
 /**
  * Generates a version code based on the current date and time in the format `yyMMddHH`.
  *
@@ -167,18 +147,19 @@ sentry {
  * - `dd`: The current day of the month.
  * - `HH`: The current hour (24-hour format).
  *
- * The function formats the current date and time using `SimpleDateFormat`,
- * converts it into a string, and then parses it as an integer.
+ * The function formats the current date and time using `SimpleDateFormat`, converts it into a
+ * string, and then parses it as an integer.
  *
  * @return An integer representing the current date and time in the format `yyMMddHH`.
  */
 fun getCurrentDateTimeVersionCode(): Int {
-    val dateFormat = SimpleDateFormat("yyMMddHH")
-    return dateFormat.format(Date()).toInt()
+  val dateFormat = SimpleDateFormat("yyMMddHH")
+  return dateFormat.format(Date()).toInt()
 }
 
 /**
- * Generates a custom version name based on the provided major version and the current date and time.
+ * Generates a custom version name based on the provided major version and the current date and
+ * time.
  *
  * The version name follows the format: `major.yyMMdd.HHmm`, where:
  * - `major`: The major version number passed as a parameter.
@@ -187,23 +168,24 @@ fun getCurrentDateTimeVersionCode(): Int {
  * - `HH`: The current hour in 24-hour format.
  * - `mm`: The current minute.
  *
- * The function retrieves the current date and time using `SimpleDateFormat` to format each component.
+ * The function retrieves the current date and time using `SimpleDateFormat` to format each
+ * component.
  *
  * Example output for `major = 1` on October 1st, 2024 at 13:45 would be: `1.241001.1345`.
  *
  * @param major The major version number to be used as the first part of the version name.
  * @return A custom version name string in the format: `major.yyMMdd.HHmm`.
  */
 fun getCustomVersionName(major: Int): String {
-    val yearFormat = SimpleDateFormat("yy")
-    val monthDayFormat = SimpleDateFormat("MMdd")
-    val hourFormat = SimpleDateFormat("HH")
-    val minuteFormat = SimpleDateFormat("mm")
-
-    val year = yearFormat.format(Date())
-    val monthDay = monthDayFormat.format(Date())
-    val hour = hourFormat.format(Date())
-    val minute = minuteFormat.format(Date())
-
-    return "$major.$year$monthDay.$hour$minute"
-}
+  val yearFormat = SimpleDateFormat("yy")
+  val monthDayFormat = SimpleDateFormat("MMdd")
+  val hourFormat = SimpleDateFormat("HH")
+  val minuteFormat = SimpleDateFormat("mm")
+
+  val year = yearFormat.format(Date())
+  val monthDay = monthDayFormat.format(Date())
+  val hour = hourFormat.format(Date())
+  val minute = minuteFormat.format(Date())
+
+  return "$major.$year$monthDay.$hour$minute"
+}