Set up KtLint (#71)

* Add ktlint * Add lint check to CI * Use plugin for ktlint * Fix KtLint issues * Add post notification permission * Fix Unsafe call to observe with Fragment instance as LifecycleOwner
ARK-Builders · Nov 5, 2024 · 6a90eca · 6a90eca
1 parent fa8f4e1
commit 6a90eca
Show file tree

Hide file tree

Showing 78 changed files with 2,676 additions and 2,130 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -76,3 +76,41 @@ jobs:
       with:
         name: release-universal-apk
         path: ./app/build/outputs/apk/release/app-universal-release.apk
+
+  lint:
+    needs: build
+    environment: Development
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v4
+        with:
+          java-version: '17'
+          distribution: 'adopt'
+
+      - name: Run linter
+        run: ./gradlew lint
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: lint-results
+          path: ./app/build/reports/*.html
+
+  ktlint:
+    needs: build
+    environment: Development
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v4
+        with:
+          java-version: '17'
+          distribution: 'adopt'
+
+      - name: Kotlin linter
+        run: ./gradlew ktlintCheck
+
diff --git a/app/build.gradle b/app/build.gradle
@@ -6,6 +6,7 @@ plugins {
     id 'kotlin-parcelize'
     id 'com.google.gms.google-services'
     id 'com.google.firebase.crashlytics'
+    id 'org.jlleitschuh.gradle.ktlint'
 }
 
 android {
@@ -111,3 +112,9 @@ dependencies {
     implementation "com.google.firebase:firebase-crashlytics"
     implementation "com.google.firebase:firebase-analytics"
 }
+
+tasks.preBuild.dependsOn ktlintCheck
+
+tasks.preBuild.dependsOn ktlintFormat
+
+tasks.ktlintCheck.shouldRunAfter ktlintFormat
diff --git a/app/src/androidTest/java/dev/arkbuilders/arkmemo/ExampleInstrumentedTest.kt b/app/src/androidTest/java/dev/arkbuilders/arkmemo/ExampleInstrumentedTest.kt
@@ -1,13 +1,11 @@
 package dev.arkbuilders.arkmemo
 
-import androidx.test.platform.app.InstrumentationRegistry
 import androidx.test.ext.junit.runners.AndroidJUnit4
-
+import androidx.test.platform.app.InstrumentationRegistry
+import junit.framework.TestCase.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("dev.arkbuilders.arkmemo", appContext.packageName)
     }
-}
+}
diff --git a/app/src/main/AndroidManifest.xml b/app/src/main/AndroidManifest.xml
@@ -10,6 +10,7 @@
     <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
     <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
     <uses-permission android:name="android.permission.RECORD_AUDIO"/>
+    <uses-permission android:name="android.permission.POST_NOTIFICATIONS"/>
 
     <application
         android:name=".App"

diff --git a/app/src/main/java/dev/arkbuilders/arkmemo/App.kt b/app/src/main/java/dev/arkbuilders/arkmemo/App.kt
@@ -2,14 +2,13 @@ package dev.arkbuilders.arkmemo
 
 import android.app.Application
 import dagger.hilt.android.HiltAndroidApp
-import dev.arkbuilders.arklib.initArkLib
 import dev.arkbuilders.arkfilepicker.folders.FoldersRepo
+import dev.arkbuilders.arklib.initArkLib
 import dev.arkbuilders.arkmemo.preferences.MemoPreferences
 import javax.inject.Inject
 
 @HiltAndroidApp
-class App: Application() {
-
+class App : Application() {
     @Inject
     lateinit var memoPreferences: MemoPreferences
 

diff --git a/app/src/main/java/dev/arkbuilders/arkmemo/contracts/PermissionContract.kt b/app/src/main/java/dev/arkbuilders/arkmemo/contracts/PermissionContract.kt
@@ -9,14 +9,18 @@ import android.provider.Settings
 import androidx.activity.result.contract.ActivityResultContract
 import androidx.annotation.RequiresApi
 
-class PermissionContract: ActivityResultContract<String, Boolean>() {
-
+class PermissionContract : ActivityResultContract<String, Boolean>() {
     @RequiresApi(Build.VERSION_CODES.R)
-    override fun createIntent(context: Context, input: String)
-    = Intent(Settings.ACTION_MANAGE_APP_ALL_FILES_ACCESS_PERMISSION, Uri.parse(input))
+    override fun createIntent(
+        context: Context,
+        input: String,
+    ) = Intent(Settings.ACTION_MANAGE_APP_ALL_FILES_ACCESS_PERMISSION, Uri.parse(input))
 
     @RequiresApi(Build.VERSION_CODES.R)
-    override fun parseResult(resultCode: Int, intent: Intent?): Boolean {
+    override fun parseResult(
+        resultCode: Int,
+        intent: Intent?,
+    ): Boolean {
         return Environment.isExternalStorageManager()
     }
 }
diff --git a/app/src/main/java/dev/arkbuilders/arkmemo/di/CoroutinesModule.kt b/app/src/main/java/dev/arkbuilders/arkmemo/di/CoroutinesModule.kt
@@ -12,11 +12,10 @@ import javax.inject.Singleton
 @InstallIn(SingletonComponent::class)
 @Module
 object CoroutinesModule {
-
     @Named(IO_DISPATCHER)
     @Singleton
     @Provides
     fun provideDispatcher(): CoroutineDispatcher = Dispatchers.IO
 }
 
-const val IO_DISPATCHER = "iODispatcher"
+const val IO_DISPATCHER = "iODispatcher"
diff --git a/app/src/main/java/dev/arkbuilders/arkmemo/di/MediaModule.kt b/app/src/main/java/dev/arkbuilders/arkmemo/di/MediaModule.kt
@@ -4,15 +4,14 @@ import dagger.Binds
 import dagger.Module
 import dagger.hilt.InstallIn
 import dagger.hilt.components.SingletonComponent
-import dev.arkbuilders.arkmemo.media.ArkMediaPlayer
-import dev.arkbuilders.arkmemo.media.ArkMediaPlayerImpl
 import dev.arkbuilders.arkmemo.media.ArkAudioRecorder
 import dev.arkbuilders.arkmemo.media.ArkAudioRecorderImpl
+import dev.arkbuilders.arkmemo.media.ArkMediaPlayer
+import dev.arkbuilders.arkmemo.media.ArkMediaPlayerImpl
 
 @Module
 @InstallIn(SingletonComponent::class)
 abstract class MediaModule {
-
     @Binds
     abstract fun bindArkAudioRecorder(impl: ArkAudioRecorderImpl): ArkAudioRecorder
 

diff --git a/app/src/main/java/dev/arkbuilders/arkmemo/di/PreferencesModule.kt b/app/src/main/java/dev/arkbuilders/arkmemo/di/PreferencesModule.kt
@@ -12,4 +12,4 @@ import dev.arkbuilders.arkmemo.preferences.MemoPreferencesImpl
 abstract class PreferencesModule {
     @Binds
     abstract fun bindMemoPreferences(impl: MemoPreferencesImpl): MemoPreferences
-}
+}
diff --git a/app/src/main/java/dev/arkbuilders/arkmemo/di/PropertiesStorageModule.kt b/app/src/main/java/dev/arkbuilders/arkmemo/di/PropertiesStorageModule.kt
@@ -13,21 +13,20 @@ import javax.inject.Singleton
 @InstallIn(SingletonComponent::class)
 @Module
 object PropertiesStorageModule {
-
     @Singleton
     @Provides
     @Named(STORAGE_SCOPE)
     fun storageScope(
-        @Named(IO_DISPATCHER) dispatcher: CoroutineDispatcher
+        @Named(IO_DISPATCHER) dispatcher: CoroutineDispatcher,
     ): CoroutineScope = CoroutineScope(dispatcher)
 
     @Singleton
     @Provides
     fun propertiesStorageRepo(
-        @Named(STORAGE_SCOPE) storageScope: CoroutineScope
+        @Named(STORAGE_SCOPE) storageScope: CoroutineScope,
     ): PropertiesStorageRepo {
         return PropertiesStorageRepo(storageScope)
     }
 
     const val STORAGE_SCOPE = "storageScope"
-}
+}
diff --git a/app/src/main/java/dev/arkbuilders/arkmemo/di/RepositoryModule.kt b/app/src/main/java/dev/arkbuilders/arkmemo/di/RepositoryModule.kt
@@ -6,17 +6,16 @@ import dagger.Provides
 import dagger.hilt.InstallIn
 import dagger.hilt.components.SingletonComponent
 import dev.arkbuilders.arklib.user.properties.PropertiesStorageRepo
-import dev.arkbuilders.arkmemo.repo.graphics.GraphicNotesRepo
-import dev.arkbuilders.arkmemo.repo.NotesRepo
-import dev.arkbuilders.arkmemo.repo.text.TextNotesRepo
 import dev.arkbuilders.arkmemo.models.GraphicNote
 import dev.arkbuilders.arkmemo.models.TextNote
 import dev.arkbuilders.arkmemo.models.VoiceNote
 import dev.arkbuilders.arkmemo.preferences.MemoPreferences
+import dev.arkbuilders.arkmemo.repo.NotesRepo
 import dev.arkbuilders.arkmemo.repo.NotesRepoHelper
+import dev.arkbuilders.arkmemo.repo.graphics.GraphicNotesRepo
+import dev.arkbuilders.arkmemo.repo.text.TextNotesRepo
 import dev.arkbuilders.arkmemo.repo.voices.VoiceNotesRepo
 
-
 @InstallIn(SingletonComponent::class)
 @Module
 abstract class RepositoryModule {
@@ -33,7 +32,7 @@ abstract class RepositoryModule {
         @Provides
         fun provideNotesRepoHelper(
             memoPreferences: MemoPreferences,
-            propertiesStorageRepo: PropertiesStorageRepo
+            propertiesStorageRepo: PropertiesStorageRepo,
         ) = NotesRepoHelper(memoPreferences, propertiesStorageRepo)
     }
-}
+}
diff --git a/app/src/main/java/dev/arkbuilders/arkmemo/graphics/Color.kt b/app/src/main/java/dev/arkbuilders/arkmemo/graphics/Color.kt
@@ -1,7 +1,6 @@
 package dev.arkbuilders.arkmemo.graphics
 
 enum class Color(val code: Int, val value: String) {
-
     BLACK(ColorCode.black, "black"),
 
     GRAY(ColorCode.gray, "gray"),
@@ -16,5 +15,5 @@ enum class Color(val code: Int, val value: String) {
 
     PURPLE(ColorCode.purple, "purple"),
 
-    WHITE(ColorCode.white, "white")
-}
+    WHITE(ColorCode.white, "white"),
+}
diff --git a/app/src/main/java/dev/arkbuilders/arkmemo/graphics/ColorCode.kt b/app/src/main/java/dev/arkbuilders/arkmemo/graphics/ColorCode.kt
@@ -10,4 +10,4 @@ internal object ColorCode {
     val purple by lazy { android.graphics.Color.parseColor("#7A5AF8") }
     val white by lazy { android.graphics.Color.parseColor("#FFFFFF") }
     val brown by lazy { android.graphics.Color.parseColor("#B54708") }
-}
+}
-Original file line number
+Diff line change
@@ Expand Up @@
     abstract class PreferencesModule {
         @Binds
         abstract fun bindMemoPreferences(impl: MemoPreferencesImpl): MemoPreferences
-    }
+    }