feat(core): add an abbr of respond() to simplify pure text logics

Aliorpse · Aliorpse · commit 213a4182b9e7 · 2026-03-19T22:22:39.000+08:00
no test due to there are no impl for the current milky version
diff --git a/saltify-core/src/commonMain/kotlin/org/ntqqrev/saltify/core/SaltifyApplication.kt b/saltify-core/src/commonMain/kotlin/org/ntqqrev/saltify/core/SaltifyApplication.kt
@@ -10,14 +10,9 @@ import io.ktor.client.request.*
 import io.ktor.http.*
 import io.ktor.serialization.kotlinx.*
 import io.ktor.serialization.kotlinx.json.*
-import io.ktor.util.logging.KtorSimpleLogger
+import io.ktor.util.logging.*
 import kotlinx.coroutines.*
-import kotlinx.coroutines.flow.MutableSharedFlow
-import kotlinx.coroutines.flow.MutableStateFlow
-import kotlinx.coroutines.flow.SharedFlow
-import kotlinx.coroutines.flow.StateFlow
-import kotlinx.coroutines.flow.asSharedFlow
-import kotlinx.coroutines.flow.asStateFlow
+import kotlinx.coroutines.flow.*
 import kotlinx.serialization.json.decodeFromJsonElement
 import org.ntqqrev.milky.*
 import org.ntqqrev.saltify.annotation.WithApiExtension
diff --git a/saltify-core/src/commonMain/kotlin/org/ntqqrev/saltify/dsl/SaltifyCommandContext.kt b/saltify-core/src/commonMain/kotlin/org/ntqqrev/saltify/dsl/SaltifyCommandContext.kt
@@ -1,7 +1,6 @@
 package org.ntqqrev.saltify.dsl
 
-import io.ktor.util.logging.KtorSimpleLogger
-import io.ktor.util.logging.Logger
+import io.ktor.util.logging.*
 import kotlinx.coroutines.delay
 import kotlinx.coroutines.flow.filterIsInstance
 import kotlinx.coroutines.flow.first
diff --git a/saltify-core/src/commonMain/kotlin/org/ntqqrev/saltify/dsl/SaltifyPluginContext.kt b/saltify-core/src/commonMain/kotlin/org/ntqqrev/saltify/dsl/SaltifyPluginContext.kt
@@ -1,7 +1,6 @@
 package org.ntqqrev.saltify.dsl
 
-import io.ktor.util.logging.KtorSimpleLogger
-import io.ktor.util.logging.Logger
+import io.ktor.util.logging.*
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Job
 import kotlinx.coroutines.delay
@@ -13,6 +12,7 @@ import org.ntqqrev.saltify.annotation.SaltifyDsl
 import org.ntqqrev.saltify.core.SaltifyApplication
 import org.ntqqrev.saltify.core.recallGroupMessage
 import org.ntqqrev.saltify.core.recallPrivateMessage
+import org.ntqqrev.saltify.core.text
 import org.ntqqrev.saltify.extension.command
 import org.ntqqrev.saltify.extension.on
 import org.ntqqrev.saltify.extension.regex
@@ -79,6 +79,14 @@ public class SaltifyPluginContext internal constructor(
         block: MutableList<OutgoingSegment>.() -> Unit
     ): SendMessageOutput = respond(client, block)
 
+    /**
+     * 响应事件。这是用于返回纯文本的简写。
+     */
+    @ContextParametersMigrationNeeded
+    public suspend fun Event.MessageReceive.respond(
+        text: String
+    ): SendMessageOutput = respond { text(text) }
+
     /**
      * 响应事件，并在指定延迟后撤回消息。
      */
diff --git a/saltify-core/src/commonMain/kotlin/org/ntqqrev/saltify/extension/CommandContextExtension.kt b/saltify-core/src/commonMain/kotlin/org/ntqqrev/saltify/extension/CommandContextExtension.kt
@@ -1,8 +1,10 @@
 package org.ntqqrev.saltify.extension
 
+import org.ntqqrev.saltify.core.text
 import org.ntqqrev.saltify.dsl.SaltifyCommandContext
 import org.ntqqrev.saltify.dsl.SaltifyCommandExecutionContext
 import org.ntqqrev.saltify.dsl.SaltifyCommandParamDef
+import org.ntqqrev.saltify.model.milky.SendMessageOutput
 
 /**
  * 定义一个指令参数。请搭配 [SaltifyCommandExecutionContext.capture] 使用。
@@ -11,3 +13,10 @@ public inline fun <reified T : Any> SaltifyCommandContext.parameter(
     name: String,
     description: String = ""
 ): SaltifyCommandParamDef<T> = parameter(T::class, name, description)
+
+/**
+ * 响应事件。这是用于返回纯文本的简写。
+ */
+public suspend inline fun SaltifyCommandExecutionContext.respond(
+    text: String
+): SendMessageOutput = respond { text(text) }
diff --git a/saltify-core/src/commonMain/kotlin/org/ntqqrev/saltify/extension/EventExtension.kt b/saltify-core/src/commonMain/kotlin/org/ntqqrev/saltify/extension/EventExtension.kt
@@ -6,6 +6,7 @@ import org.ntqqrev.milky.OutgoingSegment
 import org.ntqqrev.saltify.core.SaltifyApplication
 import org.ntqqrev.saltify.core.sendGroupMessage
 import org.ntqqrev.saltify.core.sendPrivateMessage
+import org.ntqqrev.saltify.core.text
 import org.ntqqrev.saltify.dsl.SaltifyPluginContext
 import org.ntqqrev.saltify.model.milky.SendMessageOutput
 
@@ -25,3 +26,11 @@ public suspend fun Event.MessageReceive.respond(
         SendMessageOutput(output.messageSeq, output.time)
     }
 }
+
+/**
+ * 响应事件。这是用于返回纯文本的简写。鉴于 Context Parameter 尚未完善，这里需要手动传 client。
+ */
+public suspend inline fun Event.MessageReceive.respond(
+    client: SaltifyApplication,
+    text: String
+): SendMessageOutput = respond(client) { text(text) }
diff --git a/saltify-core/src/jvmTest/kotlin/org/ntqqrev/saltify/PluginTest.kt b/saltify-core/src/jvmTest/kotlin/org/ntqqrev/saltify/PluginTest.kt
@@ -5,10 +5,10 @@ import kotlinx.coroutines.runBlocking
 import org.ntqqrev.milky.IncomingMessage
 import org.ntqqrev.saltify.core.SaltifyApplication
 import org.ntqqrev.saltify.core.getLoginInfo
-import org.ntqqrev.saltify.core.text
 import org.ntqqrev.saltify.dsl.SaltifyPlugin
 import org.ntqqrev.saltify.extension.parameter
 import org.ntqqrev.saltify.extension.plainText
+import org.ntqqrev.saltify.extension.respond
 import org.ntqqrev.saltify.model.EventConnectionType
 import kotlin.test.Test
 
@@ -50,16 +50,14 @@ class PluginTest {
 
         // regex test
         regex("""BV1\w{9}""") { event, matches ->
-            event.respond {
-                text(matches.joinToString { it.value })
-            }
+            event.respond(matches.joinToString { it.value })
         }
 
         // config test
         command("hello") {
             onExecute {
                 logger.info("config: ${config.response}")
-                respond { text(config.response) }
+                respond(config.response)
             }
         }
 
@@ -68,15 +66,11 @@ class PluginTest {
             val content = greedyStringParameter("content", "words to repeat")
 
             onExecute {
-                respond {
-                    text(content.value)
-                }
+                respond(content.value)
             }
 
             onFailure {
-                respond {
-                    text("Command run failed: ${it.message}")
-                }
+                respond("Command run failed: ${it.message}")
             }
         }
 
@@ -90,19 +84,15 @@ class PluginTest {
         // context propagation test
         command("shutdown") {
             onExecute {
-                respond {
-                    text("Are you sure? (yes/no)")
-                }
+                respond("Are you sure? (yes/no)")
 
                 val event = awaitNextMessage()
 
                 if (event == null) {
-                    respond { text("Operation cancelled due to timeout") }
+                    respond("Operation cancelled due to timeout")
                 } else {
                     val content = event.segments.plainText
-                    respond {
-                        text("You just responded \"$content\". However, whatever you say I won't shutdown myself.")
-                    }
+                    respond("You just responded \"$content\". However, whatever you say I won't shutdown myself.")
                 }
             }
         }
@@ -116,13 +106,11 @@ class PluginTest {
 
                 onExecute {
                     val result = a.value + b.value
-                    respond { text("$result") }
+                    respond("$result")
                 }
 
                 onFailure {
-                    respond {
-                        text("Command run failed: ${it.message}")
-                    }
+                    respond("Command run failed: ${it.message}")
                 }
             }
 
@@ -131,7 +119,7 @@ class PluginTest {
                 val base = parameter<Int>("base")
                 onExecute {
                     val value = base.value
-                    respond { text("The power of $value is ${value * value}") }
+                    respond("The power of $value is ${value * value}")
                 }
             }
         }
@@ -140,19 +128,15 @@ class PluginTest {
         command("whereami") {
             onGroupExecute {
                 val data = event.data as IncomingMessage.Group
-                respond {
-                    text("In group：${data.group.groupName} (${data.group.groupId})")
-                }
+                respond("In group：${data.group.groupName} (${data.group.groupId})")
             }
 
             onPrivateExecute {
-                respond {
-                    text("In private chat")
-                }
+                respond("In private chat")
             }
 
             onExecute {
-                respond { text("unknown") }
+                respond("Unknown chat environment")
             }
         }
 
@@ -163,9 +147,7 @@ class PluginTest {
             val note = greedyStringParameter("note")
 
             onExecute {
-                respond {
-                    text("Order #${id.value} created\nnote：${note.value}")
-                }
+                respond("Order #${id.value} created\nnote：${note.value}")
             }
         }
     }

Original file line number	Diff line number	Diff line change
`@@ -5,10 +5,10 @@ import kotlinx.coroutines.runBlocking`
`5`	`5`	`import org.ntqqrev.milky.IncomingMessage`
`6`	`6`	`import org.ntqqrev.saltify.core.SaltifyApplication`
`7`	`7`	`import org.ntqqrev.saltify.core.getLoginInfo`
`8`		`-import org.ntqqrev.saltify.core.text`
`9`	`8`	`import org.ntqqrev.saltify.dsl.SaltifyPlugin`
`10`	`9`	`import org.ntqqrev.saltify.extension.parameter`
`11`	`10`	`import org.ntqqrev.saltify.extension.plainText`
	`11`	`+import org.ntqqrev.saltify.extension.respond`
`12`	`12`	`import org.ntqqrev.saltify.model.EventConnectionType`
`13`	`13`	`import kotlin.test.Test`
`14`	`14`
`@@ -50,16 +50,14 @@ class PluginTest {`
`50`	`50`
`51`	`51`	`// regex test`
`52`	`52`	`regex("""BV1\w{9}""") { event, matches ->`
`53`		`- event.respond {`
`54`		`- text(matches.joinToString { it.value })`
`55`		`- }`
	`53`	`+ event.respond(matches.joinToString { it.value })`
`56`	`54`	`}`
`57`	`55`
`58`	`56`	`// config test`
`59`	`57`	`command("hello") {`
`60`	`58`	`onExecute {`
`61`	`59`	`logger.info("config: ${config.response}")`
`62`		`- respond { text(config.response) }`
	`60`	`+ respond(config.response)`
`63`	`61`	`}`
`64`	`62`	`}`
`65`	`63`
`@@ -68,15 +66,11 @@ class PluginTest {`
`68`	`66`	`val content = greedyStringParameter("content", "words to repeat")`
`69`	`67`
`70`	`68`	`onExecute {`
`71`		`- respond {`
`72`		`- text(content.value)`
`73`		`- }`
	`69`	`+ respond(content.value)`
`74`	`70`	`}`
`75`	`71`
`76`	`72`	`onFailure {`
`77`		`- respond {`
`78`		`- text("Command run failed: ${it.message}")`
`79`		`- }`
	`73`	`+ respond("Command run failed: ${it.message}")`
`80`	`74`	`}`
`81`	`75`	`}`
`82`	`76`
`@@ -90,19 +84,15 @@ class PluginTest {`
`90`	`84`	`// context propagation test`
`91`	`85`	`command("shutdown") {`
`92`	`86`	`onExecute {`
`93`		`- respond {`
`94`		`- text("Are you sure? (yes/no)")`
`95`		`- }`
	`87`	`+ respond("Are you sure? (yes/no)")`
`96`	`88`
`97`	`89`	`val event = awaitNextMessage()`
`98`	`90`
`99`	`91`	`if (event == null) {`
`100`		`- respond { text("Operation cancelled due to timeout") }`
	`92`	`+ respond("Operation cancelled due to timeout")`
`101`	`93`	`} else {`
`102`	`94`	`val content = event.segments.plainText`
`103`		`- respond {`
`104`		`- text("You just responded \"$content\". However, whatever you say I won't shutdown myself.")`
`105`		`- }`
	`95`	`+ respond("You just responded \"$content\". However, whatever you say I won't shutdown myself.")`
`106`	`96`	`}`
`107`	`97`	`}`
`108`	`98`	`}`
`@@ -116,13 +106,11 @@ class PluginTest {`
`116`	`106`
`117`	`107`	`onExecute {`
`118`	`108`	`val result = a.value + b.value`
`119`		`- respond { text("$result") }`
	`109`	`+ respond("$result")`
`120`	`110`	`}`
`121`	`111`
`122`	`112`	`onFailure {`
`123`		`- respond {`
`124`		`- text("Command run failed: ${it.message}")`
`125`		`- }`
	`113`	`+ respond("Command run failed: ${it.message}")`
`126`	`114`	`}`
`127`	`115`	`}`
`128`	`116`
`@@ -131,7 +119,7 @@ class PluginTest {`
`131`	`119`	`val base = parameter<Int>("base")`
`132`	`120`	`onExecute {`
`133`	`121`	`val value = base.value`
`134`		`- respond { text("The power of $value is ${value * value}") }`
	`122`	`+ respond("The power of $value is ${value * value}")`
`135`	`123`	`}`
`136`	`124`	`}`
`137`	`125`	`}`
`@@ -140,19 +128,15 @@ class PluginTest {`
`140`	`128`	`command("whereami") {`
`141`	`129`	`onGroupExecute {`
`142`	`130`	`val data = event.data as IncomingMessage.Group`
`143`		`- respond {`
`144`		`- text("In group：${data.group.groupName} (${data.group.groupId})")`
`145`		`- }`
	`131`	`+ respond("In group：${data.group.groupName} (${data.group.groupId})")`
`146`	`132`	`}`
`147`	`133`
`148`	`134`	`onPrivateExecute {`
`149`		`- respond {`
`150`		`- text("In private chat")`
`151`		`- }`
	`135`	`+ respond("In private chat")`
`152`	`136`	`}`
`153`	`137`
`154`	`138`	`onExecute {`
`155`		`- respond { text("unknown") }`
	`139`	`+ respond("Unknown chat environment")`
`156`	`140`	`}`
`157`	`141`	`}`
`158`	`142`
`@@ -163,9 +147,7 @@ class PluginTest {`
`163`	`147`	`val note = greedyStringParameter("note")`
`164`	`148`
`165`	`149`	`onExecute {`
`166`		`- respond {`
`167`		`- text("Order #${id.value} created\nnote：${note.value}")`
`168`		`- }`
	`150`	`+ respond("Order #${id.value} created\nnote：${note.value}")`
`169`	`151`	`}`
`170`	`152`	`}`
`171`	`153`	`}`