Add spotless with ktlint and ktfmt

Author: newmskywalker

.editorconfig

@@ -0,0 +1,9 @@
+[*.{kt,kts}]
+# Compose allows PascalCase for @Composable functions
+ktlint_standard_function-naming = disabled
+# Enforce no wildcard imports
+ktlint_standard_no-wildcard-imports = enabled
+# Filename should match class name is not always desired
+ktlint_standard_filename = disabled
+# Backing properties naming can be different
+ktlint_standard_backing-property-naming = disabled

.gitattributes

@@ -1 +1,2 @@
+* text=auto eol=lf
 **/snapshots/**/*.png filter=lfs diff=lfs merge=lfs -text

.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,7 +2,9 @@ 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 {
@@ -15,7 +17,6 @@ plugins {
     alias(libs.plugins.compose.multiplatform)
 }
 
-
 android {
     compileSdk = libs.versions.android.compileSdk.get().toInt()
     ndkVersion = "27.0.12077973"
@@ -32,18 +33,14 @@ android {
         testApplicationId = "io.newm.test"
     }
 
-    lint {
-        baseline = file("lint-baseline.xml")
-    }
+    lint { baseline = file("lint-baseline.xml") }
 
     packaging {
         resources {
             merges += "META-INF/LICENSE.md"
             merges += "META-INF/LICENSE-notice.md"
         }
-        jniLibs {
-            useLegacyPackaging = true
-        }
+        jniLibs { useLegacyPackaging = true }
     }
 
     buildTypes {
@@ -53,7 +50,7 @@ android {
             isMinifyEnabled = false
             proguardFiles(
                 getDefaultProguardFile("proguard-android-optimize.txt"),
-                "proguard-rules.pro"
+                "proguard-rules.pro",
             )
         }
         debug {
@@ -80,28 +77,23 @@ android {
             resValue(
                 "string",
                 "account_type",
-                "$applicationId${applicationIdSuffix.orEmpty()}.account"
+                "$applicationId${applicationIdSuffix.orEmpty()}.account",
             )
         }
     }
 
-    buildFeatures {
-        buildConfig = true
-    }
+    buildFeatures { buildConfig = true }
 
     compileOptions {
         sourceCompatibility = JavaVersion.VERSION_11
         targetCompatibility = JavaVersion.VERSION_11
         isCoreLibraryDesugaringEnabled = true
     }
 
-    kapt {
-        correctErrorTypes = true
-    }
+    kapt { correctErrorTypes = true }
 }
 
 dependencies {
-
     implementation(libs.process.phoenix)
     coreLibraryDesugaring(libs.desugar.jdk.libs)
     implementation(libs.androidx.core.ktx)
@@ -123,15 +115,15 @@ dependencies {
     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))
+    implementation(project(Modules.BARCODE_SCANNER))
+    implementation(project(Modules.CORE_ANDROID_IMPLEMENTATIONS))
+    implementation(project(Modules.CORE_RESOURCES))
+    implementation(project(Modules.CORE_THEME))
+    implementation(project(Modules.CORE_UI_UTILS))
+    implementation(project(Modules.LOGIN))
+    implementation(project(Modules.MUSIC_PLAYER))
+    implementation(project(Modules.SHARED))
+    implementation(project(Modules.SHARED_COMPOSE_FEATURES))
 
     testImplementation(libs.junit)
     testImplementation(libs.mockk)
@@ -141,11 +133,7 @@ dependencies {
     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")
@@ -157,7 +145,6 @@ sentry {
     telemetry.set(true)
 }
 
-
 /**
  * Generates a version code based on the current date and time in the format `yyMMddHH`.
  *
@@ -167,8 +154,8 @@ 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`.
  */
@@ -178,7 +165,8 @@ fun getCurrentDateTimeVersionCode(): Int {
 }
 
 /**
- * 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,7 +175,8 @@ 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`.
  *
@@ -206,4 +195,4 @@ fun getCustomVersionName(major: Int): String {
     val minute = minuteFormat.format(Date())
 
     return "$major.$year$monthDay.$hour$minute"
-}
+}

android/app-newm/src/debug/java/io/newm/DebugNewmApplication.kt

@@ -6,24 +6,25 @@ import com.facebook.flipper.plugins.databases.DatabasesFlipperPlugin
 import com.facebook.flipper.plugins.inspector.DescriptorMapping
 import com.facebook.flipper.plugins.inspector.InspectorFlipperPlugin
 import com.facebook.flipper.plugins.navigation.NavigationFlipperPlugin
-import com.facebook.flipper.plugins.sharedpreferences.SharedPreferencesFlipperPlugin
 import com.facebook.soloader.SoLoader
 
 class DebugNewmApplication : NewmApplication() {
     override fun onCreate() {
         SoLoader.init(this, false)
-        AndroidFlipperClient.getInstance(this).apply {
-            addPlugin(
-                InspectorFlipperPlugin(
-                    this@DebugNewmApplication,
-                    DescriptorMapping.withDefaults()
+        AndroidFlipperClient
+            .getInstance(this)
+            .apply {
+                addPlugin(
+                    InspectorFlipperPlugin(
+                        this@DebugNewmApplication,
+                        DescriptorMapping.withDefaults(),
+                    ),
                 )
-            )
-            addPlugin(CrashReporterPlugin.getInstance())
-            addPlugin(DatabasesFlipperPlugin(this@DebugNewmApplication))
-            addPlugin(NavigationFlipperPlugin.getInstance())
-        }.start()
+                addPlugin(CrashReporterPlugin.getInstance())
+                addPlugin(DatabasesFlipperPlugin(this@DebugNewmApplication))
+                addPlugin(NavigationFlipperPlugin.getInstance())
+            }.start()
 
         super.onCreate()
     }
-}
+}

android/app-newm/src/main/java/io/newm/AppLaunchGhostActivity.kt

@@ -28,16 +28,15 @@ class AppLaunchGhostActivity : ComponentActivity() {
     @OptIn(FlowPreview::class)
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
-        installSplashScreen().apply {
-            setKeepOnScreenCondition { true }
-        }
+        installSplashScreen().apply { setKeepOnScreenCondition { true } }
 
         lifecycleScope.launch {
             val isLoggedIn = userSession.isLoggedIn()
 
             if (isLoggedIn) {
                 try {
-                    userDetailsUseCase.fetchLoggedInUserDetailsFlow()
+                    userDetailsUseCase
+                        .fetchLoggedInUserDetailsFlow()
                         .filterNotNull()
                         .onEach(featureFlagMager::identifyUser)
                         .timeout(3.seconds)
@@ -46,7 +45,7 @@ class AppLaunchGhostActivity : ComponentActivity() {
                     logger.error(
                         tag,
                         "Failed to identify feature flag because fetching user details failed.",
-                        e
+                        e,
                     )
                 } finally {
                     launchHomeActivity()