@clerc/core 0.19.0 → 0.20.0

package/dist/index.d.ts

@@ -121,7 +121,7 @@ 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;
     resolved: N extends keyof C ? true : boolean;
-    isSingleCommand: boolean;
+    hasSingleCommand: boolean;
     raw: Raw<C, N>;
     parameters: TransformParameters<C, N>;
     unknownFlags: ParsedFlags["unknownFlags"];
@@ -288,18 +288,9 @@ declare const defineHandler: <C extends Clerc<{}>, K extends keyof C["_commands"
 declare const defineInspector: <C extends Clerc<{}>>(_cli: C, inspector: Inspector<C["_commands"]>) => Inspector<C["_commands"]>;
 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 SingleCommandError extends Error {
-    constructor();
-}
-declare class SingleCommandAliasError extends Error {
-    constructor();
-}
 declare class CommandExistsError extends Error {
     constructor(name: string);
 }
-declare class CommonCommandExistsError extends Error {
-    constructor();
-}
 declare class NoSuchCommandError extends Error {
     constructor(name: string);
 }
@@ -322,11 +313,11 @@ declare class InvalidCommandNameError extends Error {
     constructor(name: string);
 }
 
-declare function resolveFlattenCommands(commands: CommandRecord): Map<string[], CommandAlias<string, CommandOptions<string[], _clerc_utils.MaybeArray<string>, _clerc_utils.Dict<FlagOptions>>>>;
-declare function resolveCommand(commands: CommandRecord, name: string | string[] | SingleCommandType): Command | undefined;
+declare function resolveFlattenCommands(commands: CommandRecord): Map<string[] | typeof SingleCommand, CommandAlias<string, CommandOptions<string[], _clerc_utils.MaybeArray<string>, _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 resolveParametersBeforeFlag(argv: string[], isSingleCommand: boolean): string[];
+declare function resolveParametersBeforeFlag(argv: string[]): string[];
 declare const resolveArgv: () => string[];
 declare function compose(inspectors: Inspector[]): (getCtx: () => InspectorContext) => void;
 declare const isInvalidName: (name: CommandType) => boolean;
@@ -339,4 +330,4 @@ interface ParsedParameter {
 declare function parseParameters(parameters: string[]): ParsedParameter[];
 declare function mapParametersToArguments(mapping: Record<string, string | string[]>, parameters: ParsedParameter[], cliArguments: string[]): Error | undefined;
 
-export { Clerc, Command, CommandAlias, CommandCustomProperties, CommandExistsError, CommandNameConflictError, CommandOptions, CommandRecord, CommandType, CommandWithHandler, CommonCommandExistsError, DescriptionNotSetError, FallbackType, Flag, FlagOptions, Handler, HandlerContext, HandlerInCommand, Inspector, InspectorContext, InspectorFn, InspectorObject, InvalidCommandNameError, MakeEventMap, NameNotSetError, NoCommandGivenError, NoSuchCommandError, Plugin, PossibleInputKind, SingleCommand, SingleCommandAliasError, SingleCommandError, SingleCommandType, VersionNotSetError, compose, defineCommand, defineHandler, defineInspector, definePlugin, isInvalidName, mapParametersToArguments, parseParameters, resolveArgv, resolveCommand, resolveFlattenCommands, resolveParametersBeforeFlag, resolveRootCommands, resolveSubcommandsByParent };
+export { Clerc, Command, CommandAlias, CommandCustomProperties, CommandExistsError, CommandNameConflictError, CommandOptions, CommandRecord, CommandType, CommandWithHandler, DescriptionNotSetError, FallbackType, Flag, FlagOptions, Handler, HandlerContext, HandlerInCommand, Inspector, InspectorContext, InspectorFn, InspectorObject, InvalidCommandNameError, MakeEventMap, NameNotSetError, NoCommandGivenError, NoSuchCommandError, Plugin, PossibleInputKind, SingleCommand, SingleCommandType, VersionNotSetError, compose, defineCommand, defineHandler, defineInspector, definePlugin, isInvalidName, mapParametersToArguments, parseParameters, resolveArgv, resolveCommand, resolveFlattenCommands, resolveParametersBeforeFlag, resolveRootCommands, resolveSubcommandsByParent };

package/dist/index.js

@@ -3,26 +3,11 @@ import { typeFlag } from 'type-flag';
 import { toArray, arrayStartsWith, camelCase } from '@clerc/utils';
 import { isNode, isDeno } from 'is-platform';
 
-class SingleCommandError extends Error {
-  constructor() {
-    super("Single command mode enabled.");
-  }
-}
-class SingleCommandAliasError extends Error {
-  constructor() {
-    super("Single command cannot have alias.");
-  }
-}
 class CommandExistsError extends Error {
   constructor(name) {
     super(`Command "${name}" exists.`);
   }
 }
-class CommonCommandExistsError extends Error {
-  constructor() {
-    super("Common command exists.");
-  }
-}
 class NoSuchCommandError extends Error {
   constructor(name) {
     super(`No such command: ${name}`);
@@ -61,6 +46,9 @@ class InvalidCommandNameError extends Error {
 
 function resolveFlattenCommands(commands) {
   const commandsMap = /* @__PURE__ */ new Map();
+  if (commands[SingleCommand]) {
+    commandsMap.set(SingleCommand, commands[SingleCommand]);
+  }
   for (const command of Object.values(commands)) {
     if (command.alias) {
       const aliases = toArray(command.alias);
@@ -84,7 +72,12 @@ function resolveCommand(commands, name) {
   let current;
   let currentName;
   commandsMap.forEach((v, k) => {
-    if (arrayStartsWith(nameArr, k) && (!currentName || k.length > currentName.length)) {
+    if (k === SingleCommand) {
+      current = commandsMap.get(SingleCommand);
+      currentName = SingleCommand;
+      return;
+    }
+    if (arrayStartsWith(nameArr, k) && (!currentName || currentName === SingleCommand || k.length > currentName.length)) {
       current = v;
       currentName = k;
     }
@@ -99,10 +92,7 @@ function resolveSubcommandsByParent(commands, parent, depth = Infinity) {
   });
 }
 const resolveRootCommands = (commands) => resolveSubcommandsByParent(commands, "", 1);
-function resolveParametersBeforeFlag(argv, isSingleCommand) {
-  if (isSingleCommand) {
-    return [];
-  }
+function resolveParametersBeforeFlag(argv) {
   const parameters = [];
   for (const arg of argv) {
     if (arg.startsWith("-")) {
@@ -212,12 +202,10 @@ 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, _isSingleCommand, isSingleCommand_get, _hasCommands, hasCommands_get;
+var _name, _description, _version, _inspectors, _commands, _commandEmitter, _usedNames, _hasSingleCommand;
 const SingleCommand = Symbol("SingleCommand");
 const _Clerc = class {
   constructor() {
-    __privateAdd(this, _isSingleCommand);
-    __privateAdd(this, _hasCommands);
     __privateAdd(this, _name, "");
     __privateAdd(this, _description, "");
     __privateAdd(this, _version, "");
@@ -225,6 +213,7 @@ const _Clerc = class {
     __privateAdd(this, _commands, {});
     __privateAdd(this, _commandEmitter, new LiteEmit());
     __privateAdd(this, _usedNames, []);
+    __privateAdd(this, _hasSingleCommand, false);
   }
   get _name() {
     return __privateGet(this, _name);
@@ -256,27 +245,16 @@ const _Clerc = class {
     __privateSet(this, _version, version);
     return this;
   }
-  command(nameOrCommand, description, options) {
+  command(nameOrCommand, description, options = {}) {
     const checkIsCommandObject = (nameOrCommand2) => !(typeof nameOrCommand2 === "string" || nameOrCommand2 === SingleCommand);
     const isCommandObject = checkIsCommandObject(nameOrCommand);
     const name = !isCommandObject ? nameOrCommand : nameOrCommand.name;
     if (__privateGet(this, _commands)[name]) {
-      if (name === SingleCommand) {
-        throw new CommandExistsError("SingleCommand");
-      }
+      throw new CommandExistsError(typeof name === "symbol" ? "" : name);
     }
     if (isInvalidName(name)) {
       throw new InvalidCommandNameError(name);
     }
-    if (__privateGet(this, _isSingleCommand, isSingleCommand_get)) {
-      throw new SingleCommandError();
-    }
-    if (name === SingleCommand && __privateGet(this, _hasCommands, hasCommands_get)) {
-      throw new CommonCommandExistsError();
-    }
-    if (name === SingleCommand && (isCommandObject ? nameOrCommand : options).alias) {
-      throw new SingleCommandAliasError();
-    }
     const { handler = void 0, ...commandToSave } = isCommandObject ? nameOrCommand : { name, description, ...options };
     const nameList = [commandToSave.name];
     commandToSave.alias && nameList.push(...toArray(commandToSave.alias));
@@ -285,6 +263,9 @@ 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);
@@ -311,9 +292,9 @@ const _Clerc = class {
     if (!__privateGet(this, _version)) {
       throw new VersionNotSetError();
     }
-    const name = resolveParametersBeforeFlag(argv, __privateGet(this, _isSingleCommand, isSingleCommand_get));
+    const name = resolveParametersBeforeFlag(argv);
     const stringName = name.join(" ");
-    const getCommand = () => __privateGet(this, _isSingleCommand, isSingleCommand_get) ? __privateGet(this, _commands)[SingleCommand] : resolveCommand(__privateGet(this, _commands), name);
+    const getCommand = () => resolveCommand(__privateGet(this, _commands), name);
     const mapErrors = [];
     const getContext = () => {
       mapErrors.length = 0;
@@ -321,7 +302,7 @@ const _Clerc = class {
       const isCommandResolved = !!command;
       const parsed = typeFlag((command == null ? void 0 : command.flags) || {}, [...argv]);
       const { _: args, flags, unknownFlags } = parsed;
-      let parameters = __privateGet(this, _isSingleCommand, isSingleCommand_get) || !isCommandResolved ? args : args.slice(command.name.split(" ").length);
+      let parameters = !isCommandResolved || command.name === SingleCommand ? args : args.slice(command.name.split(" ").length);
       let commandParameters = (command == null ? void 0 : command.parameters) || [];
       const hasEof = commandParameters.indexOf("--");
       const eofParameters = commandParameters.slice(hasEof + 1) || [];
@@ -351,7 +332,7 @@ const _Clerc = class {
       const context = {
         name: command == null ? void 0 : command.name,
         resolved: isCommandResolved,
-        isSingleCommand: __privateGet(this, _isSingleCommand, isSingleCommand_get),
+        hasSingleCommand: __privateGet(this, _hasSingleCommand),
         raw: { ...parsed, parameters, mergedFlags },
         parameters: mapping,
         flags,
@@ -393,18 +374,11 @@ _inspectors = new WeakMap();
 _commands = new WeakMap();
 _commandEmitter = new WeakMap();
 _usedNames = new WeakMap();
-_isSingleCommand = new WeakSet();
-isSingleCommand_get = function() {
-  return __privateGet(this, _commands)[SingleCommand] !== void 0;
-};
-_hasCommands = new WeakSet();
-hasCommands_get = function() {
-  return Object.keys(__privateGet(this, _commands)).length > 0;
-};
+_hasSingleCommand = new WeakMap();
 
 const definePlugin = (p) => p;
 const defineHandler = (_cli, _key, handler) => handler;
 const defineInspector = (_cli, inspector) => inspector;
 const defineCommand = (command) => command;
 
-export { Clerc, CommandExistsError, CommandNameConflictError, CommonCommandExistsError, DescriptionNotSetError, InvalidCommandNameError, NameNotSetError, NoCommandGivenError, NoSuchCommandError, SingleCommand, SingleCommandAliasError, SingleCommandError, VersionNotSetError, compose, defineCommand, defineHandler, defineInspector, definePlugin, isInvalidName, mapParametersToArguments, parseParameters, resolveArgv, resolveCommand, resolveFlattenCommands, resolveParametersBeforeFlag, resolveRootCommands, resolveSubcommandsByParent };
+export { Clerc, CommandExistsError, CommandNameConflictError, DescriptionNotSetError, InvalidCommandNameError, NameNotSetError, NoCommandGivenError, NoSuchCommandError, SingleCommand, VersionNotSetError, compose, defineCommand, defineHandler, defineInspector, definePlugin, isInvalidName, mapParametersToArguments, parseParameters, resolveArgv, resolveCommand, resolveFlattenCommands, resolveParametersBeforeFlag, resolveRootCommands, resolveSubcommandsByParent };

package/dist/index.mjs

@@ -3,26 +3,11 @@ import { typeFlag } from 'type-flag';
 import { toArray, arrayStartsWith, camelCase } from '@clerc/utils';
 import { isNode, isDeno } from 'is-platform';
 
-class SingleCommandError extends Error {
-  constructor() {
-    super("Single command mode enabled.");
-  }
-}
-class SingleCommandAliasError extends Error {
-  constructor() {
-    super("Single command cannot have alias.");
-  }
-}
 class CommandExistsError extends Error {
   constructor(name) {
     super(`Command "${name}" exists.`);
   }
 }
-class CommonCommandExistsError extends Error {
-  constructor() {
-    super("Common command exists.");
-  }
-}
 class NoSuchCommandError extends Error {
   constructor(name) {
     super(`No such command: ${name}`);
@@ -61,6 +46,9 @@ class InvalidCommandNameError extends Error {
 
 function resolveFlattenCommands(commands) {
   const commandsMap = /* @__PURE__ */ new Map();
+  if (commands[SingleCommand]) {
+    commandsMap.set(SingleCommand, commands[SingleCommand]);
+  }
   for (const command of Object.values(commands)) {
     if (command.alias) {
       const aliases = toArray(command.alias);
@@ -84,7 +72,12 @@ function resolveCommand(commands, name) {
   let current;
   let currentName;
   commandsMap.forEach((v, k) => {
-    if (arrayStartsWith(nameArr, k) && (!currentName || k.length > currentName.length)) {
+    if (k === SingleCommand) {
+      current = commandsMap.get(SingleCommand);
+      currentName = SingleCommand;
+      return;
+    }
+    if (arrayStartsWith(nameArr, k) && (!currentName || currentName === SingleCommand || k.length > currentName.length)) {
       current = v;
       currentName = k;
     }
@@ -99,10 +92,7 @@ function resolveSubcommandsByParent(commands, parent, depth = Infinity) {
   });
 }
 const resolveRootCommands = (commands) => resolveSubcommandsByParent(commands, "", 1);
-function resolveParametersBeforeFlag(argv, isSingleCommand) {
-  if (isSingleCommand) {
-    return [];
-  }
+function resolveParametersBeforeFlag(argv) {
   const parameters = [];
   for (const arg of argv) {
     if (arg.startsWith("-")) {
@@ -212,12 +202,10 @@ 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, _isSingleCommand, isSingleCommand_get, _hasCommands, hasCommands_get;
+var _name, _description, _version, _inspectors, _commands, _commandEmitter, _usedNames, _hasSingleCommand;
 const SingleCommand = Symbol("SingleCommand");
 const _Clerc = class {
   constructor() {
-    __privateAdd(this, _isSingleCommand);
-    __privateAdd(this, _hasCommands);
     __privateAdd(this, _name, "");
     __privateAdd(this, _description, "");
     __privateAdd(this, _version, "");
@@ -225,6 +213,7 @@ const _Clerc = class {
     __privateAdd(this, _commands, {});
     __privateAdd(this, _commandEmitter, new LiteEmit());
     __privateAdd(this, _usedNames, []);
+    __privateAdd(this, _hasSingleCommand, false);
   }
   get _name() {
     return __privateGet(this, _name);
@@ -256,27 +245,16 @@ const _Clerc = class {
     __privateSet(this, _version, version);
     return this;
   }
-  command(nameOrCommand, description, options) {
+  command(nameOrCommand, description, options = {}) {
     const checkIsCommandObject = (nameOrCommand2) => !(typeof nameOrCommand2 === "string" || nameOrCommand2 === SingleCommand);
     const isCommandObject = checkIsCommandObject(nameOrCommand);
     const name = !isCommandObject ? nameOrCommand : nameOrCommand.name;
     if (__privateGet(this, _commands)[name]) {
-      if (name === SingleCommand) {
-        throw new CommandExistsError("SingleCommand");
-      }
+      throw new CommandExistsError(typeof name === "symbol" ? "" : name);
     }
     if (isInvalidName(name)) {
       throw new InvalidCommandNameError(name);
     }
-    if (__privateGet(this, _isSingleCommand, isSingleCommand_get)) {
-      throw new SingleCommandError();
-    }
-    if (name === SingleCommand && __privateGet(this, _hasCommands, hasCommands_get)) {
-      throw new CommonCommandExistsError();
-    }
-    if (name === SingleCommand && (isCommandObject ? nameOrCommand : options).alias) {
-      throw new SingleCommandAliasError();
-    }
     const { handler = void 0, ...commandToSave } = isCommandObject ? nameOrCommand : { name, description, ...options };
     const nameList = [commandToSave.name];
     commandToSave.alias && nameList.push(...toArray(commandToSave.alias));
@@ -285,6 +263,9 @@ 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);
@@ -311,9 +292,9 @@ const _Clerc = class {
     if (!__privateGet(this, _version)) {
       throw new VersionNotSetError();
     }
-    const name = resolveParametersBeforeFlag(argv, __privateGet(this, _isSingleCommand, isSingleCommand_get));
+    const name = resolveParametersBeforeFlag(argv);
     const stringName = name.join(" ");
-    const getCommand = () => __privateGet(this, _isSingleCommand, isSingleCommand_get) ? __privateGet(this, _commands)[SingleCommand] : resolveCommand(__privateGet(this, _commands), name);
+    const getCommand = () => resolveCommand(__privateGet(this, _commands), name);
     const mapErrors = [];
     const getContext = () => {
       mapErrors.length = 0;
@@ -321,7 +302,7 @@ const _Clerc = class {
       const isCommandResolved = !!command;
       const parsed = typeFlag((command == null ? void 0 : command.flags) || {}, [...argv]);
       const { _: args, flags, unknownFlags } = parsed;
-      let parameters = __privateGet(this, _isSingleCommand, isSingleCommand_get) || !isCommandResolved ? args : args.slice(command.name.split(" ").length);
+      let parameters = !isCommandResolved || command.name === SingleCommand ? args : args.slice(command.name.split(" ").length);
       let commandParameters = (command == null ? void 0 : command.parameters) || [];
       const hasEof = commandParameters.indexOf("--");
       const eofParameters = commandParameters.slice(hasEof + 1) || [];
@@ -351,7 +332,7 @@ const _Clerc = class {
       const context = {
         name: command == null ? void 0 : command.name,
         resolved: isCommandResolved,
-        isSingleCommand: __privateGet(this, _isSingleCommand, isSingleCommand_get),
+        hasSingleCommand: __privateGet(this, _hasSingleCommand),
         raw: { ...parsed, parameters, mergedFlags },
         parameters: mapping,
         flags,
@@ -393,18 +374,11 @@ _inspectors = new WeakMap();
 _commands = new WeakMap();
 _commandEmitter = new WeakMap();
 _usedNames = new WeakMap();
-_isSingleCommand = new WeakSet();
-isSingleCommand_get = function() {
-  return __privateGet(this, _commands)[SingleCommand] !== void 0;
-};
-_hasCommands = new WeakSet();
-hasCommands_get = function() {
-  return Object.keys(__privateGet(this, _commands)).length > 0;
-};
+_hasSingleCommand = new WeakMap();
 
 const definePlugin = (p) => p;
 const defineHandler = (_cli, _key, handler) => handler;
 const defineInspector = (_cli, inspector) => inspector;
 const defineCommand = (command) => command;
 
-export { Clerc, CommandExistsError, CommandNameConflictError, CommonCommandExistsError, DescriptionNotSetError, InvalidCommandNameError, NameNotSetError, NoCommandGivenError, NoSuchCommandError, SingleCommand, SingleCommandAliasError, SingleCommandError, VersionNotSetError, compose, defineCommand, defineHandler, defineInspector, definePlugin, isInvalidName, mapParametersToArguments, parseParameters, resolveArgv, resolveCommand, resolveFlattenCommands, resolveParametersBeforeFlag, resolveRootCommands, resolveSubcommandsByParent };
+export { Clerc, CommandExistsError, CommandNameConflictError, DescriptionNotSetError, InvalidCommandNameError, NameNotSetError, NoCommandGivenError, NoSuchCommandError, SingleCommand, VersionNotSetError, compose, defineCommand, defineHandler, defineInspector, definePlugin, isInvalidName, mapParametersToArguments, parseParameters, resolveArgv, resolveCommand, resolveFlattenCommands, resolveParametersBeforeFlag, resolveRootCommands, resolveSubcommandsByParent };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clerc/core",
-  "version": "0.19.0",
+  "version": "0.20.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.19.0"
+    "@clerc/utils": "0.20.0"
   },
   "scripts": {
     "build": "puild",