Added detekt

Author: wkornewald

.github/workflows/build.yaml

@@ -37,8 +37,10 @@ jobs:
       # TODO: switch to Kover
 #      - name: Create coverage report
 #        run: ./gradlew jacocoTestReportDefault
-      - name: Final checks
+      - name: ktlint
         run: ./gradlew ktlint
+      - name: detekt
+        run: ./gradlew detekt
 
       # Publish packages
       - name: Publish package

build-logic/build-logic-base/build.gradle.kts

@@ -6,6 +6,7 @@ plugins {
 dependencies {
     api(libs.android.gradle)
     api(libs.kotlin.gradle)
+    api(libs.detekt.gradle)
     api(libs.dokka.gradle)
 }
 

build-logic/build-logic-base/src/main/kotlin/com/ensody/buildlogic/DetektExt.kt

@@ -0,0 +1,34 @@
+package com.ensody.buildlogic
+
+import org.gradle.api.Project
+import org.gradle.kotlin.dsl.assign
+import org.gradle.kotlin.dsl.withType
+
+fun Project.setupDetekt() {
+    tasks.withType<io.gitlab.arturbosch.detekt.Detekt>().configureEach {
+        // Enable type resolution
+        classpath = detektClasspath
+        jvmTarget = "17"
+
+        config.from(
+            *listOf(
+                rootProject.file("build-logic/build-logic/src/main/resources/detekt.yml"),
+                rootProject.file("build-logic/build-logic-base/src/main/resources/detekt.yml"),
+            ).filter { it.exists() }.toTypedArray(),
+        )
+        buildUponDefaultConfig = true
+
+        setSource(
+            files(
+                file("src").listFiles().filter {
+                    it.name.endsWith("Main") || it.name.endsWith("Test") || it.name in setOf("main", "test")
+                }.flatMap {
+                    listOf(it.resolve("kotlin"), it.resolve("java"))
+                },
+            ),
+        )
+    }
+    tasks.withType<io.gitlab.arturbosch.detekt.DetektCreateBaselineTask>().configureEach {
+        jvmTarget = "17"
+    }
+}

build-logic/build-logic-base/src/main/resources/detekt.yml

@@ -0,0 +1,38 @@
+complexity:
+  active: false
+
+coroutines:
+  InjectDispatcher:
+    dispatcherNames:
+      - 'Main'
+      - 'IO'
+      - 'Default'
+      - 'Unconfined'
+
+exceptions:
+  TooGenericExceptionCaught:
+    active: false
+
+naming:
+  FunctionNaming:
+    functionPattern: '[a-zA-Z][a-zA-Z0-9]*'
+  MatchingDeclarationName:
+    active: false
+
+potential-bugs:
+  IgnoredReturnValue:
+    active: false
+
+style:
+  ForbiddenComment:
+    active: false
+  MayBeConst:
+    active: false
+  ReturnCount:
+    active: false
+  UnnecessaryAbstractClass:
+    active: false
+  UnusedPrivateMember:
+    allowedNames: "readResolve"
+  UseOrEmpty:
+    active: false

build-logic/build-logic/src/main/kotlin/com/ensody/buildlogic/BuildLogicPlugin.kt

@@ -4,9 +4,9 @@ package com.ensody.buildlogic
 
 import com.android.build.gradle.BaseExtension
 import io.github.gradlenexus.publishplugin.NexusPublishExtension
+import io.gitlab.arturbosch.detekt.extensions.DetektExtension
 import org.gradle.api.Plugin
 import org.gradle.api.Project
-import org.gradle.api.artifacts.ProjectDependency
 import org.gradle.api.plugins.JavaPlatformExtension
 import org.gradle.api.publish.PublishingExtension
 import org.gradle.kotlin.dsl.assign
@@ -32,6 +32,7 @@ class BuildLogicPlugin : Plugin<Project> {
                         pluginManager.apply("org.jetbrains.compose")
                         pluginManager.apply("org.jetbrains.kotlin.plugin.compose")
                     }
+                    pluginManager.apply("io.gitlab.arturbosch.detekt")
                 }
                 pluginManager.apply("maven-publish")
             }
@@ -111,6 +112,9 @@ fun Project.setupBuildLogic(block: Project.() -> Unit) {
         if (extensions.findByType<KotlinBaseExtension>() != null) {
             setupKtLint(libs.findLibrary("ktlint-cli").get())
         }
+        if (extensions.findByType<DetektExtension>() != null) {
+            setupDetekt()
+        }
         if (extensions.findByType<DokkaExtension>() != null) {
             setupDokka(copyright = "Ensody GmbH")
         }

build.gradle.kts

@@ -4,9 +4,11 @@ plugins {
     id("com.ensody.build-logic")
     alias(libs.plugins.android.application) apply false
     alias(libs.plugins.kotlin.android) apply false
+    alias(libs.plugins.kotlin.jvm) apply false
     alias(libs.plugins.jetbrains.compose) apply false
     alias(libs.plugins.kotlin.compose) apply false
     alias(libs.plugins.dokka) apply false
+    alias(libs.plugins.detekt)
     alias(libs.plugins.nexusPublish)
 }
 

gradle/libs.versions.toml

@@ -8,6 +8,7 @@ androidxTestCore = "1.6.1"
 androidGradle = "8.8.2"
 dokka = "2.0.0"
 desugarJdkLibs = "2.1.5"
+detekt = "1.23.8"
 nexusPublish = "2.0.0"
 
 [libraries]
@@ -45,12 +46,15 @@ robolectric = { module = "org.robolectric:robolectric", version = "4.14.1" }
 android-gradle = { module = "com.android.tools.build:gradle", version.ref = "androidGradle" }
 kotlin-gradle = { module = "org.jetbrains.kotlin:kotlin-gradle-plugin", version.ref = "kotlin" }
 dokka-gradle = { module = "org.jetbrains.dokka:dokka-gradle-plugin", version.ref = "dokka" }
+detekt-gradle = { module = "io.gitlab.arturbosch.detekt:detekt-gradle-plugin", version.ref = "detekt" }
 nexus-gradle = { module = "io.github.gradle-nexus:publish-plugin", version.ref = "nexusPublish" }
 
 [plugins]
 android-application = { id = "com.android.application", version.ref = "androidGradle" }
 dokka = { id = "org.jetbrains.dokka", version.ref = "dokka" }
 jetbrains-compose = { id = "org.jetbrains.compose", version = "1.7.3" }
 kotlin-android = { id = "org.jetbrains.kotlin.android", version.ref = "kotlin" }
+kotlin-jvm = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin" }
 kotlin-compose = { id = "org.jetbrains.kotlin.plugin.compose", version.ref = "kotlin" }
+detekt = { id = "io.gitlab.arturbosch.detekt", version.ref = "detekt" }
 nexusPublish = { id = "io.github.gradle-nexus.publish-plugin", version.ref = "nexusPublish" }

reactivestate-android/src/androidMain/kotlin/com/ensody/reactivestate/android/ReactiveViewModelExt.kt

@@ -51,9 +51,7 @@ public inline fun <reified T : CoroutineLauncher> ComponentActivity.reactiveView
 public fun Lazy<CoroutineLauncher>.attachLazyReactiveViewModel(
     owner: LifecycleOwner,
 ) {
-    if (owner !is ErrorEvents) {
-        throw IllegalStateException("You have to implement the ErrorEvents interface.")
-    }
+    check(owner is ErrorEvents) { "You have to implement the ErrorEvents interface." }
     owner.onStart {
         val viewModel = value
         val emittedErrors = ContextualErrorsFlow.get(viewModel.scope)
@@ -91,9 +89,7 @@ public fun <E : ErrorEvents> Lazy<ReactiveState<E>>.attachLazyReactiveState(
     handler: E?,
     owner: LifecycleOwner,
 ) {
-    if (handler == null) {
-        throw IllegalStateException("You have to implement the ViewModel's events interface.")
-    }
+    checkNotNull(handler) { "You have to implement the ViewModel's events interface." }
     owner.launchOnceStateAtLeast(Lifecycle.State.CREATED) {
         value.eventNotifier.handleEvents(handler, owner)
     }

reactivestate-core/src/commonMain/kotlin/com/ensody/reactivestate/AutoRunWhileUsed.kt

@@ -3,7 +3,7 @@ package com.ensody.reactivestate
 /** Returns [WhileUsed]'s value and keeps it alive as long as it's still used. */
 public fun <T> Resolver.get(data: WhileUsed<T>): T {
     val value = track(data) { WhileUsedObservable(data) }.value
-    require(value != null) { "Fatal error: The observer couldn't be started." }
+    requireNotNull(value) { "Fatal error: The observer couldn't be started." }
     return value.value
 }
 

reactivestate-core/src/commonMain/kotlin/com/ensody/reactivestate/CoroutineDispatcherConfig.kt

@@ -19,6 +19,7 @@ public interface CoroutineDispatcherConfig {
 }
 
 /** The default [CoroutineDispatcherConfig], mapping to [Dispatchers]. */
+@Suppress("InjectDispatcher")
 public object DefaultCoroutineDispatcherConfig : CoroutineDispatcherConfig {
     override val main: CoroutineDispatcher get() = Dispatchers.Main
     override val default: CoroutineDispatcher get() = Dispatchers.Default