Merge pull request #93 from ForteScarlet/improve-cli-options

Refactor and update Gradle plugin APIs and configurations

Author: ForteScarlet

README.md

@@ -0,0 +1,10 @@
+/**
+ * 为了让 gradle 插件可以在 buildSrc 之类的地方使用。
+ */
+fun org.jetbrains.kotlin.gradle.dsl.KotlinJvmProjectExtension.configGradleBuildSrcFriendly() {
+    coreLibrariesVersion = "1.9.0"
+    compilerOptions {
+        apiVersion.set(org.jetbrains.kotlin.gradle.dsl.KotlinVersion.KOTLIN_1_9)
+        languageVersion.set(org.jetbrains.kotlin.gradle.dsl.KotlinVersion.KOTLIN_1_9)
+    }
+}

README_CN.md

@@ -11,7 +11,7 @@ object IProject : ProjectDetail() {
 
     // Remember the libs.versions.toml!
     val ktVersion = "2.1.20"
-    val pluginVersion = "0.11.1"
+    val pluginVersion = "0.12.0"
 
     override val version: String = "$ktVersion-$pluginVersion"
 

buildSrc/src/main/kotlin/GradleSupportHelper.kt

@@ -0,0 +1,6 @@
+# CliOption Module
+
+TODO：将 CliOption 相关的内容独立出来，
+以避免在 Gradle Plugin 中传递引用 Kotlin compiler。
+
+see also: 

buildSrc/src/main/kotlin/IProject.kt

@@ -0,0 +1,33 @@
+import org.jetbrains.kotlin.gradle.dsl.JvmTarget
+
+plugins {
+    kotlin("jvm")
+    kotlin("plugin.serialization")
+    // id("com.github.gmazzo.buildconfig")
+    id("suspend-transform.jvm-maven-publish")
+}
+
+dependencies {
+    compileOnly(kotlin("stdlib"))
+    compileOnly(kotlin("compiler"))
+    api(project(":compiler:suspend-transform-plugin-configuration"))
+    api(libs.kotlinx.serialization.core)
+    api(libs.kotlinx.serialization.protobuf)
+
+    testImplementation(libs.kotlinx.serialization.json)
+    testImplementation(kotlin("test"))
+    testImplementation(kotlin("compiler"))
+    // testImplementation(libs.kotlinx.coroutines.core)
+}
+
+kotlin {
+    configGradleBuildSrcFriendly()
+    compilerOptions {
+        jvmTarget.set(JvmTarget.JVM_1_8)
+        freeCompilerArgs.addAll("-Xjvm-default=all")
+    }
+}
+
+tasks.test {
+    useJUnitPlatform()
+}

compiler/suspend-transform-plugin-cli/README.md

@@ -0,0 +1,25 @@
+package love.forte.plugin.suspendtrans.cli
+
+import kotlinx.serialization.ExperimentalSerializationApi
+import kotlinx.serialization.decodeFromHexString
+import kotlinx.serialization.encodeToHexString
+import kotlinx.serialization.protobuf.ProtoBuf
+import love.forte.plugin.suspendtrans.configuration.SuspendTransformConfiguration
+import love.forte.plugin.suspendtrans.configuration.SuspendTransformConfiguration.Companion.serializer
+
+// Cli Options for gradle plugin
+
+@OptIn(ExperimentalSerializationApi::class)
+private val SERIALIZER = ProtoBuf {
+    encodeDefaults = true
+}
+
+@OptIn(ExperimentalSerializationApi::class)
+fun SuspendTransformConfiguration.encodeToHex(): String {
+    return SERIALIZER.encodeToHexString(serializer(), this)
+}
+
+@OptIn(ExperimentalSerializationApi::class)
+fun decodeSuspendTransformConfigurationFromHex(hex: String): SuspendTransformConfiguration {
+    return SERIALIZER.decodeFromHexString(serializer(), hex)
+}

compiler/suspend-transform-plugin-cli/build.gradle.kts

@@ -0,0 +1,3 @@
+package love.forte.plugin.suspendtrans.cli
+
+// Cli Options for Kotlin compiler plugin

compiler/suspend-transform-plugin-cli/src/main/kotlin/love/forte/plugin/suspendtrans/cli/GradlePluginCliOptions.kt

@@ -0,0 +1,80 @@
+package love.forte.plugin.suspendtrans.cli
+
+import org.jetbrains.kotlin.compiler.plugin.AbstractCliOption
+
+/**
+ *
+ *
+ * @author ForteScarlet
+ */
+interface SuspendTransformCliOption {
+    val optionName: String
+    val valueDescription: String
+    val description: String
+    val required: Boolean
+    val allowMultipleOccurrences: Boolean
+}
+
+private data class SimpleSuspendTransformCliOption(
+    override val allowMultipleOccurrences: Boolean,
+    override val description: String,
+    override val optionName: String,
+    override val required: Boolean,
+    override val valueDescription: String
+) : SuspendTransformCliOption
+
+private data class AbstractCliOptionImpl(
+    override val allowMultipleOccurrences: Boolean,
+    override val description: String,
+    override val optionName: String,
+    override val required: Boolean,
+    override val valueDescription: String
+) : AbstractCliOption, SuspendTransformCliOption
+
+/**
+ * Creates an instance of [SuspendTransformCliOption] to describe and define a CLI option.
+ *
+ * @param optionName The name of the option used to identify it in the CLI.
+ * @param valueDescription A description of the option's value, defaults to the option name.
+ * @param description A textual description of the option, defaults to an empty string.
+ * @param required Whether this option is mandatory, defaults to not required (`false`).
+ * @param allowMultipleOccurrences Whether this option can appear multiple times in the CLI,
+ * defaults to not allowed (`false`).
+ * @return Returns an instance of [SuspendTransformCliOption] implemented by [SimpleSuspendTransformCliOption].
+ */
+fun SuspendTransformCliOption(
+    optionName: String,
+    valueDescription: String = optionName,
+    description: String = "",
+    required: Boolean = false,
+    allowMultipleOccurrences: Boolean = false
+): SuspendTransformCliOption {
+    // Create and return an instance of the concrete implementation class
+    return SimpleSuspendTransformCliOption(
+        allowMultipleOccurrences = allowMultipleOccurrences,
+        description = description,
+        optionName = optionName,
+        required = required,
+        valueDescription = valueDescription
+    )
+}
+
+/**
+ * Converts the current [SuspendTransformCliOption] instance to an [AbstractCliOption].
+ * If the current object is already an [AbstractCliOption], it is returned directly;
+ * otherwise, a new instance is created and returned.
+ *
+ * @return The converted [AbstractCliOption] instance
+ */
+fun SuspendTransformCliOption.toAbstractCliOption(): AbstractCliOption {
+    return this as? AbstractCliOption ?: AbstractCliOptionImpl(
+        allowMultipleOccurrences = allowMultipleOccurrences,
+        description = description,
+        optionName = optionName,
+        required = required,
+        valueDescription = valueDescription
+    )
+}
+
+
+

compiler/suspend-transform-plugin-cli/src/main/kotlin/love/forte/plugin/suspendtrans/cli/KotlinCompilerPluginCliOptions.kt

@@ -0,0 +1,13 @@
+package love.forte.plugin.suspendtrans.cli
+
+object SuspendTransformCliOptions {
+    const val CONFIGURATION = "configuration"
+
+    val CLI_CONFIGURATION = SuspendTransformCliOption(
+        optionName = "configuration",
+        valueDescription = "Configuration hex string",
+        description = "Configuration serialized protobuf hex string value",
+        required = true,
+        allowMultipleOccurrences = false,
+    )
+}