- Added a konsistTest module to enforce coding conventions.

Author: yesshreyes

build.gradle.kts

@@ -9,4 +9,5 @@ plugins {
     alias(libs.plugins.serialization) apply false
     alias(libs.plugins.googleSecrets) apply false
     alias(libs.plugins.jetbrainsKotlinJvm) apply false
+    alias(libs.plugins.androidKotlinMultiplatformLibrary) apply false
 }

gradle/libs.versions.toml

@@ -25,6 +25,9 @@ navigation-compose = "2.9.0"
 ktlint = "12.2.0"
 secrets = "2.0.1"
 jetbrainsKotlinJvm = "2.1.10"
+kotlinStdlib = "2.1.10"
+runner = "1.6.2"
+core = "1.6.1"
 
 [libraries]
 androidx-navigation-compose = { module = "androidx.navigation:navigation-compose", version.ref = "navigation-compose" }
@@ -59,6 +62,9 @@ koin-bom = { module = "io.insert-koin:koin-bom", version.ref = "koin" }
 koin-compose = { module = "io.insert-koin:koin-compose" }
 koin-compose-viewmodel = { module = "io.insert-koin:koin-compose-viewmodel", version.ref = "koin" }
 koin-core = { module = "io.insert-koin:koin-core", version.ref = "koin" }
+kotlin-stdlib = { group = "org.jetbrains.kotlin", name = "kotlin-stdlib", version.ref = "kotlinStdlib" }
+androidx-runner = { group = "androidx.test", name = "runner", version.ref = "runner" }
+androidx-core = { group = "androidx.test", name = "core", version.ref = "core" }
 
 [plugins]
 androidApplication = { id = "com.android.application", version.ref = "agp" }
@@ -70,3 +76,4 @@ serialization = { id = "org.jetbrains.kotlin.plugin.serialization", version.ref
 ktlint = { id = "org.jlleitschuh.gradle.ktlint", version.ref = "ktlint" }
 googleSecrets = { id = "com.google.android.libraries.mapsplatform.secrets-gradle-plugin", version.ref = "secrets" }
 jetbrainsKotlinJvm = { id = "org.jetbrains.kotlin.jvm", version.ref = "jetbrainsKotlinJvm" }
+androidKotlinMultiplatformLibrary = { id = "com.android.kotlin.multiplatform.library", version.ref = "agp" }

konsistTest/build.gradle.kts

@@ -0,0 +1,18 @@
+plugins {
+    kotlin("jvm")
+    id("java")
+}
+
+kotlin {
+    jvmToolchain(21)
+}
+
+dependencies {
+    testImplementation("com.lemonappdev:konsist:0.17.2")
+    testImplementation("org.junit.jupiter:junit-jupiter-engine:5.11.3")
+    testImplementation(kotlin("test"))
+}
+
+tasks.test {
+    useJUnitPlatform()
+}

konsistTest/src/main/java/com/example/konsisttest/MyClass.kt

@@ -0,0 +1,4 @@
+package com.example.konsisttest
+
+class MyClass {
+}

konsistTest/src/test/kotlin/SampleKonsistTest.kt

@@ -0,0 +1,33 @@
+import com.lemonappdev.konsist.api.Konsist
+import org.junit.jupiter.api.Assertions.assertTrue
+import org.junit.jupiter.api.Test
+
+class SampleKonsistTest {
+    @Test
+    fun `no direct usage of androidx compose text should be allowed except designSystem`() {
+        checkNoDirectUsageExceptAllowed(
+            componentName = "androidx.compose.material.Text",
+            excludePaths = arrayOf(),
+        )
+    }
+}
+
+fun checkNoDirectUsageExceptAllowed(
+    componentName: String,
+    excludePaths: Array<String>,
+) {
+    val offendingFiles = Konsist.scopeFromProject()
+        .files
+        .filter { file ->
+            val normalizedFilePath = file.path.replace("\\", "/").lowercase()
+            excludePaths.none { normalizedFilePath.contains(it.replace("\\", "/").lowercase()) }
+        }
+        .filter { file ->
+            file.imports.any { it.name == componentName }
+        }
+
+    assertTrue(offendingFiles.isEmpty()) {
+        "Found forbidden imports of $componentName in files:\n" +
+                offendingFiles.joinToString("\n") { it.path }
+    }
+}

settings.gradle.kts

@@ -29,4 +29,5 @@ dependencyResolutionManagement {
 }
 
 include(":composeApp")
-include(":custom-ktlint-rules")
+include(":custom-ktlint-rules")
+include(":konsistTest")