@koishi-ce/plugin-inspect 1.0.0

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

@@ -0,0 +1,18 @@
+commands:
+  inspect:
+    description: 查看用户、频道或消息的详细信息
+    usage: |-
+      inspect @user
+      inspect #channel
+      inspect
+    messages:
+      invalid: 参数无法解析。
+      user: 用户 ID：{id}
+      channel: 频道 ID：{id}
+      message: |-
+        平台名：{platform}
+        消息 ID：{messageId}
+        频道 ID：{channelId}
+        群组 ID：{guildId}
+        用户 ID：{userId}
+        自身 ID：{selfId}

package/lib/index.d.ts

@@ -0,0 +1,9 @@
+import { Context, Schema } from "@koishi-ce/koishi";
+//#region src/index.d.ts
+declare const name = "inspect";
+/** 配置项（当前无可用配置） */
+type Config = Record<never, never>;
+declare const Config: Schema<Config>;
+declare function apply(ctx: Context): void;
+//#endregion
+export { Config, apply, name };

package/lib/index.mjs

@@ -0,0 +1,37 @@
+import { Schema, h } from "@koishi-ce/koishi";
+import zhCN from "./assets/zh-CN-Dm2KmiOI.yml";
+//#region src/index.ts
+/**
+* 消息检查插件（inspect）。
+*
+* 提供 `inspect` 指令：查看当前会话或引用消息的平台、消息 ID、
+* 频道 / 群组 / 用户 / 自身 ID 等元信息；
+* 也可以直接检查消息中携带的 `<at>`（用户）或 `<sharp>`（频道）元素。
+*/
+const name = "inspect";
+const Config = Schema.object({});
+function apply(ctx) {
+	ctx.i18n.define("zh-CN", zhCN);
+	ctx.command("inspect", { captureQuote: false }).action(({ session }, target) => {
+		if (!session) return;
+		if (session.quote) return session.text(".message", {
+			platform: session.platform,
+			messageId: session.quote.id,
+			guildId: session.guildId,
+			selfId: session.selfId,
+			userId: session.quote.user?.id,
+			channelId: session.quote.channel?.id
+		});
+		if (target) {
+			const element = h.parse(target)[0];
+			if (!element) return session.text(".invalid");
+			const { type, attrs } = element;
+			if (type === "at") return session.text(".user", attrs);
+			else if (type === "sharp") return session.text(".channel", attrs);
+			else return session.text(".invalid");
+		}
+		return session.text(".message", session);
+	});
+}
+//#endregion
+export { Config, apply, name };

package/locales/de-DE.yml

@@ -0,0 +1,18 @@
+commands:
+  inspect:
+    description: 查看用户、频道或消息的详细信息
+    usage: |-
+      inspect @user
+      inspect #channel
+      inspect
+    messages:
+      invalid: 参数无法解析。
+      user: 用户 ID：{id}
+      channel: 频道 ID：{id}
+      message: |-
+        平台名：{platform}
+        消息 ID：{messageId}
+        频道 ID：{channelId}
+        群组 ID：{guildId}
+        用户 ID：{userId}
+        自身 ID：{selfId}

package/locales/en-US.yml

@@ -0,0 +1,18 @@
+commands:
+  inspect:
+    description: View details of users, channels or messages
+    usage: |-
+      inspect @user
+      inspect #channel
+      inspect
+    messages:
+      invalid: Could not parse arguments.
+      user: 'User ID: {id}'
+      channel: 'Channel ID: {id}'
+      message: |-
+        Platform name: {platform}
+        Message ID: {messageId}
+        Channel ID: {channelId}
+        Guild ID: {guildId}
+        User ID: {userId}
+        Self ID: {selfId}

package/locales/fr-FR.yml

@@ -0,0 +1,18 @@
+commands:
+  inspect:
+    description: 查看用户、频道或消息的详细信息
+    usage: |-
+      inspect @user
+      inspect #channel
+      inspect
+    messages:
+      invalid: 参数无法解析。
+      user: 用户 ID：{id}
+      channel: 频道 ID：{id}
+      message: |-
+        平台名：{platform}
+        消息 ID：{messageId}
+        频道 ID：{channelId}
+        群组 ID：{guildId}
+        用户 ID：{userId}
+        自身 ID：{selfId}

package/locales/ja-JP.yml

@@ -0,0 +1,18 @@
+commands:
+  inspect:
+    description: 查看用户、频道或消息的详细信息
+    usage: |-
+      inspect @user
+      inspect #channel
+      inspect
+    messages:
+      invalid: 参数无法解析。
+      user: 用户 ID：{id}
+      channel: 频道 ID：{id}
+      message: |-
+        平台名：{platform}
+        消息 ID：{messageId}
+        频道 ID：{channelId}
+        群组 ID：{guildId}
+        用户 ID：{userId}
+        自身 ID：{selfId}

package/locales/ru-RU.yml

@@ -0,0 +1,18 @@
+commands:
+  inspect:
+    description: 查看用户、频道或消息的详细信息
+    usage: |-
+      inspect @user
+      inspect #channel
+      inspect
+    messages:
+      invalid: 参数无法解析。
+      user: 'Идентификатор Пользователя: {id}'
+      channel: Идентификатор Канала:{id}
+      message: |-
+        平台名：{platform}
+        消息 ID：{messageId}
+        频道 ID：{channelId}
+        群组 ID：{guildId}
+        用户 ID：{userId}
+        自身 ID：{selfId}

package/locales/zh-CN.yml

@@ -0,0 +1,18 @@
+commands:
+  inspect:
+    description: 查看用户、频道或消息的详细信息
+    usage: |-
+      inspect @user
+      inspect #channel
+      inspect
+    messages:
+      invalid: 参数无法解析。
+      user: 用户 ID：{id}
+      channel: 频道 ID：{id}
+      message: |-
+        平台名：{platform}
+        消息 ID：{messageId}
+        频道 ID：{channelId}
+        群组 ID：{guildId}
+        用户 ID：{userId}
+        自身 ID：{selfId}

package/locales/zh-TW.yml

@@ -0,0 +1,18 @@
+commands:
+  inspect:
+    description: 查看使用者、頻道或消息的詳細信息
+    usage: |-
+      inspect @user
+      inspect #channel
+      inspect
+    messages:
+      invalid: 參數無法解析。
+      user: 使用者 ID：{id}
+      channel: 頻道 ID：{id}
+      message: |-
+        平台名：{platform}
+        消息 ID：{messageId}
+        頻道 ID：{channelId}
+        群組 ID：{guildId}
+        使用者 ID：{userId}
+        自身 ID：{selfId}

package/package.json

@@ -0,0 +1,66 @@
+{
+    "name": "@koishi-ce/plugin-inspect",
+    "description": "Inspect on any user, channel or message",
+    "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/inspect"
+    },
+    "bugs": {
+        "url": "https://github.com/Koishi-CE/koishi/issues"
+    },
+    "homepage": "https://koishi.chat/plugins/common/inspect.html",
+    "keywords": [
+        "bot",
+        "chatbot",
+        "koishi",
+        "plugin",
+        "inspect",
+        "debug",
+        "info",
+        "context",
+        "channel",
+        "user",
+        "message",
+        "session"
+    ],
+    "koishi": {
+        "browser": true,
+        "description": {
+            "en": "Inspect on any user, channel or message",
+            "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,55 @@
+/**
+ * inspect 插件测试：验证当前会话、at / sharp 元素参数、
+ * 非法参数与引用消息四类输入的元信息输出。
+ */
+import { afterAll, beforeAll, describe, it } from "bun:test";
+import { Context } from "@koishi-ce/koishi";
+import mock from "@koishi-ce/plugin-mock";
+import * as inspect from "./index.ts";
+
+const app = new Context();
+
+app.plugin(inspect);
+app.plugin(mock);
+
+const client = app.mock.client("123", "456");
+
+beforeAll(() => app.start());
+afterAll(() => app.stop());
+
+describe("@koishi-ce/plugin-inspect", () => {
+	// 裸 inspect 输出会话元信息；at / sharp 参数输出对应 ID；非法参数报错；引用消息输出被引用者信息
+	it("basic support", async () => {
+		await client.shouldReply(
+			"inspect",
+			new RegExp(
+				[
+					"平台名：mock",
+					"消息 ID：\\d+",
+					"频道 ID：456",
+					"群组 ID：456",
+					"用户 ID：123",
+					"自身 ID：514",
+				].join("\n"),
+			),
+		);
+
+		await client.shouldReply('inspect <at id="321"/>', "用户 ID：321");
+		await client.shouldReply('inspect <sharp id="654"/>', "频道 ID：654");
+		await client.shouldReply("inspect foobar", "参数无法解析。");
+
+		await client.shouldReply(
+			'<quote id="114514"/> inspect foobar',
+			new RegExp(
+				[
+					"平台名：mock",
+					"消息 ID：114514",
+					"频道 ID：.*",
+					"群组 ID：456",
+					"用户 ID：.*",
+					"自身 ID：514",
+				].join("\n"),
+			),
+		);
+	});
+});

package/src/index.ts

@@ -0,0 +1,53 @@
+/**
+ * 消息检查插件（inspect）。
+ *
+ * 提供 `inspect` 指令：查看当前会话或引用消息的平台、消息 ID、
+ * 频道 / 群组 / 用户 / 自身 ID 等元信息；
+ * 也可以直接检查消息中携带的 `<at>`（用户）或 `<sharp>`（频道）元素。
+ */
+import { type Context, h, Schema } from "@koishi-ce/koishi";
+import zhCN from "../locales/zh-CN.yml";
+
+export const name = "inspect";
+
+/** 配置项（当前无可用配置） */
+export type Config = Record<never, never>;
+
+export const Config: Schema<Config> = Schema.object({});
+
+export function apply(ctx: Context) {
+	ctx.i18n.define("zh-CN", zhCN);
+
+	ctx
+		.command("inspect", { captureQuote: false })
+		.action(({ session }, target) => {
+			if (!session) return;
+			// 优先展示引用消息的信息（captureQuote 已关闭，引用保留在会话对象上）
+			if (session.quote) {
+				return session.text(".message", {
+					platform: session.platform,
+					messageId: session.quote.id,
+					guildId: session.guildId,
+					selfId: session.selfId,
+					userId: session.quote.user?.id,
+					channelId: session.quote.channel?.id,
+				});
+			}
+
+			// 检查消息参数中携带的元素（@ 用户 / # 频道），其余元素视为无法解析
+			if (target) {
+				const element = h.parse(target)[0];
+				if (!element) return session.text(".invalid");
+				const { type, attrs } = element;
+				if (type === "at") {
+					return session.text(".user", attrs);
+				} else if (type === "sharp") {
+					return session.text(".channel", attrs);
+				} else {
+					return session.text(".invalid");
+				}
+			}
+
+			return session.text(".message", session);
+		});
+}