feat: add lint kotlin (#36)

Author: yogeshpaliyal

.editorconfig

@@ -0,0 +1,3 @@
+[*.{kt,kts}]
+ktlint_function_naming_ignore_when_annotated_with = Composable
+compose_allowed_forwarding_of_types = .*AccountViewModel

.github/workflows/pr-check.yml

@@ -34,6 +34,9 @@ jobs:
       - name: Grant execute permission for gradlew
         run: chmod +x ./gradlew
 
+      - name: Lint Check
+        run: bash ./gradlew lintKotlin
+
       - name: 🏗 Build APK
         run: bash ./gradlew assembleDebug
 

app/build.gradle.kts

@@ -3,6 +3,7 @@ plugins {
     alias(libs.plugins.kotlin.android)
     alias(libs.plugins.kotlin.compose)
     alias(libs.plugins.sqldelight)
+    id("org.jmailen.kotlinter")
 }
 
 android {
@@ -31,7 +32,7 @@ android {
             isMinifyEnabled = true
             proguardFiles(
                 getDefaultProguardFile("proguard-android-optimize.txt"),
-                "proguard-rules.pro"
+                "proguard-rules.pro",
             )
         }
     }
@@ -95,4 +96,16 @@ dependencies {
     implementation(libs.compose.qr.code)
     implementation(libs.accompanist)
     implementation(libs.opencsv)
-}
+    ktlint("io.nlopez.compose.rules:ktlint:0.4.27")
+}
+
+kotlinter {
+    ktlintVersion = "1.5.0"
+    ignoreFormatFailures = true
+    ignoreLintFailures = false
+    reporters = arrayOf("checkstyle")
+}
+
+tasks.check {
+    dependsOn("installKotlinterPrePushHook")
+}

app/src/androidTest/java/com/yogeshpaliyal/deepr/ExampleInstrumentedTest.kt

@@ -1,13 +1,11 @@
 package com.yogeshpaliyal.deepr
 
-import androidx.test.platform.app.InstrumentationRegistry
 import androidx.test.ext.junit.runners.AndroidJUnit4
-
+import androidx.test.platform.app.InstrumentationRegistry
+import org.junit.Assert.assertEquals
 import org.junit.Test
 import org.junit.runner.RunWith
 
-import org.junit.Assert.*
-
 /**
  * Instrumented test, which will execute on an Android device.
  *
@@ -21,4 +19,4 @@ class ExampleInstrumentedTest {
         val appContext = InstrumentationRegistry.getInstrumentation().targetContext
         assertEquals("com.yogeshpaliyal.deepr", appContext.packageName)
     }
-}
+}

app/src/main/java/com/yogeshpaliyal/deepr/DeeprApplication.kt

@@ -18,32 +18,33 @@ class DeeprApplication : Application() {
     override fun onCreate() {
         super.onCreate()
 
-        val appModule = module {
-            // Provide the Android-specific SqlDriver
-            single<SqlDriver> {
-                AndroidSqliteDriver(DeeprDB.Schema, this@DeeprApplication, "deepr.db")
-            }
+        val appModule =
+            module {
+                // Provide the Android-specific SqlDriver
+                single<SqlDriver> {
+                    AndroidSqliteDriver(DeeprDB.Schema, this@DeeprApplication, "deepr.db")
+                }
 
-            // Provide the Database instance
-            single {
-                DeeprDB(get())
-            }
+                // Provide the Database instance
+                single {
+                    DeeprDB(get())
+                }
 
-            // Provide the generated queries from the database.
-            // Replace `accountQueries` if your table has a different name.
-            single<DeeprQueries> {
-                val database = get<DeeprDB>()
-                database.deeprQueries
-            }
+                // Provide the generated queries from the database.
+                // Replace `accountQueries` if your table has a different name.
+                single<DeeprQueries> {
+                    val database = get<DeeprDB>()
+                    database.deeprQueries
+                }
 
-            single { AppPreferenceDataStore(androidContext()) }
+                single { AppPreferenceDataStore(androidContext()) }
 
-            single<ExportRepository> { ExportRepositoryImpl(androidContext(), get()) }
+                single<ExportRepository> { ExportRepositoryImpl(androidContext(), get()) }
 
-            single<ImportRepository> { ImportRepositoryImpl(androidContext(), get()) }
+                single<ImportRepository> { ImportRepositoryImpl(androidContext(), get()) }
 
-            viewModel { AccountViewModel(get(), get(), get()) }
-        }
+                viewModel { AccountViewModel(get(), get(), get()) }
+            }
 
         startKoin {
             // Provide Android context to Koin
@@ -52,4 +53,4 @@ class DeeprApplication : Application() {
             modules(appModule)
         }
     }
-}
+}

app/src/main/java/com/yogeshpaliyal/deepr/MainActivity.kt

@@ -10,6 +10,7 @@ import androidx.compose.material3.Text
 import androidx.compose.runtime.Composable
 import androidx.compose.runtime.mutableStateListOf
 import androidx.compose.runtime.remember
+import androidx.compose.ui.Modifier
 import androidx.navigation3.runtime.NavEntry
 import androidx.navigation3.ui.NavDisplay
 import com.yogeshpaliyal.deepr.ui.screens.AboutUs
@@ -40,28 +41,35 @@ class MainActivity : ComponentActivity() {
 }
 
 @Composable
-fun Dashboard(viewModel: AccountViewModel) {
+fun Dashboard(
+    viewModel: AccountViewModel,
+    modifier: Modifier = Modifier,
+) {
     val backStack = remember { mutableStateListOf<Any>(Home) }
 
     NavDisplay(
         backStack = backStack,
+        modifier = modifier,
         onBack = { backStack.removeLastOrNull() },
         entryProvider = { key ->
             when (key) {
-                is Home -> NavEntry(key) {
-                    HomeScreen(viewModel, backStack)
-                }
+                is Home ->
+                    NavEntry(key) {
+                        HomeScreen(viewModel, backStack)
+                    }
 
-                is Settings -> NavEntry(key) {
-                    SettingsScreen(viewModel, backStack)
-                }
+                is Settings ->
+                    NavEntry(key) {
+                        SettingsScreen(viewModel, backStack)
+                    }
 
-                is AboutUs -> NavEntry(key) {
-                    AboutUsScreen(backStack)
-                }
+                is AboutUs ->
+                    NavEntry(key) {
+                        AboutUsScreen(backStack)
+                    }
 
                 else -> NavEntry(Unit) { Text("Unknown route") }
             }
-        }
+        },
     )
 }

app/src/main/java/com/yogeshpaliyal/deepr/backup/ExportRepository.kt

@@ -4,4 +4,4 @@ import com.yogeshpaliyal.deepr.util.RequestResult
 
 interface ExportRepository {
     suspend fun exportToCsv(): RequestResult<String>
-}
+}

app/src/main/java/com/yogeshpaliyal/deepr/backup/ExportRepositoryImpl.kt

@@ -22,7 +22,6 @@ class ExportRepositoryImpl(
     private val context: Context,
     private val deeprQueries: DeeprQueries,
 ) : ExportRepository {
-
     override suspend fun exportToCsv(): RequestResult<String> {
         val count = deeprQueries.countDeepr().executeAsOne()
         if (count == 0L) {
@@ -38,15 +37,15 @@ class ExportRepositoryImpl(
 
         return withContext(Dispatchers.IO) {
             if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q) {
-
-                val contentValues = ContentValues().apply {
-                    put(MediaStore.MediaColumns.DISPLAY_NAME, fileName)
-                    put(MediaStore.MediaColumns.MIME_TYPE, "text/csv")
-                    put(
-                        MediaStore.MediaColumns.RELATIVE_PATH,
-                        "${Environment.DIRECTORY_DOWNLOADS}/Deepr"
-                    )
-                }
+                val contentValues =
+                    ContentValues().apply {
+                        put(MediaStore.MediaColumns.DISPLAY_NAME, fileName)
+                        put(MediaStore.MediaColumns.MIME_TYPE, "text/csv")
+                        put(
+                            MediaStore.MediaColumns.RELATIVE_PATH,
+                            "${Environment.DIRECTORY_DOWNLOADS}/Deepr",
+                        )
+                    }
 
                 val resolver = context.contentResolver
                 val uri =
@@ -73,12 +72,15 @@ class ExportRepositoryImpl(
                 FileOutputStream(file).use { outputStream ->
                     writeCsvData(outputStream, dataToExportInCsvFormat)
                 }
-                RequestResult.Success("Successfully exported to ${downloadsDir}/${file.absolutePath}")
+                RequestResult.Success("Successfully exported to $downloadsDir/${file.absolutePath}")
             }
         }
     }
 
-    private fun writeCsvData(outputStream: OutputStream, data: List<Deepr>) {
+    private fun writeCsvData(
+        outputStream: OutputStream,
+        data: List<Deepr>,
+    ) {
         outputStream.bufferedWriter().use { writer ->
             // Write Header
             writer.write("${Constants.Header.LINK},${Constants.Header.CREATED_AT},${Constants.Header.OPENED_COUNT}\n")
@@ -89,4 +91,4 @@ class ExportRepositoryImpl(
             }
         }
     }
-}
+}

app/src/main/java/com/yogeshpaliyal/deepr/backup/ImportRepository.kt

@@ -5,4 +5,4 @@ import com.yogeshpaliyal.deepr.util.RequestResult
 
 interface ImportRepository {
     suspend fun importFromCsv(uri: Uri): RequestResult<ImportResult>
-}
+}

app/src/main/java/com/yogeshpaliyal/deepr/backup/ImportRepositoryImpl.kt

@@ -11,22 +11,23 @@ import java.io.IOException
 
 class ImportRepositoryImpl(
     private val context: Context,
-    private val deeprQueries: DeeprQueries
+    private val deeprQueries: DeeprQueries,
 ) : ImportRepository {
-
     override suspend fun importFromCsv(uri: Uri): RequestResult<ImportResult> {
         var updatedCount = 0
         var skippedCount = 0
 
         try {
             context.contentResolver.openInputStream(uri)?.use { inputStream ->
                 inputStream.reader().use { reader ->
-                    val csvReader = CSVReaderBuilder(reader)
-                        .build()
+                    val csvReader =
+                        CSVReaderBuilder(reader)
+                            .build()
 
                     // verify header first
                     val header = csvReader.readNext()
-                    if (header == null || header.size < 3 ||
+                    if (header == null ||
+                        header.size < 3 ||
                         header[0] != Constants.Header.LINK ||
                         header[1] != Constants.Header.CREATED_AT ||
                         header[2] != Constants.Header.OPENED_COUNT
@@ -44,7 +45,7 @@ class ImportRepositoryImpl(
                                 deeprQueries.transaction {
                                     deeprQueries.insertDeepr(
                                         link = link,
-                                        openedCount = openedCount
+                                        openedCount = openedCount,
                                     )
                                 }
                             } else {
@@ -58,7 +59,6 @@ class ImportRepositoryImpl(
             }
 
             return RequestResult.Success(ImportResult(updatedCount, skippedCount))
-
         } catch (e: IOException) {
             return RequestResult.Error("Error reading file: ${e.message}")
         } catch (e: CsvException) {
@@ -67,4 +67,4 @@ class ImportRepositoryImpl(
             return RequestResult.Error("An unexpected error occurred: ${e.message}")
         }
     }
-}
+}