Merge pull request #50 from Go-Socket-Project/feature/49_setup_detekt

🔀 :: (#49) setup detekt

Author: Hyeonseo4799

.github/workflows/android.yml

@@ -39,6 +39,9 @@ jobs:
       - name: Run ktlint
         run: ./gradlew ktlintCheck
 
+      - name: Run detekt
+        run: ./gradlew detekt
+
       - name: Build with Gradle
         run: ./gradlew build
 

build-logic/build.gradle.kts

@@ -9,4 +9,5 @@ dependencies {
     implementation(libs.hilt.gradlePlugin)
     implementation(libs.ksp.gradlePlugin)
     implementation(libs.compose.compiler.gradlePlugin)
+    implementation(libs.detekt.gradlePlugin)
 }

build-logic/src/main/kotlin/com/chat/build_logic/VerifyDetekt.kt

@@ -0,0 +1,14 @@
+package com.chat.build_logic
+
+import org.gradle.api.Project
+import org.gradle.kotlin.dsl.dependencies
+
+internal fun Project.configureVerifyDetekt() {
+    with(pluginManager) {
+        apply("io.gitlab.arturbosch.detekt")
+    }
+
+    dependencies {
+        "detektPlugins"(libs.findLibrary("detekt.formatting").get())
+    }
+}

build-logic/src/main/kotlin/convention.android.library.gradle.kts

@@ -3,6 +3,7 @@ import com.chat.build_logic.configureKotlinAndroid
 plugins {
     id("com.android.library")
     kotlin("android")
+    id("convention.verify.detekt")
 }
 
 android {

build-logic/src/main/kotlin/convention.verify.detekt.gradle.kts

@@ -0,0 +1,13 @@
+import com.chat.build_logic.configureVerifyDetekt
+import io.gitlab.arturbosch.detekt.Detekt
+
+configureVerifyDetekt()
+
+tasks.withType<Detekt>().configureEach {
+    jvmTarget = "17"
+
+    buildUponDefaultConfig = true // 기본 설정에서 추가 설정만 덮어쓰기
+    allRules = false // 모든 룰을 활성화 할지 설정
+    parallel = true // 코드 분석 병렬 실행 설정
+    config = files("$rootDir/config/detekt/detekt.yml")
+}

build.gradle.kts

@@ -9,6 +9,7 @@ plugins {
     alias(libs.plugins.android.test) apply false
     alias(libs.plugins.baselineprofile) apply false
     alias(libs.plugins.compose.compiler) apply false
+    alias(libs.plugins.detekt) apply false
 }
 
 allprojects {

config/detekt/detekt.yml

@@ -0,0 +1,124 @@
+build:
+  maxIssues: 0
+
+config:
+  validation: true
+  warningsAsErrors: true
+
+complexity:
+  active: true
+  ComplexCondition: # 복잡한 조건 설정
+    active: true
+    threshold: 5
+  ComplexInterface: # 많은 함수 및 속성을 포함하는 인터페이스
+    active: true
+    threshold: 10
+    includeStaticDeclarations: false
+    includePrivateDeclarations: false
+  CyclomaticComplexMethod: # 독립적 경로의 수가 많은 복잡한 메서드 설정
+    active: true
+    threshold: 50
+    ignoreSingleWhenExpression: false # when 표현식 하나인 메서드 무시
+    ignoreSimpleWhenEntries: false # 간단한 항목(중괄호 없음)을 무시
+    ignoreNestingFunctions: false # if 나 for 문 대신 자주 사용되는 함수 무시
+    nestingFunctions:
+      - 'also'
+      - 'apply'
+      - 'forEach'
+      - 'isNotNull'
+      - 'ifNull'
+      - 'let'
+      - 'run'
+      - 'use'
+      - 'with'
+  LargeClass: # 큰 클래스 크기 설정
+    active: true
+    threshold: 500
+  LongMethod: # 긴 메서드 크기 설정
+    active: true
+    threshold: 400
+  LongParameterList: # 특정 임계값보다 많은 매개변수가 있는 함수와 생성자
+    active: true
+    functionThreshold: 20
+    constructorThreshold: 7
+    ignoreDefaultParameters: false # 기본값이 있는 매개변수 포함
+    ignoreDataClasses: true # 데이터 클래스에 대해서 무시
+  TooManyFunctions:
+    active: true
+    thresholdInFiles: 30
+    thresholdInClasses: 20
+    thresholdInInterfaces: 10
+    thresholdInObjects: 20
+    thresholdInEnums: 5
+    ignoreDeprecated: true # @Deprecated 함수를 카운트에서 제외
+    ignorePrivate: true # private 접근 제어자 함수를 카운트에서 제외
+    ignoreOverridden: false # 오버라이드한 함수를 카운트에 포함
+  NestedBlockDepth: # 중첩된 코드 블록
+    active: true
+    threshold: 10
+
+coroutines:
+  active: true
+  GlobalCoroutineUsage:
+    active: false
+  RedundantSuspendModifier:
+    active: false
+  SleepInsteadOfDelay:
+    active: false
+  SuspendFunWithFlowReturnType:
+    active: false
+
+empty-blocks:
+  active: true
+
+exceptions:
+  active: true
+  InstanceOfCheckForException: # 예외 유형을 검사하는 catch 블록
+    active: false
+  TooGenericExceptionThrown: # 너무 일반적인 유형의 Exception
+    active: false
+    exceptionNames:
+      - 'Error'
+      - 'Exception'
+      - 'RuntimeException'
+      - 'Throwable'
+
+formatting:
+  active: true
+  ImportOrdering:
+    active: false
+  MaximumLineLength:
+    active: true
+    maxLineLength: 160
+  ArgumentListWrapping:
+    active: false
+  Wrapping:
+    active: false
+  PackageName:
+    active: false
+
+naming:
+  active: true
+  ConstructorParameterNaming: # 지정된 명명 규칙을 따르지 않는 생성자 매개변수
+    active: false
+  FunctionNaming: # 지정된 명명 규칙을 따르지 않는 함수 이름
+    active: false
+  BooleanPropertyNaming:
+    active: true
+  NonBooleanPropertyPrefixedWithIs:
+    active: true
+  PackageNaming:
+    active: false
+
+performance:
+  active: true
+  ForEachOnRange: # 성능 비용이 발생하는 forEach 구문
+    active: false
+  SpreadOperator: # 성능 저하 발생하는 spread 연산자
+    active: false
+
+potential-bugs:
+  active: true
+
+style:
+  active: false

core/data/src/test/java/com/chat/data/ExampleUnitTest.kt

@@ -1,8 +1,7 @@
 package com.chat.data
 
 import org.junit.Test
-
-import org.junit.Assert.*
+import org.junit.Assert.assertEquals
 
 /**
  * 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)
     }
-}
+}

core/designsystem/src/main/java/com/chat/designsystem/component/appbar/DetailAppbar.kt

@@ -41,4 +41,4 @@ fun DetailAppbar(
 @Composable
 fun DetailAppbarPreview() {
     DetailAppbar()
-}
+}

core/designsystem/src/main/java/com/chat/designsystem/component/appbar/GoSocketAppbar.kt

@@ -46,4 +46,4 @@ fun GoSocketAppbarPreview() {
     ) {
         Text(text = "GoSocketAppbar")
     }
-}
+}