@koishi-ce/plugin-echo 1.0.0 → 1.1.0

package/README.md

@@ -0,0 +1,81 @@
+# @koishi-ce/plugin-echo
+
+**简体中文** | [English](#english)
+
+消息复述插件，移植自上游 [koishijs/koishi](https://github.com/koishijs/koishi) 的 `plugins/common/echo`。原样返回输入的文本，常用于测试机器人的消息收发链路。
+
+## 指令
+
+| 指令 | 权限 | 说明 |
+| --- | --- | --- |
+| `echo <message:text>` | 1 | 原样复述输入的文本 |
+
+- 以下选项均要求权限 3：`-e, --escape` 发送转义消息、`-E, --unescape` 发送反转义消息、`-u, --user [user:user]` 发送到用户、`-c, --channel [channel:channel]` 发送到频道、`-g, --guild [guild:string]` 指定群组编号。
+- `-u` / `-c` 的目标按 `platform:id` 形式解析，并改由目标平台的 bot 发送；找不到对应平台时提示「找不到指定的平台。」。
+
+## 配置项
+
+本插件无需配置。
+
+## 用法
+
+```bash
+bun add @koishi-ce/plugin-echo
+```
+
+也可以在控制台的插件市场中直接安装。随后在配置文件中启用：
+
+```yaml
+plugins:
+  echo: {}
+```
+
+## 备注
+
+- 无配置、无服务依赖，开箱即用。
+- 导出工具函数 `parsePlatform`，用于解析 `platform:id` 形式的目标标识。
+
+## 许可证
+
+[MIT](https://github.com/Koishi-CE/koishi/blob/main/LICENSE)。本包是上游 [koishijs/koishi](https://github.com/koishijs/koishi) 的社区再分发，版权归属见 [NOTICE](https://github.com/Koishi-CE/koishi/blob/main/NOTICE)。
+
+---
+
+## English
+
+A message echo plugin, ported from `plugins/common/echo` of the upstream [koishijs/koishi](https://github.com/koishijs/koishi) repository. It repeats the input text verbatim, which is handy for testing the bot's message pipeline.
+
+## Commands
+
+| Command | Authority | Description |
+| --- | --- | --- |
+| `echo <message:text>` | 1 | Repeat the input text verbatim |
+
+- The following options all require authority 3: `-e, --escape` send the message escaped, `-E, --unescape` send the message unescaped, `-u, --user [user:user]` send to a user, `-c, --channel [channel:channel]` send to a channel, `-g, --guild [guild:string]` specify the guild ID.
+- Targets of `-u` / `-c` are resolved as `platform:id` and the message is sent by the bot of that platform; a missing platform reports an error.
+
+## Configuration
+
+None.
+
+## Usage
+
+```bash
+bun add @koishi-ce/plugin-echo
+```
+
+The plugin can also be installed from the console plugin market, then enabled in the config file:
+
+```yaml
+plugins:
+  echo: {}
+```
+
+## Notes
+
+- No configuration and no service dependencies.
+- Exports the utility function `parsePlatform` for parsing `platform:id` targets.
+
+## License
+
+[MIT](https://github.com/Koishi-CE/koishi/blob/main/LICENSE). This package is a community redistribution of upstream koishijs/koishi; see [NOTICE](https://github.com/Koishi-CE/koishi/blob/main/NOTICE) for attribution.

package/lib/assets/{zh-CN-CrW2M7HM.yml → zh-CN-CKCgP5gq.yml}

@@ -1,3 +1,6 @@
+# SPDX-License-Identifier: MIT
+# Copyright (c) 2019-present Shigma and Koishijs contributors.
+
 commands:
   echo:
     description: 发送消息

package/lib/index.d.ts

@@ -5,11 +5,10 @@ import { Context, Schema } from "@koishi-ce/koishi";
  * @param target 形如 `platform:id` 的字符串
  * @returns [平台名, 目标 ID] 二元组
  */
-declare function parsePlatform(target: string): [platform: string, id: string];
+export 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 };
+export type Config = Record<never, never>;
+export declare const name = "echo";
+export declare const Config: Schema<Config>;
+export declare function apply(ctx: Context, _config: Config): void;
+//#endregion

package/lib/index.mjs

@@ -1,5 +1,5 @@
 import { Schema, h } from "@koishi-ce/koishi";
-import zhCN from "./assets/zh-CN-CrW2M7HM.yml";
+import zhCN from "./assets/zh-CN-CKCgP5gq.yml";
 //#region src/index.ts
 /**
 * 消息复述插件（echo）。

package/locales/de-DE.yml

@@ -1,12 +1,15 @@
+# SPDX-License-Identifier: MIT
+# Copyright (c) 2019-present Shigma and Koishijs contributors.
+
 commands:
   echo:
-    description: 发送消息
+    description: Nachrichten senden
     options:
-      escape: 发送转义消息
-      unescape: 发送反转义消息
-      user: 发送到用户
-      channel: 发送到频道
-      guild: 指定群组编号
+      escape: Escapte Nachricht senden
+      unescape: Unescapte Nachricht senden
+      user: An Benutzer senden
+      channel: An Kanal senden
+      guild: Gruppen-ID angeben
     messages:
-      expect-text: 请输入要发送的文本。
-      platform-not-found: 找不到指定的平台。
+      expect-text: Bitte geben Sie den zu sendenden Text ein.
+      platform-not-found: Die angegebene Plattform wurde nicht gefunden.

package/locales/en-US.yml

@@ -1,3 +1,6 @@
+# SPDX-License-Identifier: MIT
+# Copyright (c) 2019-present Shigma and Koishijs contributors.
+
 commands:
   echo:
     description: Send messages

package/locales/fr-FR.yml

@@ -1,12 +1,15 @@
+# SPDX-License-Identifier: MIT
+# Copyright (c) 2019-present Shigma and Koishijs contributors.
+
 commands:
   echo:
-    description: 发送消息
+    description: Envoyer des messages
     options:
-      escape: 发送转义消息
-      unescape: 发送反转义消息
-      user: 发送到用户
-      channel: 发送到频道
-      guild: 指定群组编号
+      escape: Envoyer un message échappé
+      unescape: Envoyer un message déséchappé
+      user: Envoyer à l'utilisateur
+      channel: Envoyer au canal
+      guild: Indiquer l'identifiant du groupe
     messages:
-      expect-text: 请输入要发送的文本。
-      platform-not-found: 找不到指定的平台。
+      expect-text: Veuillez saisir le texte à envoyer.
+      platform-not-found: La plateforme spécifiée est introuvable.

package/locales/ja-JP.yml

@@ -1,12 +1,15 @@
+# SPDX-License-Identifier: MIT
+# Copyright (c) 2019-present Shigma and Koishijs contributors.
+
 commands:
   echo:
-    description: 发送消息
+    description: メッセージを送信する
     options:
-      escape: 发送转义消息
-      unescape: 发送反转义消息
-      user: 发送到用户
-      channel: 发送到频道
-      guild: 指定群组编号
+      escape: エスケープされたメッセージを送信する
+      unescape: アンエスケープされたメッセージを送信する
+      user: ユーザーに送信する
+      channel: チャンネルに送信する
+      guild: グループ番号を指定する
     messages:
-      expect-text: 请输入要发送的文本。
-      platform-not-found: 找不到指定的平台。
+      expect-text: 送信するテキストを入力してください。
+      platform-not-found: 指定されたプラットフォームが見つかりません。

package/locales/ru-RU.yml

@@ -1,12 +1,15 @@
+# SPDX-License-Identifier: MIT
+# Copyright (c) 2019-present Shigma and Koishijs contributors.
+
 commands:
   echo:
-    description: 发送消息
+    description: Отправить сообщения
     options:
-      escape: 发送转义消息
-      unescape: 发送反转义消息
-      user: 发送到用户
-      channel: 发送到频道
-      guild: 指定群组编号
+      escape: Отправить экранированное сообщение
+      unescape: Отправить разэкранированное сообщение
+      user: Отправить пользователю
+      channel: Отправить в канал
+      guild: Указать идентификатор группы
     messages:
-      expect-text: 请输入要发送的文本。
-      platform-not-found: 找不到指定的平台。
+      expect-text: Пожалуйста, введите текст для отправки.
+      platform-not-found: Указанная платформа не найдена.

package/locales/zh-CN.yml

@@ -1,3 +1,6 @@
+# SPDX-License-Identifier: MIT
+# Copyright (c) 2019-present Shigma and Koishijs contributors.
+
 commands:
   echo:
     description: 发送消息

package/locales/zh-TW.yml

@@ -1,3 +1,6 @@
+# SPDX-License-Identifier: MIT
+# Copyright (c) 2019-present Shigma and Koishijs contributors.
+
 commands:
   echo:
     description: 發送消息

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@koishi-ce/plugin-echo",
     "description": "Echo plugin for Koishi",
-    "version": "1.0.0",
+    "version": "1.1.0",
     "type": "module",
     "main": "lib/index.mjs",
     "typings": "lib/index.d.ts",
@@ -43,11 +43,11 @@
         ]
     },
     "peerDependencies": {
-        "koishi": "^4.18.11"
+        "@koishi-ce/koishi": "^1.0.0"
     },
     "devDependencies": {
         "@koishi-ce/plugin-mock": "^1.0.0",
-        "@koishi-ce/koishi": "^1.0.0"
+        "@koishi-ce/koishi": "^1.0.8"
     },
     "exports": {
         ".": {

package/src/index.test.ts

@@ -1,8 +1,17 @@
+// SPDX-License-Identifier: MIT
+// Copyright (c) 2026-present Koishi-CE contributors.
+
 /**
  * echo 插件测试：验证基础复述、CQ 码转义 / 反转义
  * 与定向发送（-u 用户私聊 / -c 频道）的参数形状。
  */
-import { beforeAll, describe, expect, it, jest } from "bun:test";
+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";
@@ -19,19 +28,27 @@ beforeAll(() => app.start());
 describe("@koishi-ce/plugin-echo", () => {
 	// 覆盖纯文本、转义输入、-E 反转义（拆分为多条消息），以及向用户 / 频道定向发送时的调用参数
 	it("basic support", async () => {
-		await client.shouldReply("echo", "请输入要发送的文本。");
+		await client.shouldReply(
+			"echo",
+			"请输入要发送的文本。",
+		);
 		await client.shouldReply("echo foo", "foo");
-		await client.shouldReply(h.escape("echo <>"), "<>");
+		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",
-		]);
+		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"]>());
@@ -41,10 +58,29 @@ describe("@koishi-ce/plugin-echo", () => {
 		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"]>());
+		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"]);
 	});
+
+	// -e 转义：消息中的标签原样输出为转义文本
+	it("escape option", async () => {
+		// 存量用例曾以 jest.fn 覆盖实例属性，删除后回落到原型上的真实实现
+		delete (app.bots[0] as Partial<Bot>).sendMessage;
+		await client.shouldReply(
+			"echo -e <foo>",
+			"&lt;foo/&gt;",
+		);
+	});
+
+	// -u 指向不存在的平台时提示找不到平台
+	it("platform not found", async () => {
+		await client.shouldReply(
+			"echo -u @nosuch:100 foo",
+			"找不到指定的平台。",
+		);
+	});
 });

package/src/index.ts

@@ -1,3 +1,7 @@
+// SPDX-License-Identifier: MIT
+// Copyright (c) 2019-present Shigma and Koishijs contributors.
+// Copyright (c) 2026-present Koishi-CE contributors.
+
 /**
  * 消息复述插件（echo）。
  *
@@ -13,7 +17,9 @@ import zhCN from "../locales/zh-CN.yml";
  * @param target 形如 `platform:id` 的字符串
  * @returns [平台名, 目标 ID] 二元组
  */
-export function parsePlatform(target: string): [platform: string, id: string] {
+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);
@@ -34,7 +40,9 @@ export function apply(ctx: Context, _config: Config) {
 		.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("channel", "-c [channel:channel]", {
+			authority: 3,
+		})
 		.option("guild", "-g [guild:string]", { authority: 3 })
 		.action(async ({ options, session }, message) => {
 			if (!session || !options) return;
@@ -51,12 +59,20 @@ export function apply(ctx: Context, _config: Config) {
 			// 指定了 -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);
+				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);
+					await bot.sendPrivateMessage(
+						id,
+						content,
+						session.guildId,
+					);
 				} else {
 					await bot.sendMessage(id, content, options.guild);
 				}