Introduced support for com.android.kotlin.multiplatform.library plugin (#346)

gmazzo · web-flow · commit baedda312cba · 2025-11-23T17:46:11.000Z
diff --git a/.github/workflows/ci-cd.yaml b/.github/workflows/ci-cd.yaml
@@ -32,15 +32,11 @@ jobs:
   build:
     name: Build (${{ matrix.project }})
     needs: compute-projects
-    runs-on: ${{ matrix.os || 'ubuntu' }}-latest
+    runs-on: ${{ contains(matrix.project, 'kmp') && 'macos' || 'ubuntu' }}-latest
     strategy:
       fail-fast: false
       matrix:
         project: ${{ fromJSON(needs.compute-projects.outputs.projects) }}
-        include:
-          - project: 'demo-project:kts-multiplatform'
-            os: 'macos'
-          - project: 'plugin'
     steps:
       - name: Checkout
         uses: actions/checkout@v5
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -8,6 +8,7 @@ plugins {
     alias(libs.plugins.kotlin.multiplatform) apply false
     alias(libs.plugins.android.application) apply false
     alias(libs.plugins.android.library) apply false
+    alias(libs.plugins.android.multiplatform) apply false
     alias(libs.plugins.publicationsReport)
     `jacoco-report-aggregation`
 }
diff --git a/demo-project/kmp-android-legacy/build.gradle.kts b/demo-project/kmp-android-legacy/build.gradle.kts
diff --git a/demo-project/kmp-android-legacy/src/androidMain/AndroidManifest.xml b/demo-project/kmp-android-legacy/src/androidMain/AndroidManifest.xml
diff --git a/demo-project/kmp-android-legacy/src/androidUnitTest/kotlin/com/github/gmazzo/buildconfig/demos/kmp_android_legacy/AndroidBuildConfigTest.kt b/demo-project/kmp-android-legacy/src/androidUnitTest/kotlin/com/github/gmazzo/buildconfig/demos/kmp_android_legacy/AndroidBuildConfigTest.kt
@@ -1,4 +1,4 @@
-package com.github.gmazzo.buildconfig.demos.kts_multiplatform
+package com.github.gmazzo.buildconfig.demos.kmp_android_legacy
 
 import com.eygraber.uri.Uri
 import com.github.gmazzo.buildconfig.demos.android.BuildConfig as AndroidBuildConfig
diff --git a/demo-project/kmp-android-legacy/src/commonTest/kotlin/com/github/gmazzo/buildconfig/demos/kmp_android_legacy/CommonBuildConfigTest.kt b/demo-project/kmp-android-legacy/src/commonTest/kotlin/com/github/gmazzo/buildconfig/demos/kmp_android_legacy/CommonBuildConfigTest.kt
@@ -0,0 +1,35 @@
+package com.github.gmazzo.buildconfig.demos.kmp_android_legacy
+
+import com.eygraber.uri.Uri
+import kotlin.test.Test
+import kotlin.test.assertEquals
+
+abstract class CommonBuildConfigTest(
+    private val expectedPlatform: String,
+    private val expectedMobile: Boolean = false,
+    private val expectedDebug: Boolean = false,
+    private val expectedUri: Uri = Uri.parse("https://api.example.com"),
+    private val expectedProduct: String? = null,
+) {
+
+    @Test
+    fun testBuildConfigProperties() {
+        assertEquals("aCommonValue", BuildConfig.COMMON_VALUE)
+        assertEquals(expectedPlatform, BuildConfig.PLATFORM)
+        assertEquals(expectedDebug, BuildConfig.DEBUG)
+        assertEquals(expectedUri, BuildConfig.ENDPOINT)
+        assertEquals(expectedProduct, BuildConfig.PRODUCT_VALUE)
+    }
+
+    @Test
+    fun testI18nProperties() {
+        assertEquals("Hello", i18n_hello)
+        assertEquals(expectedPlatform, i18n_kind)
+    }
+
+    @Test
+    fun testSingleProperties() {
+        assertEquals(expectedMobile, Single.IS_MOBILE)
+    }
+
+}
diff --git a/demo-project/kmp-android-legacy/src/iosTest/kotlin/com/github/gmazzo/buildconfig/demos/kmp_android_legacy/iOSBuildConfigTest.kt b/demo-project/kmp-android-legacy/src/iosTest/kotlin/com/github/gmazzo/buildconfig/demos/kmp_android_legacy/iOSBuildConfigTest.kt
@@ -0,0 +1,16 @@
+package com.github.gmazzo.buildconfig.demos.kmp_android_legacy
+
+import kotlin.test.Test
+import kotlin.test.assertEquals
+
+class iOSBuildConfigTest : CommonBuildConfigTest(
+    expectedPlatform = "ios",
+    expectedMobile = true,
+) {
+
+    @Test
+    fun testIOSOnlyValues() {
+        assertEquals("anIOSValue", BuildConfig.IOS_VALUE)
+    }
+
+}
diff --git a/demo-project/kmp-android-legacy/src/jvmMain/kotlin/com/github/gmazzo/buildconfig/demos/kmp_android_legacy/KSPService.kt b/demo-project/kmp-android-legacy/src/jvmMain/kotlin/com/github/gmazzo/buildconfig/demos/kmp_android_legacy/KSPService.kt
diff --git a/demo-project/kmp-android-legacy/src/jvmTest/kotlin/com/github/gmazzo/buildconfig/demos/kmp_android_legacy/JVMBuildConfigTest.kt b/demo-project/kmp-android-legacy/src/jvmTest/kotlin/com/github/gmazzo/buildconfig/demos/kmp_android_legacy/JVMBuildConfigTest.kt
@@ -0,0 +1,15 @@
+package com.github.gmazzo.buildconfig.demos.kmp_android_legacy
+
+import kotlin.test.Test
+import kotlin.test.assertEquals
+
+class JVMBuildConfigTest : CommonBuildConfigTest(
+    expectedPlatform = "jvm",
+) {
+
+    @Test
+    fun testJVMOnlyValues() {
+        assertEquals("aJvmValue", BuildConfig.JVM_VALUE)
+    }
+
+}
diff --git a/demo-project/kmp-android-legacy/src/webTest/kotlin/com/github/gmazzo/buildconfig/demos/kmp_android_legacy/WebBuildConfigTest.kt b/demo-project/kmp-android-legacy/src/webTest/kotlin/com/github/gmazzo/buildconfig/demos/kmp_android_legacy/WebBuildConfigTest.kt
@@ -0,0 +1,15 @@
+package com.github.gmazzo.buildconfig.demos.kmp_android_legacy
+
+import kotlin.test.Test
+import kotlin.test.assertEquals
+
+class WebBuildConfigTest : CommonBuildConfigTest(
+    expectedPlatform = "web",
+) {
+
+    @Test
+    fun testWebOnlyValues() {
+        assertEquals("aWebValue", BuildConfig.WEB_VALUE)
+    }
+
+}
diff --git a/demo-project/kmp/build.gradle.kts b/demo-project/kmp/build.gradle.kts
@@ -0,0 +1,107 @@
+@file:Suppress("OPT_IN_USAGE")
+
+import com.github.gmazzo.buildconfig.generators.BuildConfigKotlinGenerator
+import com.squareup.kotlinpoet.AnnotationSpec
+import com.squareup.kotlinpoet.ClassName
+import com.squareup.kotlinpoet.TypeSpec
+
+plugins {
+    alias(libs.plugins.android.multiplatform)
+    alias(libs.plugins.kotlin.multiplatform)
+    alias(libs.plugins.kotlin.ksp)
+    id("com.github.gmazzo.buildconfig")
+}
+
+java.toolchain.languageVersion = JavaLanguageVersion.of(libs.versions.java.get())
+
+kotlin {
+    androidLibrary { // new AGP KMP plugin does not supports variants nor app
+        compileSdk = 36
+        namespace = "com.github.gmazzo.buildconfig.demos.android"
+        minSdk = 21
+
+        withHostTest { } // the old `androidUnitTest` variant
+        withDeviceTest { } // the old `androidInstrumentedTest` variant
+    }
+    jvm()
+    iosArm64()
+    iosSimulatorArm64()
+    js(IR) { nodejs() }
+    wasmJs { nodejs() }
+    applyDefaultHierarchyTemplate()
+}
+
+dependencies {
+    "kspJvm"(libs.autoservice.ksp)
+    "jvmMainCompileOnly"(libs.autoservice)
+    commonMainImplementation(libs.uriKMP)
+    commonTestImplementation(libs.kotlin.test)
+}
+
+buildConfig {
+    buildConfigField("COMMON_VALUE",  expect("aCommonValue"))   // a constant for all platforms
+    buildConfigField("PLATFORM", expect<String>())                          // expect a platform specific value
+    buildConfigField("DEBUG", expect(false))                    // expect with a default
+    buildConfigField("com.eygraber.uri.Uri", "ENDPOINT",
+        expect(expression("Uri.parse(\"https://api.example.com\")")))
+    buildConfigField("PRODUCT_VALUE", expect<String?>(null))
+
+    forClass("i18n") {
+        useKotlinOutput { topLevelConstants = true }
+
+        buildConfigField("i18n_hello", expect("Hello"))
+        buildConfigField("i18n_kind", expect<String>())
+    }
+
+    forClass("Single") {
+        buildConfigField("IS_MOBILE", expect(false))
+    }
+
+    sourceSets.named("androidMain") {
+        buildConfigField("PLATFORM", "android")
+        buildConfigField("ANDROID_VALUE", "anAndroidValue")
+        buildConfigField("DEBUG", false)
+        forClass("i18n").buildConfigField("i18n_kind", "android")
+        forClass("Single").buildConfigField("IS_MOBILE", true)
+    }
+
+    sourceSets.named("test") {
+        buildConfigField("TEST_VALUE", "aTestValue")
+    }
+
+    sourceSets.named("jvmMain") {
+        buildConfigField("PLATFORM", "jvm")
+        buildConfigField("JVM_VALUE", "aJvmValue")
+        forClass("i18n").buildConfigField("i18n_kind", "jvm")
+        forClass("Single") // will inherit all defaults from `commonMain`
+    }
+
+    sourceSets.named("iosMain") {
+        buildConfigField("PLATFORM", "ios")
+        buildConfigField("IOS_VALUE", "anIOSValue")
+        forClass("i18n").buildConfigField("i18n_kind", "ios")
+        forClass("Single").buildConfigField("IS_MOBILE", true)
+    }
+
+    sourceSets.named("webMain") {
+        // Customize the generator to add @JsName annotations to the generated object
+        generator = object : BuildConfigKotlinGenerator() {
+            override fun adaptSpec(spec: TypeSpec) = spec.toBuilder()
+                .addAnnotation(
+                    AnnotationSpec.builder(ClassName.bestGuess("kotlin.js.JsName"))
+                        .addMember("name = %S", spec.name!!)
+                        .build()
+                )
+                .build()
+        }
+
+        buildConfigField("PLATFORM", "web")
+        buildConfigField("WEB_VALUE", "aWebValue")
+        forClass("i18n").buildConfigField("i18n_kind", "web")
+        forClass("Single") // will inherit all defaults from `commonMain`
+    }
+}
+
+tasks.named("compileTestDevelopmentExecutableKotlinJs") {
+    notCompatibleWithConfigurationCache("uses Task.project")
+}
diff --git a/demo-project/kmp/src/androidHostTest/kotlin/com/github/gmazzo/buildconfig/demos/kmp/AndroidBuildConfigTest.kt b/demo-project/kmp/src/androidHostTest/kotlin/com/github/gmazzo/buildconfig/demos/kmp/AndroidBuildConfigTest.kt
@@ -0,0 +1,19 @@
+package com.github.gmazzo.buildconfig.demos.kmp
+
+import com.eygraber.uri.Uri
+import kotlin.test.Test
+import kotlin.test.assertEquals
+
+class AndroidBuildConfigTest : CommonBuildConfigTest(
+    expectedPlatform = "android",
+    expectedMobile = true,
+    expectedProduct = null,
+    expectedUri = Uri.parse("https://api.example.com"),
+) {
+
+    @Test
+    fun testAndroidOnlyValues() {
+        assertEquals("anAndroidValue", BuildConfig.ANDROID_VALUE)
+    }
+
+}
diff --git a/demo-project/kmp/src/commonTest/kotlin/com/github/gmazzo/buildconfig/demos/kmp/CommonBuildConfigTest.kt b/demo-project/kmp/src/commonTest/kotlin/com/github/gmazzo/buildconfig/demos/kmp/CommonBuildConfigTest.kt
@@ -1,4 +1,4 @@
-package com.github.gmazzo.buildconfig.demos.kts_multiplatform
+package com.github.gmazzo.buildconfig.demos.kmp
 
 import com.eygraber.uri.Uri
 import kotlin.test.Test
diff --git a/demo-project/kmp/src/iosTest/kotlin/com/github/gmazzo/buildconfig/demos/kmp/iOSBuildConfigTest.kt b/demo-project/kmp/src/iosTest/kotlin/com/github/gmazzo/buildconfig/demos/kmp/iOSBuildConfigTest.kt
@@ -1,4 +1,4 @@
-package com.github.gmazzo.buildconfig.demos.kts_multiplatform
+package com.github.gmazzo.buildconfig.demos.kmp
 
 import kotlin.test.Test
 import kotlin.test.assertEquals
diff --git a/demo-project/kmp/src/jvmMain/kotlin/com/github/gmazzo/buildconfig/demos/kmp/KSPService.kt b/demo-project/kmp/src/jvmMain/kotlin/com/github/gmazzo/buildconfig/demos/kmp/KSPService.kt
@@ -0,0 +1,8 @@
+package com.github.gmazzo.buildconfig.demos.kmp
+
+import com.google.auto.service.AutoService
+
+interface KSPService
+
+@AutoService(KSPService::class)
+class KSPServiceImpl : KSPService
diff --git a/demo-project/kmp/src/jvmTest/kotlin/com/github/gmazzo/buildconfig/demos/kmp/JVMBuildConfigTest.kt b/demo-project/kmp/src/jvmTest/kotlin/com/github/gmazzo/buildconfig/demos/kmp/JVMBuildConfigTest.kt
@@ -1,4 +1,4 @@
-package com.github.gmazzo.buildconfig.demos.kts_multiplatform
+package com.github.gmazzo.buildconfig.demos.kmp
 
 import kotlin.test.Test
 import kotlin.test.assertEquals
diff --git a/demo-project/kmp/src/webTest/kotlin/com/github/gmazzo/buildconfig/demos/kmp/WebBuildConfigTest.kt b/demo-project/kmp/src/webTest/kotlin/com/github/gmazzo/buildconfig/demos/kmp/WebBuildConfigTest.kt
@@ -1,4 +1,4 @@
-package com.github.gmazzo.buildconfig.demos.kts_multiplatform
+package com.github.gmazzo.buildconfig.demos.kmp
 
 import kotlin.test.Test
 import kotlin.test.assertEquals
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -20,6 +20,7 @@ uriKMP = { module = "com.eygraber:uri-kmp", version = "0.0.21" }
 [plugins]
 android-application = { id = "com.android.application", version.ref = "android" }
 android-library = { id = "com.android.library", version.ref = "android" }
+android-multiplatform = { id = "com.android.kotlin.multiplatform.library", version.ref = "android" }
 dokka = { id = "org.jetbrains.dokka-javadoc", version = "2.1.0" }
 gitVersion = { id = "io.github.gmazzo.gitversion", version = "1.5.1" }
 gradle-pluginPublish = { id = "com.gradle.plugin-publish", version = "2.0.0" }
diff --git a/plugin/src/main/kotlin/com/github/gmazzo/buildconfig/BuildConfigPlugin.kt b/plugin/src/main/kotlin/com/github/gmazzo/buildconfig/BuildConfigPlugin.kt
@@ -79,7 +79,10 @@ public class BuildConfigPlugin : Plugin<Project> {
             with(KotlinBinder.Multiplatform) { configure(extension) }
         }
 
-        plugins.withId("com.android.base") {
+        plugins.withAnyId(
+            "com.android.base",
+            "com.android.kotlin.multiplatform.library"
+        ) {
             with(AndroidBinder) { configure(extension) }
         }
     }
diff --git a/plugin/src/main/kotlin/com/github/gmazzo/buildconfig/internal/bindings/AndroidBinder.kt b/plugin/src/main/kotlin/com/github/gmazzo/buildconfig/internal/bindings/AndroidBinder.kt
@@ -20,7 +20,7 @@ import org.gradle.kotlin.dsl.closureOf
 
 internal object AndroidBinder {
     private const val ANDROID_TEST_SOURCE_SET_NAME = "androidTest"
-    private val variantNameRegex = Regex("^(test|androidTest)?(.+?)(UnitTest|AndroidTest)?$")
+    private val variantNameRegex = Regex("^(test|androidTest|android)?(.+?)(UnitTest|AndroidTest)?$")
 
     fun Project.configure(extension: BuildConfigExtensionInternal) {
         val isKMP by lazy { isKotlinMultiplatform }
@@ -38,10 +38,12 @@ internal object AndroidBinder {
         fun nameOf(name: String) =
             if (isKMP) kmpNameOf(name) else name
 
-        androidSourceSets.all {
-            val spec = extension.sourceSets.maybeCreate(nameOf(it.name))
+        if (plugins.hasPlugin("com.android.base")) {
+            androidSourceSets.all {
+                val spec = extension.sourceSets.maybeCreate(nameOf(it.name))
 
-            (it as ExtensionAware).registerExtension(spec)
+                (it as ExtensionAware).registerExtension(spec)
+            }
         }
 
         val main by lazy { extension.sourceSets.maybeCreate(nameOf(MAIN_SOURCE_SET_NAME)) }
@@ -93,8 +95,10 @@ internal object AndroidBinder {
         }
         supersededSpecs.addAll(flavorsSpecs)
 
-        mainSpec.supersededBy(spec)
-        spec.defaultsFrom(mainSpec)
+        if (mainSpec != spec) {
+            mainSpec.supersededBy(spec)
+            spec.defaultsFrom(mainSpec)
+        }
 
         for (parentSpec in supersededSpecs) {
             parentSpec.dependsOn(mainSpec)
@@ -106,6 +110,7 @@ internal object AndroidBinder {
         }
 
         sourcesJavaAddGeneratedSourceDirectory(spec.generateTask, BuildConfigTask::outputDir)
+        sourcesKotlinAddGeneratedSourceDirectory(spec.generateTask, BuildConfigTask::outputDir)
     }
 
     private val Project.androidComponents: ExtensionAware
@@ -160,14 +165,27 @@ internal object AndroidBinder {
     private val Any/*Component*/.productFlavors
         get() = javaClass.getMethod("getProductFlavors").invoke(this) as List<Pair<String, String>>
 
-    // Component.sources.java!!.addGeneratedSourceDirectory
+    // Component.sources.java?.addGeneratedSourceDirectory
     private fun <Type : Task> Any/*Component*/.sourcesJavaAddGeneratedSourceDirectory(
         task: TaskProvider<out Type>,
         wiredWith: (Type) -> DirectoryProperty,
+    ) = sourcesAddGeneratedSourceDirectory("getJava", task, wiredWith)
+
+    // Component.sources.kotlin?.addGeneratedSourceDirectory
+    private fun <Type : Task> Any/*Component*/.sourcesKotlinAddGeneratedSourceDirectory(
+        task: TaskProvider<out Type>,
+        wiredWith: (Type) -> DirectoryProperty,
+    ) = sourcesAddGeneratedSourceDirectory("getKotlin", task, wiredWith)
+
+    private fun <Type : Task> Any/*Component*/.sourcesAddGeneratedSourceDirectory(
+        into: String,
+        task: TaskProvider<out Type>,
+        wiredWith: (Type) -> DirectoryProperty,
     ) = with(javaClass.getMethod("getSources").invoke(this)) {
-        with(javaClass.getMethod("getJava").invoke(this)) {
-            javaClass.getMethod("addGeneratedSourceDirectory", TaskProvider::class.java, Function1::class.java)
-                .invoke(this, task, wiredWith)
+        with(javaClass.getMethod(into).invoke(this)) {
+            this?.javaClass
+                ?.getMethod("addGeneratedSourceDirectory", TaskProvider::class.java, Function1::class.java)
+                ?.invoke(this, task, wiredWith)
         }
     }
 
@@ -189,6 +207,7 @@ internal object AndroidBinder {
         return when {
             prefix == "test" || suffix == "UnitTest" -> return "androidUnitTest${variant.capitalized}"
             prefix == "androidTest" || suffix == "AndroidTest" -> return "androidInstrumentedTest${variant.capitalized}"
+            prefix == "android" -> name // e.g., androidMain, androidHostTest
             else -> "android${variant.capitalized}"
         }
     }
diff --git a/settings.gradle.kts b/settings.gradle.kts
@@ -13,5 +13,6 @@ include(
     "demo-project:kts-android",
     "demo-project:kts-android-lib",
     "demo-project:kts-gen-java",
-    "demo-project:kts-multiplatform",
+    "demo-project:kmp",
+    "demo-project:kmp-android-legacy",
 )

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@ plugins {`
`8`	`8`	`alias(libs.plugins.kotlin.multiplatform) apply false`
`9`	`9`	`alias(libs.plugins.android.application) apply false`
`10`	`10`	`alias(libs.plugins.android.library) apply false`
	`11`	`+ alias(libs.plugins.android.multiplatform) apply false`
`11`	`12`	`alias(libs.plugins.publicationsReport)`
`12`	`13`	`jacoco-report-aggregation`
`13`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package com.github.gmazzo.buildconfig.demos.kts_multiplatform`
	`1`	`+package com.github.gmazzo.buildconfig.demos.kmp_android_legacy`
`2`	`2`
`3`	`3`	`import com.eygraber.uri.Uri`
`4`	`4`	`import com.github.gmazzo.buildconfig.demos.android.BuildConfig as AndroidBuildConfig`