Improve the Gradle plugin's API and configuration's API.

Author: ForteScarlet

plugins/suspend-transform-plugin-gradle/src/main/kotlin/love/forte/plugin/suspendtrans/gradle/SuspendTransformGradlePlugin.kt

@@ -94,7 +94,6 @@ open class SuspendTransformGradlePlugin : KotlinCompilerPluginSupportPlugin {
                 project.providers.gradleProperty("love.forte.plugin.suspend-transform.suppressDeprecatedExtensionWarn")
                     .orNull.toBoolean()
 
-
             val msg = "WARN: The `love.forte.plugin.suspendtrans.gradle.SuspendTransformGradleExtension` " +
                     "(`suspendTransform { ... }`) is deprecated, \n" +
                     "please use `love.forte.plugin.suspendtrans.gradle.SuspendTransformPluginExtension` " +
@@ -255,45 +254,29 @@ private fun DeprecatedIncludeAnnotation.toIncludeAnnotation(): IncludeAnnotation
     )
 }
 
-private fun SuspendTransformPluginExtension.toSubpluginOptions(
-    target: KotlinTarget,
-    project: Project
-): List<SubpluginOption> {
-    // If not enabled or transformer is empty.
-    val cliConfig = SuspendTransformCliOptions.CLI_CONFIGURATION
-    val configuration = toConfiguration()
-    return if (configuration.transformers.isNotEmpty()) {
-        if (project.logger.isInfoEnabled) {
-            val count = configuration.transformers.values.sumOf { it.size }
-            project.logger.debug("The suspend transform is enabled with {} transformer(s) for {}", count, target)
-        }
-        listOf(SubpluginOption(cliConfig.optionName, configuration.encodeToHex()))
-    } else {
-        project.logger.debug("The suspend transform is disabled or transformers are empty for {}.", target)
-        emptyList()
-    }
-}
-
 private fun SuspendTransformPluginExtension.toSubpluginOptionsProvider(
     target: KotlinTarget,
     project: Project
 ): Provider<List<SubpluginOption>> {
     return enabled
-        .map { isEnabled ->
+        .flatMap { isEnabled ->
             if (!isEnabled) {
                 project.logger.debug("The suspend transform is disabled for {}.", target)
-                return@map emptyList()
+                return@flatMap project.provider { emptyList() }
             }
 
-            val configuration = toConfiguration()
-            val transformers = configuration.transformers
-            if (transformers.isEmpty()) {
-                project.logger.debug("The suspend transform is enabled but transformers are empty for {}.", target)
-                return@map emptyList()
-            }
+            val configurationProvider = toConfigurationProvider(project.objects)
 
-            val cliConfig = SuspendTransformCliOptions.CLI_CONFIGURATION
-            listOf(SubpluginOption(cliConfig.optionName, configuration.encodeToHex()))
+            configurationProvider.map { configuration ->
+                val transformers = configuration.transformers
+                if (transformers.isEmpty()) {
+                    project.logger.debug("The suspend transform is enabled but transformers are empty for {}.", target)
+                    return@map emptyList()
+                }
+
+                val cliConfig = SuspendTransformCliOptions.CLI_CONFIGURATION
+                listOf(SubpluginOption(cliConfig.optionName, configuration.encodeToHex()))
+            }
         }
 
 }

plugins/suspend-transform-plugin-gradle/src/main/kotlin/love/forte/plugin/suspendtrans/gradle/SuspendTransformPluginExtension.kt

@@ -35,12 +35,6 @@ internal interface NamedTransformerSpecListContainerInternal : NamedTransformerS
     override val platform: Property<TargetPlatform>
 }
 
-@RequiresOptIn(
-    "This API is an experimental public TransformersContainer's api. " +
-            "It may be changed in the future without notice."
-)
-annotation class ExperimentalTransformersContainerApi
-
 /**
  * @since 0.12.0
  */
@@ -285,7 +279,7 @@ abstract class SuspendTransformPluginExtension
     }
 }
 
-@OptIn(InternalSuspendTransformConfigurationApi::class, ExperimentalTransformersContainerApi::class)
+@OptIn(InternalSuspendTransformConfigurationApi::class)
 internal fun SuspendTransformPluginExtension.toConfiguration(): SuspendTransformConfiguration {
     return SuspendTransformConfiguration(
         // 此处 Map 可能为 空，但是 List 不会有空的。
@@ -304,6 +298,45 @@ internal fun SuspendTransformPluginExtension.toConfiguration(): SuspendTransform
     )
 }
 
+internal data class TransformerEntry(
+    val targetPlatform: TargetPlatform,
+    val transformers: List<Transformer>
+)
+
+@OptIn(InternalSuspendTransformConfigurationApi::class)
+internal fun SuspendTransformPluginExtension.toConfigurationProvider(objects: ObjectFactory): Provider<SuspendTransformConfiguration> {
+    val combines = objects.listProperty(TransformerEntry::class.java)
+    for ((targetPlatform, transformerListProperty) in transformers._containers) {
+        combines.addAll(
+            transformerListProperty.map { list ->
+                if (list.isEmpty()) {
+                    // Type mismatch: inferred type is TransformerEntry? but TransformerEntry was expected
+                    //  if return null with `combines.add`
+                    emptyList()
+                } else {
+                    listOf(
+                        TransformerEntry(targetPlatform, list.map { it.toTransformer() })
+                    )
+                }
+            }
+        )
+    }
+
+    return combines.map { entries ->
+        val transformersMap: Map<TargetPlatform, List<Transformer>> = entries.associateBy(
+            keySelector = { it.targetPlatform },
+            valueTransform = { it.transformers }
+        )
+
+        // 此处 `Map` 可能为 空，但是 `List` 不会有空的。
+        // 后续在使用的时候只需要判断一下 transformers 本身是不是空即可。
+        SuspendTransformConfiguration(
+            transformers = transformersMap
+        )
+    }
+
+}
+
 /**
  * @since 0.12.0
  */

settings.gradle.kts

@@ -35,7 +35,7 @@ include(":plugins:suspend-transform-plugin-gradle")
 // include(":local-helper")
 
 //Samples
-// include(":tests:test-jvm")
-// include(":tests:test-js")
-// include(":tests:test-kmp")
+include(":tests:test-jvm")
+include(":tests:test-js")
+include(":tests:test-kmp")
 // include(":tests:test-android")

tests/test-jvm/build.gradle.kts

@@ -32,22 +32,22 @@ dependencies {
     api(libs.kotlinx.coroutines.core)
 }
 
-@Suppress("DEPRECATION")
-suspendTransform {
-    enabled = true
-    includeAnnotation = false
-    includeRuntime = false
-    useDefault()
-}
-
-// suspendTransformPlugin {
+// @Suppress("DEPRECATION")
+// suspendTransform {
+//     enabled = true
 //     includeAnnotation = false
 //     includeRuntime = false
-//     transformers {
-//         useDefault()
-//     }
+//     useDefault()
 // }
 
+suspendTransformPlugin {
+    includeAnnotation = false
+    includeRuntime = false
+    transformers {
+        useDefault()
+    }
+}
+
 /*
 >     val blockingBaseName: String = "",
 >     val blockingSuffix: String = "Blocking",

tests/test-kmp/build.gradle.kts

@@ -1,6 +1,3 @@
-import love.forte.plugin.suspendtrans.ClassInfo
-import love.forte.plugin.suspendtrans.SuspendTransformConfiguration
-
 plugins {
     kotlin("multiplatform")
     id("love.forte.plugin.suspend-transform")
@@ -89,9 +86,9 @@ suspendTransform {
     includeAnnotation = false
     useJvmDefault()
     addJsTransformers(
-        SuspendTransformConfiguration.jsPromiseTransformer.copy(
+        love.forte.plugin.suspendtrans.SuspendTransformConfiguration.jsPromiseTransformer.copy(
             copyAnnotationExcludes = listOf(
-                ClassInfo("kotlin.js", "JsExport.Ignore")
+                love.forte.plugin.suspendtrans.ClassInfo("kotlin.js", "JsExport.Ignore")
             )
         )
     )