koishi-plugin-command-help 0.0.1

package/lib/index.d.ts

@@ -0,0 +1,18 @@
+import { Context, Schema } from 'koishi';
+export declare const name = "command-help";
+export interface MenuItem {
+    command: string;
+    label?: string;
+}
+export interface MenuConfig {
+    cmdName: string;
+    description: string;
+    title: string;
+    subtitle: string;
+    items: MenuItem[];
+}
+export interface Config {
+    menus: MenuConfig[];
+}
+export declare const Config: Schema<Config>;
+export declare function apply(ctx: Context, config: Config): void;

package/lib/index.js

@@ -0,0 +1,78 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var __export = (target, all) => {
+  for (var name2 in all)
+    __defProp(target, name2, { get: all[name2], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  Config: () => Config,
+  apply: () => apply,
+  name: () => name
+});
+module.exports = __toCommonJS(src_exports);
+var import_koishi = require("koishi");
+var name = "command-help";
+var Config = import_koishi.Schema.object({
+  menus: import_koishi.Schema.array(import_koishi.Schema.object({
+    cmdName: import_koishi.Schema.string().description("触发菜单的指令名").required(),
+    description: import_koishi.Schema.string().description("该菜单指令本身的简短说明").default("显示功能菜单"),
+    title: import_koishi.Schema.string().description("菜单标题（如：指令：analyse）").required(),
+    subtitle: import_koishi.Schema.string().description("菜单副标题（如：数据分析）"),
+    items: import_koishi.Schema.array(import_koishi.Schema.object({
+      command: import_koishi.Schema.string().description("链接到的指令名").required(),
+      label: import_koishi.Schema.string().description("自定义说明（留空则自动获取指令原说明）")
+    })).role("table").description("菜单包含的内容列表")
+  })).description("自定义菜单列表")
+});
+function apply(ctx, config) {
+  for (const menu of config.menus) {
+    ctx.command(menu.cmdName, menu.description).action(async ({ session }) => {
+      let output = `指令：${menu.title}
+`;
+      if (menu.subtitle) output += `${menu.subtitle}
+`;
+      if (menu.items && menu.items.length > 0) {
+        output += `可用的子指令有：
+`;
+        for (const item of menu.items) {
+          const targetCmd = ctx.command(item.command);
+          let desc = item.label;
+          if (!desc && targetCmd) {
+            const i18nKey = `commands.${targetCmd.name}.description`;
+            const text = session.text(i18nKey);
+            if (text && text !== i18nKey) {
+              desc = text;
+            } else {
+              desc = targetCmd._description || "";
+            }
+          }
+          output += `    /${item.command}  ${desc || "暂无说明"}
+`;
+        }
+      }
+      return output.trim();
+    });
+  }
+}
+__name(apply, "apply");
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Config,
+  apply,
+  name
+});

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "koishi-plugin-command-help",
+  "description": "Koishi 插件，为指令自定义仿help的聚合菜单",
+  "version": "0.0.1",
+  "main": "lib/index.js",
+  "typings": "lib/index.d.ts",
+  "files": [
+    "lib",
+    "dist"
+  ],
+  "license": "MIT",
+  "keywords": [
+    "chatbot",
+    "koishi",
+    "plugin",
+    "command",
+    "help"
+  ],
+  "peerDependencies": {
+    "koishi": "^4.18.7"
+  }
+}

package/readme.md

@@ -0,0 +1,5 @@
+# koishi-plugin-command-help
+
+[![npm](https://img.shields.io/npm/v/koishi-plugin-command-help?style=flat-square)](https://www.npmjs.com/package/koishi-plugin-command-help)
+
+Koishi 插件，为指令自定义仿help的聚合菜单