Merge pull request #667 from pennlabs/add-ktlint-gradle

Add ktlint gradle

Author: baronhsieh2005

.editorconfig

@@ -0,0 +1,4 @@
+root = true
+
+[*.{kt,kts}]
+ktlint_function_naming_ignore_when_annotated_with = Composable

PennMobile/build.gradle

@@ -3,6 +3,7 @@ plugins {
     alias(libs.plugins.kotlin.android)
     alias(libs.plugins.google.services)
     alias(libs.plugins.firebase.crashlytics)
+    alias(libs.plugins.ktlint)
     // Removed problematic compose compiler alias for Kotlin 1.9.x compatibility
     id 'jacoco'
     id 'kotlin-parcelize'
@@ -11,24 +12,24 @@ plugins {
 }
 
 android {
-    namespace 'com.pennapps.labs.pennmobile'
+    namespace = 'com.pennapps.labs.pennmobile'
 
     buildFeatures {
         buildConfig = true
-        viewBinding true
-        compose true
+        viewBinding = true
+        compose = true
     }
 
     buildTypes {
         debug {
             matchingFallbacks = ['qa', 'release']
-            enableUnitTestCoverage true
-            enableAndroidTestCoverage true
+            enableUnitTestCoverage = true
+            enableAndroidTestCoverage = true
         }
         release {}
     }
 
-    compileSdk 35
+    compileSdk = 35
 
     composeOptions {
         // Matches Kotlin 1.9.24 defined in your libs.versions.toml
@@ -43,7 +44,7 @@ android {
         minSdkVersion 26
         targetSdkVersion 35
         vectorDrawables.useSupportLibrary = true
-        multiDexEnabled true
+        multiDexEnabled = true
         buildConfigField ("String", "PLATFORM_REDIRECT_URI", getPlatformRedirectUri())
         buildConfigField ("String", "PLATFORM_CLIENT_ID", getPlatformClientID())
     }
@@ -56,13 +57,29 @@ android {
     }
 }
 
+ktlint {
+    version.set("1.8.0")
+    android.set(true)
+    ignoreFailures.set(false)
+    verbose.set(true)
+    outputToConsole.set(true)
+    coloredOutput.set(true)
+
+    filter {
+        exclude("**/build/**")
+        exclude("**/generated/**")
+    }
+}
+
 dependencies {
     implementation fileTree(include: ['*.jar'], dir: 'libs')
 // If you want the foundation layout, use the bundle or the specific activity compose you have defined
     implementation libs.androidx.activity.compose
     implementation libs.androidx.material3.android
 //    implementation libs.androidx.foundation.layout
 
+    ktlintRuleset libs.ktlint
+
     androidTestImplementation libs.androidx.espresso.core
     androidTestImplementation libs.androidx.junit
     androidTestImplementation libs.kaspresso

PennMobile/src/main/java/com/pennapps/labs/pennmobile/di/CampusExpressModule.kt

@@ -14,7 +14,6 @@ import javax.inject.Singleton
 @Module
 @InstallIn(SingletonComponent::class)
 object CampusExpressModule {
-
     @Provides
     @Singleton
     @Named("CampusExpressRetrofit") // Tag this specific instance
@@ -25,9 +24,10 @@ object CampusExpressModule {
             .addConverterFactory(GsonConverterFactory.create())
             .build()
 
+    // Tell Hilt to use the tagged instance
     @Provides
     @Singleton
     fun provideCampusExpress(
-        @Named("CampusExpressRetrofit") retrofit: Retrofit // Tell Hilt to use the tagged instance
+        @Named("CampusExpressRetrofit") retrofit: Retrofit,
     ): CampusExpress = retrofit.create(CampusExpress::class.java)
-}
+}

PennMobile/src/main/java/com/pennapps/labs/pennmobile/dining/composables/components/DiningBalancesCard.kt

@@ -106,7 +106,7 @@ private fun BalanceItem(
                     text = label,
                     style = MaterialTheme.typography.labelMedium,
                     color = MaterialTheme.colorScheme.onSurface,
-                    fontWeight = FontWeight.W900
+                    fontWeight = FontWeight.W900,
                 )
 
                 Text(
@@ -117,7 +117,7 @@ private fun BalanceItem(
                             // fontSize = 16.sp
                         ),
                     modifier = Modifier.align(Alignment.CenterHorizontally),
-                    fontWeight = FontWeight.W900
+                    fontWeight = FontWeight.W900,
                 )
 
                 Spacer(modifier = Modifier.height(4.dp))
@@ -136,6 +136,7 @@ private fun BalanceItem(
                                 .align(Alignment.BottomEnd),
                     )
                 }
+
                 BalanceIconType.SWIPE -> {
                     Icon(
                         imageVector = Icons.Filled.CreditCard,
@@ -147,6 +148,7 @@ private fun BalanceItem(
                                 .align(Alignment.BottomEnd),
                     )
                 }
+
                 BalanceIconType.GUEST -> {
                     Icon(
                         imageVector = Icons.Filled.Group,

gradle/libs.versions.toml

@@ -36,6 +36,7 @@ kotlin = "1.9.24"
 kotlinKSP = "1.9.24-1.0.20"
 junitVersion = "4.13.2"
 kotlinxCoroutinesCore = "1.7.3"
+ktlintVersion = "0.5.6"
 leakcanaryAndroid = "3.0-alpha-1"
 legacySupportV4 = "1.0.0"
 library = "1.2.0"
@@ -62,6 +63,8 @@ rxandroidVersion = "1.2.1"
 rxjava1 = "1.3.8"
 rxJavaCoroutineConverter = "1.8.0"
 testng = "7.8.0"
+ktlint = "14.0.1"
+
 
 [libraries]
 adapter-rxjava = { module = "com.squareup.retrofit2:adapter-rxjava", version.ref = "adapterRxjava" }
@@ -123,6 +126,7 @@ jsoup = { module = "org.jsoup:jsoup", version.ref = "jsoup" }
 junit = { module = "junit:junit", version.ref = "junitVersion" }
 kaspresso = { module = "com.kaspersky.android-components:kaspresso", version.ref = "kaspresso" }
 kotlinx-coroutines-core = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-core", version.ref = "kotlinxCoroutinesCore" }
+ktlint = { module = "io.nlopez.compose.rules:ktlint", version.ref = "ktlintVersion" }
 leakcanary-android = { module = "com.squareup.leakcanary:leakcanary-android", version.ref = "leakcanaryAndroid" }
 library = { module = "com.daimajia.swipelayout:library", version.ref = "library" }
 logging-interceptor = { module = "com.squareup.okhttp3:logging-interceptor", version.ref = "loggingInterceptor" }
@@ -148,6 +152,7 @@ ksp = { id = "com.google.devtools.ksp", version.ref = "kotlinKSP"}
 hilt = { id = "com.google.dagger.hilt.android", version.ref = "hiltAndroid" }
 # Added this to match the accessor in build.gradle
 compose-compiler = { id = "org.jetbrains.kotlin.plugin.compose", version.ref = "kotlin" }
+ktlint = { id = "org.jlleitschuh.gradle.ktlint", version.ref = "ktlint" }
 
 
 [bundles]

settings.gradle

@@ -12,7 +12,7 @@ dependencyResolutionManagement {
         google()
         mavenCentral()
         maven {
-            url "https://www.jitpack.io"
+            url = "https://www.jitpack.io"
         }
     }
 }