@clerc/core 0.20.0 → 0.21.0

package/dist/index.d.ts

@@ -78,7 +78,7 @@ type Flag = FlagOptions & {
 };
 declare interface CommandCustomProperties {
 }
-interface CommandOptions<P extends string[] = string[], A extends MaybeArray<string> = MaybeArray<string>, F extends Dict<FlagOptions> = Dict<FlagOptions>> extends CommandCustomProperties {
+interface CommandOptions<P extends string[] = string[], A extends MaybeArray<string | SingleCommandType> = MaybeArray<string | SingleCommandType>, F extends Dict<FlagOptions> = Dict<FlagOptions>> extends CommandCustomProperties {
     alias?: A;
     parameters?: P;
     flags?: F;
@@ -120,7 +120,9 @@ type Raw<C extends CommandRecord = CommandRecord, N extends keyof C = keyof C> =
 };
 interface HandlerContext<C extends CommandRecord = CommandRecord, N extends keyof C = keyof C> {
     name: N extends keyof C ? N : N | undefined;
+    called?: string | SingleCommandType;
     resolved: N extends keyof C ? true : boolean;
+    hasSingleCommandOrAlias: boolean;
     hasSingleCommand: boolean;
     raw: Raw<C, N>;
     parameters: TransformParameters<C, N>;
@@ -164,7 +166,7 @@ declare class Clerc<C extends CommandRecord = {}> {
      * const cli = Clerc.create()
      * ```
      */
-    static create(): Clerc<{}>;
+    static create(name?: string, description?: string, version?: string): Clerc<{}>;
     /**
      * Set the name of the cli
      * @param name
@@ -228,8 +230,8 @@ declare class Clerc<C extends CommandRecord = {}> {
      *   })
      * ```
      */
-    command<N extends string | SingleCommandType, O extends CommandOptions<[...P], A, F>, P extends string[] = string[], A extends MaybeArray<string> = MaybeArray<string>, F extends Dict<FlagOptions> = Dict<FlagOptions>>(c: CommandWithHandler<N, O & CommandOptions<[...P], A, F>>): this & Clerc<C & Record<N, Command<N, O>>>;
-    command<N extends string | SingleCommandType, O extends CommandOptions<[...P], A, F>, P extends string[] = string[], A extends MaybeArray<string> = MaybeArray<string>, F extends Dict<FlagOptions> = Dict<FlagOptions>>(name: N, description: string, options?: O & CommandOptions<[...P], A, F>): this & Clerc<C & Record<N, Command<N, O>>>;
+    command<N extends string | SingleCommandType, O extends CommandOptions<[...P], A, F>, P extends string[] = string[], A extends MaybeArray<string | SingleCommandType> = MaybeArray<string | SingleCommandType>, F extends Dict<FlagOptions> = Dict<FlagOptions>>(c: CommandWithHandler<N, O & CommandOptions<[...P], A, F>>): this & Clerc<C & Record<N, Command<N, O>>>;
+    command<N extends string | SingleCommandType, O extends CommandOptions<[...P], A, F>, P extends string[] = string[], A extends MaybeArray<string | SingleCommandType> = MaybeArray<string | SingleCommandType>, F extends Dict<FlagOptions> = Dict<FlagOptions>>(name: N, description: string, options?: O & CommandOptions<[...P], A, F>): this & Clerc<C & Record<N, Command<N, O>>>;
     /**
      * Register a handler
      * @param name
@@ -289,15 +291,19 @@ declare const defineInspector: <C extends Clerc<{}>>(_cli: C, inspector: Inspect
 declare const defineCommand: <N extends string | typeof SingleCommand, O extends CommandOptions<[...P], A, F>, P extends string[] = string[], A extends MaybeArray<string> = MaybeArray<string>, F extends Dict<FlagOptions> = Dict<FlagOptions>>(command: CommandWithHandler<N, O & CommandOptions<[...P], A, F>>) => CommandWithHandler<N, O & CommandOptions<[...P], A, F>>;
 
 declare class CommandExistsError extends Error {
+    name: string;
     constructor(name: string);
 }
 declare class NoSuchCommandError extends Error {
+    name: string;
     constructor(name: string);
 }
 declare class NoCommandGivenError extends Error {
     constructor();
 }
 declare class CommandNameConflictError extends Error {
+    n1: string;
+    n2: string;
     constructor(n1: string, n2: string);
 }
 declare class NameNotSetError extends Error {
@@ -310,13 +316,14 @@ declare class VersionNotSetError extends Error {
     constructor();
 }
 declare class InvalidCommandNameError extends Error {
+    name: string;
     constructor(name: string);
 }
 
-declare function resolveFlattenCommands(commands: CommandRecord): Map<string[] | typeof SingleCommand, CommandAlias<string, CommandOptions<string[], _clerc_utils.MaybeArray<string>, _clerc_utils.Dict<FlagOptions>>>>;
+declare function resolveFlattenCommands(commands: CommandRecord): Map<string[] | typeof SingleCommand, CommandAlias<string, CommandOptions<string[], _clerc_utils.MaybeArray<string | typeof SingleCommand>, _clerc_utils.Dict<FlagOptions>>>>;
 declare function resolveCommand(commands: CommandRecord, name: string | string[] | SingleCommandType): Command<string | SingleCommandType> | undefined;
-declare function resolveSubcommandsByParent(commands: CommandRecord, parent: string | string[], depth?: number): Command<string, CommandOptions<string[], _clerc_utils.MaybeArray<string>, _clerc_utils.Dict<FlagOptions>>>[];
-declare const resolveRootCommands: (commands: CommandRecord) => Command<string, CommandOptions<string[], _clerc_utils.MaybeArray<string>, _clerc_utils.Dict<FlagOptions>>>[];
+declare function resolveSubcommandsByParent(commands: CommandRecord, parent: string | string[], depth?: number): Command<string, CommandOptions<string[], _clerc_utils.MaybeArray<string | typeof SingleCommand>, _clerc_utils.Dict<FlagOptions>>>[];
+declare const resolveRootCommands: (commands: CommandRecord) => Command<string, CommandOptions<string[], _clerc_utils.MaybeArray<string | typeof SingleCommand>, _clerc_utils.Dict<FlagOptions>>>[];
 declare function resolveParametersBeforeFlag(argv: string[]): string[];
 declare const resolveArgv: () => string[];
 declare function compose(inspectors: Inspector[]): (getCtx: () => InspectorContext) => void;

package/dist/index.js

@@ -6,11 +6,13 @@ import { isNode, isDeno } from 'is-platform';
 class CommandExistsError extends Error {
   constructor(name) {
     super(`Command "${name}" exists.`);
+    this.name = name;
   }
 }
 class NoSuchCommandError extends Error {
   constructor(name) {
     super(`No such command: ${name}`);
+    this.name = name;
   }
 }
 class NoCommandGivenError extends Error {
@@ -21,6 +23,8 @@ class NoCommandGivenError extends Error {
 class CommandNameConflictError extends Error {
   constructor(n1, n2) {
     super(`Command name ${n1} conflicts with ${n2}. Maybe caused by alias.`);
+    this.n1 = n1;
+    this.n2 = n2;
   }
 }
 class NameNotSetError extends Error {
@@ -41,24 +45,29 @@ class VersionNotSetError extends Error {
 class InvalidCommandNameError extends Error {
   constructor(name) {
     super(`Bad name format: ${name}`);
+    this.name = name;
   }
 }
 
+function setCommand(commandsMap, commands, command) {
+  if (command.alias) {
+    const aliases = toArray(command.alias);
+    for (const alias of aliases) {
+      if (alias in commands) {
+        throw new CommandNameConflictError(commands[alias].name, command.name);
+      }
+      commandsMap.set(typeof alias === "symbol" ? alias : alias.split(" "), { ...command, __isAlias: true });
+    }
+  }
+}
 function resolveFlattenCommands(commands) {
   const commandsMap = /* @__PURE__ */ new Map();
   if (commands[SingleCommand]) {
     commandsMap.set(SingleCommand, commands[SingleCommand]);
+    setCommand(commandsMap, commands, commands[SingleCommand]);
   }
   for (const command of Object.values(commands)) {
-    if (command.alias) {
-      const aliases = toArray(command.alias);
-      for (const alias of aliases) {
-        if (alias in commands) {
-          throw new CommandNameConflictError(commands[alias].name, command.name);
-        }
-        commandsMap.set(alias.split(" "), { ...command, __isAlias: true });
-      }
-    }
+    setCommand(commandsMap, commands, command);
     commandsMap.set(command.name.split(" "), command);
   }
   return commandsMap;
@@ -202,10 +211,12 @@ var __privateSet = (obj, member, value, setter) => {
   setter ? setter.call(obj, value) : member.set(obj, value);
   return value;
 };
-var _name, _description, _version, _inspectors, _commands, _commandEmitter, _usedNames, _hasSingleCommand;
+var _name, _description, _version, _inspectors, _commands, _commandEmitter, _usedNames, _hasSingleCommandOrAlias, hasSingleCommandOrAlias_get, _hasSingleCommand, hasSingleCommand_get;
 const SingleCommand = Symbol("SingleCommand");
 const _Clerc = class {
-  constructor() {
+  constructor(name, description, version) {
+    __privateAdd(this, _hasSingleCommandOrAlias);
+    __privateAdd(this, _hasSingleCommand);
     __privateAdd(this, _name, "");
     __privateAdd(this, _description, "");
     __privateAdd(this, _version, "");
@@ -213,7 +224,9 @@ const _Clerc = class {
     __privateAdd(this, _commands, {});
     __privateAdd(this, _commandEmitter, new LiteEmit());
     __privateAdd(this, _usedNames, []);
-    __privateAdd(this, _hasSingleCommand, false);
+    __privateSet(this, _name, name || __privateGet(this, _name));
+    __privateSet(this, _description, description || __privateGet(this, _description));
+    __privateSet(this, _version, version || __privateGet(this, _version));
   }
   get _name() {
     return __privateGet(this, _name);
@@ -230,8 +243,8 @@ const _Clerc = class {
   get _commands() {
     return __privateGet(this, _commands);
   }
-  static create() {
-    return new _Clerc();
+  static create(name, description, version) {
+    return new _Clerc(name, description, version);
   }
   name(name) {
     __privateSet(this, _name, name);
@@ -263,9 +276,6 @@ const _Clerc = class {
         throw new CommandExistsError(name2);
       }
     }
-    if (nameList.includes(SingleCommand)) {
-      __privateSet(this, _hasSingleCommand, true);
-    }
     __privateGet(this, _commands)[name] = commandToSave;
     __privateGet(this, _usedNames).push(commandToSave.name, ...toArray(commandToSave.alias) || []);
     isCommandObject && handler && this.on(nameOrCommand.name, handler);
@@ -331,8 +341,10 @@ const _Clerc = class {
       const mergedFlags = { ...flags, ...unknownFlags };
       const context = {
         name: command == null ? void 0 : command.name,
+        called: name.length === 0 ? SingleCommand : stringName,
         resolved: isCommandResolved,
-        hasSingleCommand: __privateGet(this, _hasSingleCommand),
+        hasSingleCommandOrAlias: __privateGet(this, _hasSingleCommandOrAlias, hasSingleCommandOrAlias_get),
+        hasSingleCommand: __privateGet(this, _hasSingleCommand, hasSingleCommand_get),
         raw: { ...parsed, parameters, mergedFlags },
         parameters: mapping,
         flags,
@@ -374,7 +386,14 @@ _inspectors = new WeakMap();
 _commands = new WeakMap();
 _commandEmitter = new WeakMap();
 _usedNames = new WeakMap();
-_hasSingleCommand = new WeakMap();
+_hasSingleCommandOrAlias = new WeakSet();
+hasSingleCommandOrAlias_get = function() {
+  return __privateGet(this, _usedNames).includes(SingleCommand);
+};
+_hasSingleCommand = new WeakSet();
+hasSingleCommand_get = function() {
+  return !!__privateGet(this, _commands)[SingleCommand];
+};
 
 const definePlugin = (p) => p;
 const defineHandler = (_cli, _key, handler) => handler;

package/dist/index.mjs

@@ -6,11 +6,13 @@ import { isNode, isDeno } from 'is-platform';
 class CommandExistsError extends Error {
   constructor(name) {
     super(`Command "${name}" exists.`);
+    this.name = name;
   }
 }
 class NoSuchCommandError extends Error {
   constructor(name) {
     super(`No such command: ${name}`);
+    this.name = name;
   }
 }
 class NoCommandGivenError extends Error {
@@ -21,6 +23,8 @@ class NoCommandGivenError extends Error {
 class CommandNameConflictError extends Error {
   constructor(n1, n2) {
     super(`Command name ${n1} conflicts with ${n2}. Maybe caused by alias.`);
+    this.n1 = n1;
+    this.n2 = n2;
   }
 }
 class NameNotSetError extends Error {
@@ -41,24 +45,29 @@ class VersionNotSetError extends Error {
 class InvalidCommandNameError extends Error {
   constructor(name) {
     super(`Bad name format: ${name}`);
+    this.name = name;
   }
 }
 
+function setCommand(commandsMap, commands, command) {
+  if (command.alias) {
+    const aliases = toArray(command.alias);
+    for (const alias of aliases) {
+      if (alias in commands) {
+        throw new CommandNameConflictError(commands[alias].name, command.name);
+      }
+      commandsMap.set(typeof alias === "symbol" ? alias : alias.split(" "), { ...command, __isAlias: true });
+    }
+  }
+}
 function resolveFlattenCommands(commands) {
   const commandsMap = /* @__PURE__ */ new Map();
   if (commands[SingleCommand]) {
     commandsMap.set(SingleCommand, commands[SingleCommand]);
+    setCommand(commandsMap, commands, commands[SingleCommand]);
   }
   for (const command of Object.values(commands)) {
-    if (command.alias) {
-      const aliases = toArray(command.alias);
-      for (const alias of aliases) {
-        if (alias in commands) {
-          throw new CommandNameConflictError(commands[alias].name, command.name);
-        }
-        commandsMap.set(alias.split(" "), { ...command, __isAlias: true });
-      }
-    }
+    setCommand(commandsMap, commands, command);
     commandsMap.set(command.name.split(" "), command);
   }
   return commandsMap;
@@ -202,10 +211,12 @@ var __privateSet = (obj, member, value, setter) => {
   setter ? setter.call(obj, value) : member.set(obj, value);
   return value;
 };
-var _name, _description, _version, _inspectors, _commands, _commandEmitter, _usedNames, _hasSingleCommand;
+var _name, _description, _version, _inspectors, _commands, _commandEmitter, _usedNames, _hasSingleCommandOrAlias, hasSingleCommandOrAlias_get, _hasSingleCommand, hasSingleCommand_get;
 const SingleCommand = Symbol("SingleCommand");
 const _Clerc = class {
-  constructor() {
+  constructor(name, description, version) {
+    __privateAdd(this, _hasSingleCommandOrAlias);
+    __privateAdd(this, _hasSingleCommand);
     __privateAdd(this, _name, "");
     __privateAdd(this, _description, "");
     __privateAdd(this, _version, "");
@@ -213,7 +224,9 @@ const _Clerc = class {
     __privateAdd(this, _commands, {});
     __privateAdd(this, _commandEmitter, new LiteEmit());
     __privateAdd(this, _usedNames, []);
-    __privateAdd(this, _hasSingleCommand, false);
+    __privateSet(this, _name, name || __privateGet(this, _name));
+    __privateSet(this, _description, description || __privateGet(this, _description));
+    __privateSet(this, _version, version || __privateGet(this, _version));
   }
   get _name() {
     return __privateGet(this, _name);
@@ -230,8 +243,8 @@ const _Clerc = class {
   get _commands() {
     return __privateGet(this, _commands);
   }
-  static create() {
-    return new _Clerc();
+  static create(name, description, version) {
+    return new _Clerc(name, description, version);
   }
   name(name) {
     __privateSet(this, _name, name);
@@ -263,9 +276,6 @@ const _Clerc = class {
         throw new CommandExistsError(name2);
       }
     }
-    if (nameList.includes(SingleCommand)) {
-      __privateSet(this, _hasSingleCommand, true);
-    }
     __privateGet(this, _commands)[name] = commandToSave;
     __privateGet(this, _usedNames).push(commandToSave.name, ...toArray(commandToSave.alias) || []);
     isCommandObject && handler && this.on(nameOrCommand.name, handler);
@@ -331,8 +341,10 @@ const _Clerc = class {
       const mergedFlags = { ...flags, ...unknownFlags };
       const context = {
         name: command == null ? void 0 : command.name,
+        called: name.length === 0 ? SingleCommand : stringName,
         resolved: isCommandResolved,
-        hasSingleCommand: __privateGet(this, _hasSingleCommand),
+        hasSingleCommandOrAlias: __privateGet(this, _hasSingleCommandOrAlias, hasSingleCommandOrAlias_get),
+        hasSingleCommand: __privateGet(this, _hasSingleCommand, hasSingleCommand_get),
         raw: { ...parsed, parameters, mergedFlags },
         parameters: mapping,
         flags,
@@ -374,7 +386,14 @@ _inspectors = new WeakMap();
 _commands = new WeakMap();
 _commandEmitter = new WeakMap();
 _usedNames = new WeakMap();
-_hasSingleCommand = new WeakMap();
+_hasSingleCommandOrAlias = new WeakSet();
+hasSingleCommandOrAlias_get = function() {
+  return __privateGet(this, _usedNames).includes(SingleCommand);
+};
+_hasSingleCommand = new WeakSet();
+hasSingleCommand_get = function() {
+  return !!__privateGet(this, _commands)[SingleCommand];
+};
 
 const definePlugin = (p) => p;
 const defineHandler = (_cli, _key, handler) => handler;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clerc/core",
-  "version": "0.20.0",
+  "version": "0.21.0",
   "author": "Ray <nn_201312@163.com> (https://github.com/so1ve)",
   "description": "Clerc core",
   "keywords": [
@@ -50,7 +50,7 @@
     "is-platform": "^0.2.0",
     "lite-emit": "^1.4.0",
     "type-flag": "^3.0.0",
-    "@clerc/utils": "0.20.0"
+    "@clerc/utils": "0.21.0"
   },
   "scripts": {
     "build": "puild",