@zhin.js/command 1.0.12 → 1.0.14

package/README.md

@@ -11,7 +11,7 @@ Zhin Plugin Runtime 的约定式 Command Feature。它发现 `commands/**/*.ts(x
 ```ts
 // commands/gh/issue/list.ts -> gh issue list
 // commands/赞我.ts -> 赞我
-import { defineCommand } from '@zhin.js/command';
+import { defineCommand } from 'zhin.js/command';
 
 export default defineCommand({
   description: 'List GitHub issues',

package/lib/command-index.d.ts

@@ -31,7 +31,7 @@ export declare class CommandIndex {
     list(): readonly CommandDescriptor[];
     has(name: string): boolean;
     execute(name: string, args?: readonly string[]): Promise<unknown>;
-    dispatch(input: CommandMatchInput, source?: unknown, promptFactory?: CommandPromptFactory): Promise<CommandDispatchResult>;
+    dispatch(input: CommandMatchInput, source?: unknown, promptFactory?: CommandPromptFactory, commandPrefix?: string): Promise<CommandDispatchResult>;
 }
 export declare function isCommandIndex(value: unknown): value is CommandIndex;
 export declare class CommandParameterValueError extends TypeError {

package/lib/command-index.js

@@ -119,9 +119,9 @@ export class CommandIndex {
         // Host / 无 session：跳过 permit；无 source 时函数默认值得到空 session。
         return match.command.slot.definition.execute(createCommandContext(this.snapshot, match.command.slot.owner, args, resolveDynamicParams(match.params, undefined)));
     }
-    async dispatch(input, source = undefined, promptFactory) {
+    async dispatch(input, source = undefined, promptFactory, commandPrefix = '') {
         if (this.#menu) {
-            const menuValue = this.#dispatchMenu(input);
+            const menuValue = this.#dispatchMenu(input, commandPrefix);
             if (menuValue !== undefined) {
                 return Object.freeze({
                     matched: true,
@@ -249,22 +249,22 @@ export class CommandIndex {
     // ==========================================================================
     // 内置菜单命令
     // ==========================================================================
-    #dispatchMenu(input) {
+    #dispatchMenu(input, commandPrefix = '') {
         const text = typeof input === 'string' ? input.trim() : exactMessageText(input);
         if (text === undefined)
             return undefined;
         const keyword = this.#menu.keyword;
         if (text === keyword)
-            return this.#buildMenu();
+            return this.#buildMenu(undefined, commandPrefix);
         if (text.startsWith(keyword + ' ')) {
             const key = text.slice(keyword.length + 1).trim();
             if (key)
-                return this.#buildMenu(key);
-            return this.#buildMenu();
+                return this.#buildMenu(key, commandPrefix);
+            return this.#buildMenu(undefined, commandPrefix);
         }
         return undefined;
     }
-    #buildMenu(pluginKey) {
+    #buildMenu(pluginKey, commandPrefix = '') {
         const root = this.snapshot.root;
         const targetId = pluginKey
             ? `${root}/${pluginKey.split('.').join('/')}`
@@ -283,7 +283,7 @@ export class CommandIndex {
             lines.push('');
             for (const cmd of directCommands) {
                 const desc = cmd.description ? `  - ${cmd.description}` : '';
-                lines.push(`  ${cmd.name}${desc}`);
+                lines.push(`  ${commandPrefix}${cmd.name}${desc}`);
             }
         }
         if (children.length > 0) {
@@ -301,7 +301,7 @@ export class CommandIndex {
         }
         if (children.length > 0) {
             lines.push('');
-            lines.push(`提示：使用「${keyword} <插件名>」查看子插件的指令`);
+            lines.push(`提示：使用「${commandPrefix}${keyword} <插件名>」查看子插件的指令`);
         }
         return lines.join('\n');
     }

package/lib/definition.d.ts

@@ -146,6 +146,8 @@ export interface CommandSession {
 export interface CommandPromptOptions {
     readonly timeout?: number;
     readonly timeoutText?: string;
+    /** Cancel the pending claim when the owning turn aborts. */
+    readonly signal?: AbortSignal;
 }
 export interface CommandPromptListOptions extends CommandPromptOptions {
     readonly type?: 'text' | 'number' | 'boolean';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zhin.js/command",
-  "version": "1.0.12",
+  "version": "1.0.14",
   "description": "Convention-based Command Feature for Zhin Plugin Runtime",
   "type": "module",
   "main": "./lib/index.js",
@@ -18,9 +18,9 @@
   ],
   "dependencies": {
     "segment-matcher": "^1.0.5",
+    "@zhin.js/feature-kit": "1.0.11",
     "@zhin.js/permission": "1.0.2",
-    "@zhin.js/plugin-runtime": "1.1.6",
-    "@zhin.js/feature-kit": "1.0.9"
+    "@zhin.js/plugin-runtime": "1.1.6"
   },
   "devDependencies": {
     "@types/node": "^26.1.2",

package/src/command-index.ts

@@ -222,9 +222,10 @@ export class CommandIndex {
     input: CommandMatchInput,
     source: unknown = undefined,
     promptFactory?: CommandPromptFactory,
+    commandPrefix = '',
   ): Promise<CommandDispatchResult> {
     if (this.#menu) {
-      const menuValue = this.#dispatchMenu(input);
+      const menuValue = this.#dispatchMenu(input, commandPrefix);
       if (menuValue !== undefined) {
         return Object.freeze({
           matched: true,
@@ -369,20 +370,20 @@ export class CommandIndex {
   // 内置菜单命令
   // ==========================================================================
 
-  #dispatchMenu(input: CommandMatchInput): string | undefined {
+  #dispatchMenu(input: CommandMatchInput, commandPrefix = ''): string | undefined {
     const text = typeof input === 'string' ? input.trim() : exactMessageText(input);
     if (text === undefined) return undefined;
     const keyword = this.#menu!.keyword;
-    if (text === keyword) return this.#buildMenu();
+    if (text === keyword) return this.#buildMenu(undefined, commandPrefix);
     if (text.startsWith(keyword + ' ')) {
       const key = text.slice(keyword.length + 1).trim();
-      if (key) return this.#buildMenu(key);
-      return this.#buildMenu();
+      if (key) return this.#buildMenu(key, commandPrefix);
+      return this.#buildMenu(undefined, commandPrefix);
     }
     return undefined;
   }
 
-  #buildMenu(pluginKey?: string): string {
+  #buildMenu(pluginKey?: string, commandPrefix = ''): string {
     const root = this.snapshot.root;
     const targetId = pluginKey
       ? `${root}/${pluginKey.split('.').join('/')}` as PluginId
@@ -404,7 +405,7 @@ export class CommandIndex {
       lines.push('');
       for (const cmd of directCommands) {
         const desc = cmd.description ? `  - ${cmd.description}` : '';
-        lines.push(`  ${cmd.name}${desc}`);
+        lines.push(`  ${commandPrefix}${cmd.name}${desc}`);
       }
     }
 
@@ -425,7 +426,7 @@ export class CommandIndex {
 
     if (children.length > 0) {
       lines.push('');
-      lines.push(`提示：使用「${keyword} <插件名>」查看子插件的指令`);
+      lines.push(`提示：使用「${commandPrefix}${keyword} <插件名>」查看子插件的指令`);
     }
 
     return lines.join('\n');

package/src/definition.ts

@@ -196,6 +196,8 @@ export interface CommandSession {
 export interface CommandPromptOptions {
   readonly timeout?: number;
   readonly timeoutText?: string;
+  /** Cancel the pending claim when the owning turn aborts. */
+  readonly signal?: AbortSignal;
 }
 
 export interface CommandPromptListOptions extends CommandPromptOptions {