@koishi-ce/plugin-echo 1.0.0

package/lib/assets/zh-CN-CrW2M7HM.yml

@@ -0,0 +1,12 @@
+commands:
+  echo:
+    description: 发送消息
+    options:
+      escape: 发送转义消息
+      unescape: 发送反转义消息
+      user: 发送到用户
+      channel: 发送到频道
+      guild: 指定群组编号
+    messages:
+      expect-text: 请输入要发送的文本。
+      platform-not-found: 找不到指定的平台。

package/lib/index.d.ts

@@ -0,0 +1,15 @@
+import { Context, Schema } from "@koishi-ce/koishi";
+//#region src/index.d.ts
+/**
+ * 解析 `platform:id` 形式的目标标识
+ * @param target 形如 `platform:id` 的字符串
+ * @returns [平台名, 目标 ID] 二元组
+ */
+declare function parsePlatform(target: string): [platform: string, id: string];
+/** 配置项（当前无可用配置） */
+type Config = Record<never, never>;
+declare const name = "echo";
+declare const Config: Schema<Config>;
+declare function apply(ctx: Context, _config: Config): void;
+//#endregion
+export { Config, apply, name, parsePlatform };

package/lib/index.mjs

@@ -0,0 +1,43 @@
+import { Schema, h } from "@koishi-ce/koishi";
+import zhCN from "./assets/zh-CN-CrW2M7HM.yml";
+//#region src/index.ts
+/**
+* 消息复述插件（echo）。
+*
+* 提供 `echo <message>` 指令：原样返回输入文本。
+* 权限 3 以上的选项：`-e` / `-E` 转义 / 反转义消息中的 CQ 码；
+* `-u` / `-c`（可配合 `-g` 指定群组）把消息发送到指定用户私聊或指定频道。
+*/
+/**
+* 解析 `platform:id` 形式的目标标识
+* @param target 形如 `platform:id` 的字符串
+* @returns [平台名, 目标 ID] 二元组
+*/
+function parsePlatform(target) {
+	const index = target.indexOf(":");
+	return [target.slice(0, index), target.slice(index + 1)];
+}
+const name = "echo";
+const Config = Schema.object({});
+function apply(ctx, _config) {
+	ctx.i18n.define("zh-CN", zhCN);
+	ctx.command("echo <message:text>").option("escape", "-e", { authority: 3 }).option("unescape", "-E", { authority: 3 }).option("user", "-u [user:user]", { authority: 3 }).option("channel", "-c [channel:channel]", { authority: 3 }).option("guild", "-g [guild:string]", { authority: 3 }).action(async ({ options, session }, message) => {
+		if (!session || !options) return;
+		if (!message) return session.text(".expect-text");
+		let content = [message];
+		if (options.unescape) content = h.parse(message);
+		else if (options.escape) content = [h.escape(message)];
+		const target = options.user || options.channel;
+		if (target) {
+			const [platform, id] = parsePlatform(target);
+			const bot = ctx.bots.find((bot) => bot.platform === platform);
+			if (!bot) return session.text(".platform-not-found");
+			else if (options.user) await bot.sendPrivateMessage(id, content, session.guildId);
+			else await bot.sendMessage(id, content, options.guild);
+			return;
+		}
+		return content;
+	});
+}
+//#endregion
+export { Config, apply, name, parsePlatform };

package/locales/de-DE.yml

@@ -0,0 +1,12 @@
+commands:
+  echo:
+    description: 发送消息
+    options:
+      escape: 发送转义消息
+      unescape: 发送反转义消息
+      user: 发送到用户
+      channel: 发送到频道
+      guild: 指定群组编号
+    messages:
+      expect-text: 请输入要发送的文本。
+      platform-not-found: 找不到指定的平台。

package/locales/en-US.yml

@@ -0,0 +1,12 @@
+commands:
+  echo:
+    description: Send messages
+    options:
+      escape: Sending escape messages
+      unescape: Sending of reverse-escaped messages
+      user: Send to user
+      channel: Send to channel
+      guild: Assign guild number
+    messages:
+      expect-text: Please type to send
+      platform-not-found: Can't find the platform you have in mind.

package/locales/fr-FR.yml

@@ -0,0 +1,12 @@
+commands:
+  echo:
+    description: 发送消息
+    options:
+      escape: 发送转义消息
+      unescape: 发送反转义消息
+      user: 发送到用户
+      channel: 发送到频道
+      guild: 指定群组编号
+    messages:
+      expect-text: 请输入要发送的文本。
+      platform-not-found: 找不到指定的平台。

package/locales/ja-JP.yml

@@ -0,0 +1,12 @@
+commands:
+  echo:
+    description: 发送消息
+    options:
+      escape: 发送转义消息
+      unescape: 发送反转义消息
+      user: 发送到用户
+      channel: 发送到频道
+      guild: 指定群组编号
+    messages:
+      expect-text: 请输入要发送的文本。
+      platform-not-found: 找不到指定的平台。

package/locales/ru-RU.yml

@@ -0,0 +1,12 @@
+commands:
+  echo:
+    description: 发送消息
+    options:
+      escape: 发送转义消息
+      unescape: 发送反转义消息
+      user: 发送到用户
+      channel: 发送到频道
+      guild: 指定群组编号
+    messages:
+      expect-text: 请输入要发送的文本。
+      platform-not-found: 找不到指定的平台。

package/locales/zh-CN.yml

@@ -0,0 +1,12 @@
+commands:
+  echo:
+    description: 发送消息
+    options:
+      escape: 发送转义消息
+      unescape: 发送反转义消息
+      user: 发送到用户
+      channel: 发送到频道
+      guild: 指定群组编号
+    messages:
+      expect-text: 请输入要发送的文本。
+      platform-not-found: 找不到指定的平台。

package/locales/zh-TW.yml

@@ -0,0 +1,12 @@
+commands:
+  echo:
+    description: 發送消息
+    options:
+      escape: 發送轉義消息
+      unescape: 發送反轉義消息
+      user: 發送到使用者
+      channel: 發送到頻道
+      guild: 指定群組編號
+    messages:
+      expect-text: 請輸入要發送的文本。
+      platform-not-found: 找不到指定的平台。

package/package.json

@@ -0,0 +1,60 @@
+{
+    "name": "@koishi-ce/plugin-echo",
+    "description": "Echo plugin for Koishi",
+    "version": "1.0.0",
+    "type": "module",
+    "main": "lib/index.mjs",
+    "typings": "lib/index.d.ts",
+    "files": [
+        "lib",
+        "src",
+        "locales"
+    ],
+    "contributors": [
+        "Shigma <shigma10826@gmail.com>",
+        "Oppenheymu <oppenheymu@gmail.com>"
+    ],
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/Koishi-CE/koishi.git",
+        "directory": "plugins/common/echo"
+    },
+    "bugs": {
+        "url": "https://github.com/Koishi-CE/koishi/issues"
+    },
+    "homepage": "https://koishi.chat/plugins/common/echo.html",
+    "keywords": [
+        "bot",
+        "chatbot",
+        "koishi",
+        "plugin",
+        "echo"
+    ],
+    "koishi": {
+        "browser": true,
+        "category": "tool",
+        "description": {
+            "en": "Echo messages",
+            "zh": "发送指定消息"
+        },
+        "locales": [
+            "zh"
+        ]
+    },
+    "peerDependencies": {
+        "koishi": "^4.18.11"
+    },
+    "devDependencies": {
+        "@koishi-ce/plugin-mock": "^1.0.0",
+        "@koishi-ce/koishi": "^1.0.0"
+    },
+    "exports": {
+        ".": {
+            "source": "./src/index.ts",
+            "types": "./lib/index.d.ts",
+            "import": "./lib/index.mjs",
+            "default": "./lib/index.mjs"
+        }
+    }
+}

package/src/index.test.ts

@@ -0,0 +1,50 @@
+/**
+ * echo 插件测试：验证基础复述、CQ 码转义 / 反转义
+ * 与定向发送（-u 用户私聊 / -c 频道）的参数形状。
+ */
+import { beforeAll, describe, expect, it, jest } from "bun:test";
+import { App, type Bot, h } from "@koishi-ce/koishi";
+import * as echo from "@koishi-ce/plugin-echo";
+import mock from "@koishi-ce/plugin-mock";
+
+const app = new App();
+
+app.plugin(mock);
+app.plugin(echo);
+
+const client = app.mock.client("123");
+
+beforeAll(() => app.start());
+
+describe("@koishi-ce/plugin-echo", () => {
+	// 覆盖纯文本、转义输入、-E 反转义（拆分为多条消息），以及向用户 / 频道定向发送时的调用参数
+	it("basic support", async () => {
+		await client.shouldReply("echo", "请输入要发送的文本。");
+		await client.shouldReply("echo foo", "foo");
+		await client.shouldReply(h.escape("echo <>"), "<>");
+		await client.shouldReply(
+			h.escape("echo 1<message>2</message>3"),
+			"1<message>2</message>3",
+		);
+		await client.shouldReply(h.escape("echo -E &lt;&gt;"), "<>");
+		await client.shouldReply(h.escape("echo -E 1<message>2</message>3"), [
+			"1",
+			"2",
+			"3",
+		]);
+
+		const send1 = (app.bots[0]!.sendPrivateMessage =
+			jest.fn<Bot["sendPrivateMessage"]>());
+		await client.shouldNotReply("echo -u @100 foo");
+		expect(send1.mock.calls).toHaveLength(1);
+		// 形状断言：仅校验期望侧的数组索引（args[0] 平台目标、args[1] 消息体）
+		expect(send1.mock.calls[0]?.[0]).toBe("100");
+		expect(send1.mock.calls[0]?.[1]).toStrictEqual(["foo"]);
+
+		const send2 = (app.bots[0]!.sendMessage = jest.fn<Bot["sendMessage"]>());
+		await client.shouldNotReply("echo -c #200 foo");
+		expect(send1.mock.calls).toHaveLength(1);
+		expect(send2.mock.calls[0]?.[0]).toBe("200");
+		expect(send2.mock.calls[0]?.[1]).toStrictEqual(["foo"]);
+	});
+});

package/src/index.ts

@@ -0,0 +1,68 @@
+/**
+ * 消息复述插件（echo）。
+ *
+ * 提供 `echo <message>` 指令：原样返回输入文本。
+ * 权限 3 以上的选项：`-e` / `-E` 转义 / 反转义消息中的 CQ 码；
+ * `-u` / `-c`（可配合 `-g` 指定群组）把消息发送到指定用户私聊或指定频道。
+ */
+import { type Context, h, Schema } from "@koishi-ce/koishi";
+import zhCN from "../locales/zh-CN.yml";
+
+/**
+ * 解析 `platform:id` 形式的目标标识
+ * @param target 形如 `platform:id` 的字符串
+ * @returns [平台名, 目标 ID] 二元组
+ */
+export function parsePlatform(target: string): [platform: string, id: string] {
+	const index = target.indexOf(":");
+	const platform = target.slice(0, index);
+	const id = target.slice(index + 1);
+	return [platform, id];
+}
+
+/** 配置项（当前无可用配置） */
+export type Config = Record<never, never>;
+
+export const name = "echo";
+export const Config: Schema<Config> = Schema.object({});
+
+export function apply(ctx: Context, _config: Config) {
+	ctx.i18n.define("zh-CN", zhCN);
+
+	ctx
+		.command("echo <message:text>")
+		.option("escape", "-e", { authority: 3 })
+		.option("unescape", "-E", { authority: 3 })
+		.option("user", "-u [user:user]", { authority: 3 })
+		.option("channel", "-c [channel:channel]", { authority: 3 })
+		.option("guild", "-g [guild:string]", { authority: 3 })
+		.action(async ({ options, session }, message) => {
+			if (!session || !options) return;
+			if (!message) return session.text(".expect-text");
+
+			// 用数组包裹，避免返回内容在发送环节再被反转义
+			let content: h.Fragment = [message];
+			if (options.unescape) {
+				content = h.parse(message);
+			} else if (options.escape) {
+				content = [h.escape(message)];
+			}
+
+			// 指定了 -u / -c 时改为向目标发送，而不是回复当前会话
+			const target = options.user || options.channel;
+			if (target) {
+				const [platform, id] = parsePlatform(target as string);
+				const bot = ctx.bots.find((bot) => bot.platform === platform);
+				if (!bot) {
+					return session.text(".platform-not-found");
+				} else if (options.user) {
+					await bot.sendPrivateMessage(id, content, session.guildId);
+				} else {
+					await bot.sendMessage(id, content, options.guild);
+				}
+				return;
+			}
+
+			return content;
+		});
+}