feat(command): 命令注册支持分组功能 (#10)

* feat(command): 命令注册支持分组功能
czfadmin · Sep 29, 2024 · 2cdc5b2 · 2cdc5b2
1 parent dd3fe0b
commit 2cdc5b2
Show file tree

Hide file tree

Showing 15 changed files with 105 additions and 176 deletions.
diff --git a/.changeset/dull-crabs-attend.md b/.changeset/dull-crabs-attend.md
@@ -0,0 +1,5 @@
+---
+'vsc-extension-helper': patch
+---
+
+命令注册更改为延迟注册
diff --git a/.changeset/tasty-walls-protect.md b/.changeset/tasty-walls-protect.md
@@ -0,0 +1,5 @@
+---
+'vsc-extension-helper': patch
+---
+
+增加命令分组功能
diff --git a/.gitignore b/.gitignore
@@ -28,6 +28,6 @@ log/
 **/*/typings/auto-generated
 
 modern.config.local.*
-**/*/out/
+out/
 
 bookmark-manager.json
diff --git a/examples/hello-world/out/commands/index.js b/examples/hello-world/out/commands/index.js
diff --git a/examples/hello-world/out/commands/index.js.map b/examples/hello-world/out/commands/index.js.map
diff --git a/examples/hello-world/out/extension.js b/examples/hello-world/out/extension.js
diff --git a/examples/hello-world/out/extension.js.map b/examples/hello-world/out/extension.js.map
diff --git a/examples/hello-world/out/test/extension.test.js b/examples/hello-world/out/test/extension.test.js
diff --git a/examples/hello-world/out/test/extension.test.js.map b/examples/hello-world/out/test/extension.test.js.map
diff --git a/examples/hello-world/package.json b/examples/hello-world/package.json
@@ -32,6 +32,14 @@
       {
         "command": "hello-world.bar",
         "title": "Hello World"
+      },
+      {
+        "command": "hello-world.group1.helloworld",
+        "title": "Group1.HelloWorld"
+      },
+      {
+        "command": "hello-world.group2.helloworld2",
+        "title": "Group2.HelloWorld2"
       }
     ]
   },

diff --git a/examples/hello-world/src/extension.ts b/examples/hello-world/src/extension.ts
@@ -13,14 +13,32 @@ export const activate = withActivate({
   extensionId: 'hello-world',
 })(async function (ctx: vscode.ExtensionContext) {
   // 1.use hoc
-  // withCommand({ name: 'foo' })(function foo() {
-  //   vscode.window.showInformationMessage('foo command');
-  // });
-
-  // // 2. use hoc without options
-  // withCommand(function bar(...args: any[]) {
-  //   vscode.window.showInformationMessage('bar command');
-  // });
+  withCommand({ name: 'foo' })(function foo() {
+    vscode.window.showInformationMessage('foo command');
+  });
+
+  // 2. use hoc without options
+  withCommand(function bar(...args: any[]) {
+    vscode.window.showInformationMessage('bar command');
+  });
+
+  // 3. use group
+  withCommand({
+    name: 'helloworld',
+    group: ['group1'],
+  })(function helloworld(...args: any[]) {
+    vscode.window.showInformationMessage('group1: hello world');
+  });
+
+  function helloworld2(...args: any[]) {
+    vscode.window.showInformationMessage('group1: hello world2');
+  }
+  helloworld2.group = ['group2'];
+
+  // 4.
+  withCommand({
+    name: 'helloworld2',
+  })(helloworld2);
 });
 
 // 2.

diff --git a/src/decorators.ts b/src/decorators.ts
@@ -15,7 +15,8 @@ export function command(options?: Omit<CommandOptions, 'textEditor'>) {
     const cmdName =
       typeof propertyKey === 'symbol' ? propertyKey.toString() : propertyKey;
 
-    const name = options?.name || cmdName;
+    const name: string = options?.name || cmdName;
+
     const _options = {
       ...(options || {}),
       name,
@@ -38,10 +39,13 @@ export function textEditorCommand(options?: TextEditorCommandOptions) {
     propertyKey: string | symbol,
     descriptor: PropertyDescriptor,
   ) {
+
     const cmdName =
       typeof propertyKey === 'symbol' ? propertyKey.toString() : propertyKey;
-    const name = options?.name || cmdName;
-    const _options = { ...(options || {}), name, textEditor: true };
+
+    const name: string = options?.name || cmdName;
+
+    const _options = { ...(options || { group: [] }), name, textEditor: true };
 
     internalRegisterCommand(_options, target[propertyKey]);
   };

diff --git a/src/hoc.ts b/src/hoc.ts
@@ -6,28 +6,34 @@ import {
   registerContext,
   useExtensionContext,
 } from './context';
-import { WithActiveOptions, CommandOptions, VoidHandlerType } from './types';
+import { WithActiveOptions, CommandOptions, IVoidHandler } from './types';
 import { internalRegisterCommand } from './utils';
 
 function withCommandHelper(
-  optionsOrHandler: Omit<CommandOptions, 'textEditor'> | VoidHandlerType,
+  optionsOrHandler: Omit<CommandOptions, 'textEditor'> | IVoidHandler,
   isTextEditorCmd = false,
 ) {
   const funcPrefix = isTextEditorCmd ? 'TextEditor' : '';
   const noNameError = new Error(
     `The registered command name cannot be empty, please use \`function funcName(...args:any[]){}\` or \`with${funcPrefix}Command(options)(function funcName(...args:any[]){}\` to register Order`,
   );
+
   let cmdName = '';
   let internalHandler = optionsOrHandler;
   let internalOptions: CommandOptions = {};
+
   const paramIsHandler = typeof optionsOrHandler === 'function';
+
   if (paramIsHandler) {
     if (!optionsOrHandler.name) {
       throw noNameError;
     }
+
     internalHandler = optionsOrHandler;
     internalOptions = {
       name: optionsOrHandler.name,
+      group:
+        'group' in optionsOrHandler ? (optionsOrHandler.group as string[]) : [],
       textEditor: isTextEditorCmd,
     };
     // 此时直接注册,后面的返回只是为了欺骗ts的不进行报错
@@ -40,37 +46,49 @@ function withCommandHelper(
     );
   }
 
-  return function (handler: VoidHandlerType) {
+  return function (handler: IVoidHandler) {
     if (
       !paramIsHandler &&
       (!handler.name || (optionsOrHandler && !optionsOrHandler.name))
     ) {
       throw noNameError;
     }
-    cmdName = paramIsHandler ? cmdName : handler.name;
+
+    if (paramIsHandler) {
+      return;
+    }
+
+    internalOptions.name =
+      internalOptions.name || paramIsHandler ? cmdName : handler.name;
+
     internalHandler = paramIsHandler ? internalHandler : handler;
-    if (!paramIsHandler) {
-      internalOptions = {
-        ...internalOptions,
-        ...optionsOrHandler,
-        textEditor: isTextEditorCmd,
-      };
+
+    if (!internalOptions.group) {
+      internalOptions.group =
+        (typeof handler.group === 'string' ? [handler.group] : handler.group) ||
+        [];
     }
 
+    internalOptions = {
+      ...internalOptions,
+      ...optionsOrHandler,
+      textEditor: isTextEditorCmd,
+    };
+
     internalRegisterCommand(
       internalOptions,
-      internalHandler as VoidHandlerType,
+      internalHandler as IVoidHandler,
     );
   };
 }
 /**
- * @zh 通过高阶函数创建一个命令
+ * @zh 通过高阶函数创建一个命令, 当第一个参数传递函数时, 将无法使用分组功能
  * @en Create a command through a higher-order function
  * @param optionsOrHandler
  * @returns
  */
 export function withCommand(
-  optionsOrHandler: CommandOptions | VoidHandlerType,
+  optionsOrHandler: CommandOptions | IVoidHandler,
 ) {
   return withCommandHelper(optionsOrHandler, false);
 }
@@ -82,7 +100,7 @@ export function withCommand(
  * @returns
  */
 export function withTextEditorCommand(
-  optionsOrHandler: CommandOptions | VoidHandlerType,
+  optionsOrHandler: CommandOptions | IVoidHandler,
 ) {
   return withCommandHelper(optionsOrHandler, true);
 }
@@ -124,7 +142,7 @@ export function withActivate(
           context: ctx,
         });
         await handler(ctx);
-        registerCommands()
+        registerCommands();
       };
     }
 
@@ -134,7 +152,7 @@ export function withActivate(
         context: ctx,
       });
       handler(ctx);
-      registerCommands()
+      registerCommands();
     };
   };
 }
@@ -145,7 +163,7 @@ export function withActivate(
  * @param handler 自定义的取消激活函数
  * @returns
  */
-export function withDeactivate(handler?: VoidHandlerType) {
+export function withDeactivate(handler?: IVoidHandler) {
   return function (ctx: ExtensionContext) {
     clearGlobalContext();
     handler?.();