[CHORE] #5 Ktlint 구성

.github/workflows/android-pull-request-ci.yml

@@ -0,0 +1,35 @@
+name: Android Pull Request CI
+
+on:
+  pull_request:
+    branches: [ "main", "develop", "dev" ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    defaults:
+      run:
+        working-directory: Near
+
+    steps:
+      - name: Checkout the code
+        uses: actions/checkout@v3
+
+      - name: set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          distribution: 'corretto'
+          java-version: '17'
+
+      - name: set up Android SDK
+        uses: android-actions/setup-android@v2
+
+      - name: Grant execute permission for gradlew
+        run: chmod +x gradlew
+
+      - name: Run test
+        run: ./gradlew test --parallel
+
+      - name: Run ktlint
+        run: ./gradlew ktlintCheck

Near/.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+ktlint_function_naming_ignore_when_annotated_with = Composable

Near/app/build.gradle.kts

@@ -25,7 +25,7 @@ android {
             isMinifyEnabled = false
             proguardFiles(
                 getDefaultProguardFile("proguard-android-optimize.txt"),
-                "proguard-rules.pro"
+                "proguard-rules.pro",
             )
         }
     }
@@ -73,4 +73,4 @@ dependencies {
     implementation(libs.room.ktx)
     kapt(libs.room.compiler)
     implementation(libs.room.paging)
-}
+}

Near/app/src/androidTest/java/com/alarmy/near/ExampleInstrumentedTest.kt

@@ -1,13 +1,11 @@
 package com.alarmy.near
 
-import androidx.test.platform.app.InstrumentationRegistry
 import androidx.test.ext.junit.runners.AndroidJUnit4
-
+import androidx.test.platform.app.InstrumentationRegistry
+import org.junit.Assert.*
 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.alarmy.near", appContext.packageName)
     }
-}
+}

Near/app/src/main/java/com/alarmy/near/MainActivity.kt

@@ -22,7 +22,7 @@ class MainActivity : ComponentActivity() {
                 Scaffold(modifier = Modifier.fillMaxSize()) { innerPadding ->
                     Greeting(
                         name = "Android",
-                        modifier = Modifier.padding(innerPadding)
+                        modifier = Modifier.padding(innerPadding),
                     )
                 }
             }
@@ -31,10 +31,13 @@ class MainActivity : ComponentActivity() {
 }
 
 @Composable
-fun Greeting(name: String, modifier: Modifier = Modifier) {
+fun Greeting(
+    name: String,
+    modifier: Modifier = Modifier,
+) {
     Text(
         text = "Hello $name!",
-        modifier = modifier
+        modifier = modifier,
     )
 }
 
@@ -44,4 +47,4 @@ fun GreetingPreview() {
     NearTheme {
         Greeting("Android")
     }
-}
+}

Near/app/src/main/java/com/alarmy/near/NearApplication.kt

@@ -4,4 +4,4 @@ import android.app.Application
 import dagger.hilt.android.HiltAndroidApp
 
 @HiltAndroidApp
-class NearApplication : Application() 
+class NearApplication : Application()

Near/app/src/main/java/com/alarmy/near/db/AppDatabase.kt

@@ -1,10 +1,7 @@
 package com.alarmy.near.db
 
-import androidx.room.Database
-import androidx.room.RoomDatabase
-
 // TODO: 실제 Entity, Dao 추가 필요
-//@Database(entities = [], version = 1)
-//abstract class AppDatabase : RoomDatabase() {
+// @Database(entities = [], version = 1)
+// abstract class AppDatabase : RoomDatabase() {
 //    // abstract fun exampleDao(): ExampleDao
-//}
+// }

Near/app/src/main/java/com/alarmy/near/di/AppModule.kt

@@ -1,24 +1,8 @@
 package com.alarmy.near.di
 
-import android.content.Context
-import androidx.room.Room
-import com.alarmy.near.repository.ExampleRepository
-import com.alarmy.near.repository.ExampleRepositoryImpl
-import com.bumptech.glide.Glide
-import com.bumptech.glide.RequestManager
-import com.google.gson.Gson
-import com.google.gson.GsonBuilder
-import dagger.Module
-import dagger.Provides
-import dagger.hilt.InstallIn
-import dagger.hilt.components.SingletonComponent
-import retrofit2.Retrofit
-import retrofit2.converter.gson.GsonConverterFactory
-import javax.inject.Singleton
-
-//@Module
-//@InstallIn(SingletonComponent::class)
-//object AppModule {
+// @Module
+// @InstallIn(SingletonComponent::class)
+// object AppModule {
 //    @Provides
 //    @Singleton
 //    fun provideGson(): Gson = GsonBuilder().create()
@@ -44,4 +28,4 @@ import javax.inject.Singleton
 //    @Provides
 //    @Singleton
 //    fun provideExampleRepository(): ExampleRepository = ExampleRepositoryImpl()
-//}
+// }

Near/app/src/main/java/com/alarmy/near/repository/ExampleRepository.kt

@@ -2,4 +2,4 @@ package com.alarmy.near.repository
 
 interface ExampleRepository {
     fun getExampleData(): String
-} 
+}

Near/app/src/main/java/com/alarmy/near/repository/ExampleRepositoryImpl.kt

@@ -2,4 +2,4 @@ package com.alarmy.near.repository
 
 class ExampleRepositoryImpl : ExampleRepository {
     override fun getExampleData(): String = "Hello from Repository"
-} 
+}

Near/app/src/test/java/com/alarmy/near/ExampleUnitTest.kt

@@ -1,8 +1,7 @@
 package com.alarmy.near
 
-import org.junit.Test
-
 import org.junit.Assert.*
+import org.junit.Test
 
 /**
  * Example local unit test, which will execute on the development machine (host).
@@ -14,4 +13,4 @@ class ExampleUnitTest {
     fun addition_isCorrect() {
         assertEquals(4, 2 + 2)
     }
-}
+}

Near/build.gradle.kts

@@ -5,4 +5,5 @@ plugins {
     alias(libs.plugins.kotlin.compose) apply false
     alias(libs.plugins.hilt.application) apply false
     alias(libs.plugins.kotlin.kapt) apply false
-}
+    alias(libs.plugins.ktlint)
+}

Near/gradle/libs.versions.toml

@@ -17,6 +17,8 @@ retrofitVersion = "2.9.0"
 glideVersion = "4.16.0"
 # Room
 roomVersion = "2.6.1"
+# Ktlint
+ktlintVersion = "13.0.0"
 
 [libraries]
 androidx-core-ktx = { group = "androidx.core", name = "core-ktx", version.ref = "coreKtx" }
@@ -51,4 +53,5 @@ kotlin-android = { id = "org.jetbrains.kotlin.android", version.ref = "kotlin" }
 kotlin-compose = { id = "org.jetbrains.kotlin.plugin.compose", version.ref = "kotlin" }
 hilt-application = { id = "com.google.dagger.hilt.android", version.ref = "hiltVersion" }
 kotlin-kapt = { id = "org.jetbrains.kotlin.kapt", version.ref = "kotlin" }
+ktlint = { id = "org.jlleitschuh.gradle.ktlint", version.ref = "ktlintVersion" }
 

Near/settings.gradle.kts

@@ -21,4 +21,3 @@ dependencyResolutionManagement {
 
 rootProject.name = "Near"
 include(":app")
-