[chore] 기초 세팅 / Github Actions 세팅, KtLint 적용

.editorconfig

@@ -0,0 +1,11 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+insert_final_newline = true
+tab_width = 4
+disabled_rules = no-wildcard-imports,import-ordering,comment-spacing

.github/workflows/pr_checker.yml

@@ -18,7 +18,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v3
 
-      - name: Gradle cache
+      - name: Cache Gradle packages
         uses: actions/cache@v3
         with:
           path: |
@@ -28,13 +28,16 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-gradle-
 
-      - name: set up JDK 17
+      - name: Setup JDK 17
         uses: actions/setup-java@v3
         with:
           distribution: 'temurin'
           java-version: 17
 
-      - name: Change gradlew permissions
+      - name: Setup Android SDK
+        uses: android-actions/setup-android@v2
+
+      - name: Grant execute permission for gradlew
         run: chmod +x ./gradlew
 
       - name: Add Local Properties
@@ -43,9 +46,21 @@ jobs:
         run: |
           echo auth.base.url=$AUTH_BASE_URL >> ./local.properties
 
+#      - name: Access Firebase Service
+#        run: echo '${{ secrets.GOOGLE_SERVICES_JSON }}' > ./app/google-services.json
+
       - name: Build debug APK
         run: ./gradlew assembleDebug --stacktrace
 
+#      - name: Upload APK
+#        uses: actions/upload-artifact@v1
+#        with:
+#            name: app
+#            path: app/build/outputs/apk/debug
+
+      - name: Run ktlint
+        run: ./gradlew ktlintCheck
+
       - name: On Success, Notify in Slack
         if: ${{ success() }}
         uses: rtCamp/action-slack-notify@v2
@@ -68,4 +83,4 @@ jobs:
           SLACK_TITLE: 'Winey checks have failed 🚫'
           MSG_MINIMAL: true
           SLACK_USERNAME: Winey Android
-          SLACK_MESSAGE: '버그 잡자 ㅋㅅㅋ'
+          SLACK_MESSAGE: '버그 잡자 🐛'

app/build.gradle.kts

@@ -1,13 +1,13 @@
 import com.android.build.gradle.internal.cxx.configure.gradleLocalProperties
 
 plugins {
-    id(Plugins.androidApplication)
-    id(Plugins.kotlinAndroid)
-    id(Plugins.kotlinParcelize)
-    id(Plugins.kotlinKapt)
-    id(Plugins.hiltPlugin)
-    id(Plugins.ossLicensesPlugin)
-    id(Plugins.kotlinSerialization)
+    id(ModulePlugins.androidApplication)
+    id(ModulePlugins.kotlinAndroid)
+    id(ModulePlugins.kotlinParcelize)
+    id(ModulePlugins.kotlinKapt)
+    id(ModulePlugins.kotlinSerialization)
+    id(ModulePlugins.hilt)
+    id(ModulePlugins.oss)
 }
 
 android {
@@ -24,7 +24,7 @@ android {
         buildConfigField(
             "String",
             "AUTH_BASE_URL",
-            gradleLocalProperties(rootDir).getProperty("auth.base.url"),
+            gradleLocalProperties(rootDir).getProperty("auth.base.url")
         )
 
         testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
@@ -94,7 +94,7 @@ dependencies {
     implementation(MaterialDesignDependencies.materialDesign)
 
     KaptDependencies.run {
-        kapt(hiltCompiler)
+        kapt(hiltAndroidCompiler)
         kapt(hiltWorkManagerCompiler)
     }
 
@@ -117,4 +117,4 @@ dependencies {
         debugImplementation(flipperLeakCanary)
         debugImplementation(soloader)
     }
-}
+}

app/src/androidTest/java/com/android/go/sopt/winey/ExampleInstrumentedTest.kt

@@ -2,10 +2,8 @@ package com.android.go.sopt.winey
 
 import androidx.test.platform.app.InstrumentationRegistry
 import androidx.test.ext.junit.runners.AndroidJUnit4
-
 import org.junit.Test
 import org.junit.runner.RunWith
-
 import org.junit.Assert.*
 
 /**
@@ -21,4 +19,4 @@ class ExampleInstrumentedTest {
         val appContext = InstrumentationRegistry.getInstrumentation().targetContext
         assertEquals("com.android.go.sopt.winey", appContext.packageName)
     }
-}
+}

app/src/main/java/com/android/go/sopt/winey/WineyApplication.kt

@@ -10,4 +10,4 @@ class WineyApplication : Application() {
         super.onCreate()
         if (BuildConfig.DEBUG) Timber.plant(Timber.DebugTree())
     }
-}
+}

app/src/main/java/com/android/go/sopt/winey/data/interceptor/AuthInterceptor.kt

@@ -6,7 +6,6 @@ import okhttp3.Interceptor
 import okhttp3.Response
 import javax.inject.Inject
 
-
 class AuthInterceptor @Inject constructor(
     @ApplicationContext context: Context
 ) : Interceptor {
@@ -24,4 +23,4 @@ class AuthInterceptor @Inject constructor(
         private const val HEADER_TOKEN = "userId"
         const val USER_ID = "24"
     }
-}
+}

app/src/main/java/com/android/go/sopt/winey/data/model/remote/request/RequestCreateGoalDto.kt

@@ -6,7 +6,7 @@ import kotlinx.serialization.Serializable
 @Serializable
 data class RequestCreateGoalDto(
     @SerialName("targetMoney")
-    val targetMoney : Int,
+    val targetMoney: Int,
     @SerialName("targetDay")
-    val targetDay : Int,
+    val targetDay: Int
 )

app/src/main/java/com/android/go/sopt/winey/data/model/remote/request/RequestPostLikeDto.kt

@@ -6,5 +6,5 @@ import kotlinx.serialization.Serializable
 @Serializable
 data class RequestPostLikeDto(
     @SerialName("feedLike")
-    val feedLike : Boolean
+    val feedLike: Boolean
 )

app/src/main/java/com/android/go/sopt/winey/data/model/remote/response/ResponseCreateGoalDto.kt

@@ -7,14 +7,14 @@ import kotlinx.serialization.Serializable
 @Serializable
 data class ResponseCreateGoalDto(
     @SerialName("userId")
-    val userId : Int,
+    val userId: Int,
     @SerialName("targetMoney")
-    val targetMoney : Long,
+    val targetMoney: Long,
     @SerialName("targetDate")
     val targetDate: String,
     @SerialName("createdAt")
-    val createdAt: String,
-){
+    val createdAt: String
+) {
     fun toGoal(): Goal {
         val data = this
 

app/src/main/java/com/android/go/sopt/winey/data/model/remote/response/ResponseDeleteWineyFeedDto.kt

@@ -4,4 +4,4 @@ data class ResponseDeleteWineyFeedDto(
     val code: Int,
     val data: Any,
     val message: String
-)
+)

app/src/main/java/com/android/go/sopt/winey/data/model/remote/response/ResponseGetRecommendListDto.kt

@@ -18,7 +18,7 @@ data class ResponseGetRecommendListDto(
         @SerialName("currentPageIndex")
         val currentPageIndex: Int,
         @SerialName("isEnd")
-        val isEnd: Boolean,
+        val isEnd: Boolean
     )
 
     @Serializable
@@ -46,7 +46,7 @@ data class ResponseGetRecommendListDto(
             title = it.recommendTitle ?: "",
             subtitle = it.recommendSubTitle ?: "",
             discount = it.recommendDiscount ?: "",
-            image = it.recommendImage ?: "",
+            image = it.recommendImage ?: ""
         )
     }
 }

app/src/main/java/com/android/go/sopt/winey/data/model/remote/response/ResponseGetUserDto.kt

@@ -55,4 +55,4 @@ data class ResponseGetUserDto(
             isAttained = data.userResponseGoalDto?.isAttained ?: false
         )
     }
-}
+}

app/src/main/java/com/android/go/sopt/winey/data/model/remote/response/ResponseGetWineyFeedListDto.kt

@@ -69,4 +69,4 @@ data class ResponseGetWineyFeedListDto(
             totalPageSize = data.pageResponseDto.totalPageSize
         )
     }
-}
+}

app/src/main/java/com/android/go/sopt/winey/data/model/remote/response/ResponsePostLikeDto.kt

@@ -27,4 +27,4 @@ data class ResponsePostLikeDto(
         val likeData = Like.Data(data.feedId, data.isLiked, data.likes)
         return Like(code, likeData, message)
     }
-}
+}

app/src/main/java/com/android/go/sopt/winey/data/model/remote/response/ResponsePostWineyFeedDto.kt

@@ -10,4 +10,4 @@ data class ResponsePostWineyFeedDto(
     val feedId: Int,
     @SerialName("createdAt")
     val createdAt: LocalDateTime
-)
+)

app/src/main/java/com/android/go/sopt/winey/data/model/remote/response/base/BaseResponse.kt

@@ -10,5 +10,5 @@ data class BaseResponse<T>(
     @SerialName("message")
     val message: String,
     @SerialName("data")
-    val data: T? = null,
-)
+    val data: T? = null
+)

app/src/main/java/com/android/go/sopt/winey/data/repository/AuthRepositoryImpl.kt

@@ -33,7 +33,6 @@ class AuthRepositoryImpl @Inject constructor(
             response.toWineyFeed()
         }
 
-
     override suspend fun postWineyFeed(
         file: MultipartBody.Part?,
         requestMap: HashMap<String, RequestBody>
@@ -49,7 +48,7 @@ class AuthRepositoryImpl @Inject constructor(
 
     override suspend fun postFeedLike(feedId: Int, requestPostLikeDto: RequestPostLikeDto): Result<Like> =
         runCatching {
-            authDataSource.postFeedLike(feedId,requestPostLikeDto).toLike()
+            authDataSource.postFeedLike(feedId, requestPostLikeDto).toLike()
         }
 
     override suspend fun postCreateGoal(requestCreateGoalDto: RequestCreateGoalDto): Result<Goal> =
@@ -61,5 +60,4 @@ class AuthRepositoryImpl @Inject constructor(
         runCatching {
             authDataSource.getRecommendList(page).data!!.convertToRecommend()
         }
-
-}
+}

app/src/main/java/com/android/go/sopt/winey/data/service/AuthService.kt

@@ -32,7 +32,7 @@ interface AuthService {
 
     @GET("feed/myFeed")
     suspend fun getMyFeedList(
-        @Query("page") page:Int
+        @Query("page") page: Int
     ): ResponseGetWineyFeedListDto
 
     @POST("feedLike/{feedId}")
@@ -55,10 +55,11 @@ interface AuthService {
 
     @GET("recommend")
     suspend fun getRecommendList(
-        @Query("page") page:Int
+        @Query("page") page: Int
     ): BaseResponse<ResponseGetRecommendListDto>
+
     @DELETE("feed/{feedId}")
     suspend fun deleteFeed(
         @Path("feedId") feedId: Int
     ): BaseResponse<Unit>
-}
+}

app/src/main/java/com/android/go/sopt/winey/data/source/AuthDataSource.kt

@@ -37,8 +37,8 @@ class AuthDataSource @Inject constructor(
     suspend fun postCreateGoal(requestCreateGoalDto: RequestCreateGoalDto): BaseResponse<ResponseCreateGoalDto> =
         authService.postCreateGoal(requestCreateGoalDto)
 
-    suspend fun getRecommendList(page: Int) : BaseResponse<ResponseGetRecommendListDto> =
+    suspend fun getRecommendList(page: Int): BaseResponse<ResponseGetRecommendListDto> =
         authService.getRecommendList(page)
     suspend fun deleteFeed(feedId: Int): BaseResponse<Unit> =
         authService.deleteFeed(feedId)
-}
+}

app/src/main/java/com/android/go/sopt/winey/di/RepositoryModule.kt

@@ -16,4 +16,4 @@ abstract class RepositoryModule {
     abstract fun bindsAuthRepository(
         authRepository: AuthRepositoryImpl
     ): AuthRepository
-}
+}

app/src/main/java/com/android/go/sopt/winey/di/RetrofitModule.kt

@@ -45,13 +45,13 @@ object RetrofitModule {
     @Provides
     @Singleton
     @Auth
-    fun provideAuthInterceptor (interceptor: AuthInterceptor): Interceptor = interceptor
+    fun provideAuthInterceptor(interceptor: AuthInterceptor): Interceptor = interceptor
 
     @Provides
     @Singleton
     fun provideOkHttpClient(
         @Logger loggingInterceptor: Interceptor,
-        @Auth authInterceptor: Interceptor,
+        @Auth authInterceptor: Interceptor
     ): OkHttpClient = OkHttpClient.Builder()
         .addInterceptor(loggingInterceptor)
         .addInterceptor(authInterceptor)
@@ -61,10 +61,10 @@ object RetrofitModule {
     @Singleton
     fun provideRetrofit(
         client: OkHttpClient,
-        factory: Converter.Factory,
+        factory: Converter.Factory
     ): Retrofit = Retrofit.Builder()
         .baseUrl(AUTH_BASE_URL)
         .client(client)
         .addConverterFactory(factory)
         .build()
-}
+}

app/src/main/java/com/android/go/sopt/winey/di/ServiceModule.kt

@@ -15,4 +15,4 @@ object ServiceModule {
     @Singleton
     fun provideAuthService(retrofit: Retrofit): AuthService =
         retrofit.create(AuthService::class.java)
-}
+}

app/src/main/java/com/android/go/sopt/winey/di/qualifier/InterceptorQualifier.kt

@@ -4,8 +4,8 @@ import javax.inject.Qualifier
 
 @Qualifier
 @Retention(AnnotationRetention.BINARY)
-annotation class  Logger
+annotation class Logger
 
 @Qualifier
 @Retention(AnnotationRetention.BINARY)
-annotation class  Auth
+annotation class Auth

app/src/main/java/com/android/go/sopt/winey/domain/entity/Goal.kt

@@ -2,5 +2,5 @@ package com.android.go.sopt.winey.domain.entity
 
 data class Goal(
     val userId: Int,
-    val targetMoney: Long,
+    val targetMoney: Long
 )

app/src/main/java/com/android/go/sopt/winey/domain/entity/Like.kt

@@ -10,4 +10,4 @@ data class Like(
         val isLiked: Boolean,
         val likes: Int
     )
-}
+}

app/src/main/java/com/android/go/sopt/winey/domain/entity/Recommend.kt

@@ -6,5 +6,5 @@ data class Recommend(
     val title: String,
     val subtitle: String,
     val discount: String,
-    val image: String,
+    val image: String
 )