@clerc/core 0.22.0 → 0.22.1

package/dist/index.d.ts

@@ -291,12 +291,12 @@ declare const defineInspector: <C extends Clerc<{}>>(_cli: C, inspector: Inspect
 declare const defineCommand: <N extends string | typeof Root, 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);
+    commandName: string;
+    constructor(commandName: string);
 }
 declare class NoSuchCommandError extends Error {
-    name: string;
-    constructor(name: string);
+    commandName: string;
+    constructor(commandName: string);
 }
 declare class NoCommandGivenError extends Error {
     constructor();
@@ -316,8 +316,8 @@ declare class VersionNotSetError extends Error {
     constructor();
 }
 declare class InvalidCommandNameError extends Error {
-    name: string;
-    constructor(name: string);
+    commandName: string;
+    constructor(commandName: string);
 }
 
 declare function resolveFlattenCommands(commands: CommandRecord): Map<string[] | typeof Root, CommandAlias<string, CommandOptions<string[], _clerc_utils.MaybeArray<string | typeof Root>, _clerc_utils.Dict<FlagOptions>>>>;
@@ -327,14 +327,8 @@ declare const resolveRootCommands: (commands: CommandRecord) => Command<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;
-
-interface ParsedParameter {
-    name: string;
-    required: boolean;
-    spread: boolean;
-}
-declare function parseParameters(parameters: string[]): ParsedParameter[];
-declare function mapParametersToArguments(mapping: Record<string, string | string[]>, parameters: ParsedParameter[], cliArguments: string[]): Error | undefined;
+declare const isInvalidName: (name: CommandType) => boolean;
+declare const withBrackets: (s: string, isOptional?: boolean) => string;
+declare const formatCommandName: (name: string | string[] | RootType) => string;
 
-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, Root, RootType, 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, Root, RootType, VersionNotSetError, compose, defineCommand, defineHandler, defineInspector, definePlugin, formatCommandName, isInvalidName, resolveArgv, resolveCommand, resolveFlattenCommands, resolveParametersBeforeFlag, resolveRootCommands, resolveSubcommandsByParent, withBrackets };

package/dist/index.js

@@ -4,15 +4,15 @@ import { toArray, arrayStartsWith, camelCase } from '@clerc/utils';
 import { isNode, isDeno } from 'is-platform';
 
 class CommandExistsError extends Error {
-  constructor(name) {
-    super(`Command "${name}" exists.`);
-    this.name = name;
+  constructor(commandName) {
+    super(`Command "${commandName}" exists.`);
+    this.commandName = commandName;
   }
 }
 class NoSuchCommandError extends Error {
-  constructor(name) {
-    super(`No such command: ${name}`);
-    this.name = name;
+  constructor(commandName) {
+    super(`No such command: ${commandName}`);
+    this.commandName = commandName;
   }
 }
 class NoCommandGivenError extends Error {
@@ -43,9 +43,9 @@ class VersionNotSetError extends Error {
   }
 }
 class InvalidCommandNameError extends Error {
-  constructor(name) {
-    super(`Bad name format: ${name}`);
-    this.name = name;
+  constructor(commandName) {
+    super(`Bad name format: ${commandName}`);
+    this.commandName = commandName;
   }
 }
 
@@ -113,18 +113,24 @@ function resolveParametersBeforeFlag(argv) {
 }
 const resolveArgv = () => isNode() ? process.argv.slice(2) : isDeno() ? Deno.args : [];
 function compose(inspectors) {
-  const preInspectors = [];
-  const normalInspectors = [];
-  const postInspectors = [];
+  const inspectorMap = {
+    pre: [],
+    normal: [],
+    post: []
+  };
   for (const inspector of inspectors) {
     const objectInspector = typeof inspector === "object" ? inspector : { fn: inspector };
-    const { enforce } = objectInspector;
-    (enforce === "pre" ? preInspectors : enforce === "post" ? postInspectors : normalInspectors).push(objectInspector.fn);
+    const { enforce, fn } = objectInspector;
+    if (enforce === "post" || enforce === "pre") {
+      inspectorMap[enforce].push(fn);
+    } else {
+      inspectorMap.normal.push(fn);
+    }
   }
   const mergedInspectorFns = [
-    ...preInspectors,
-    ...normalInspectors,
-    ...postInspectors
+    ...inspectorMap.pre,
+    ...inspectorMap.normal,
+    ...inspectorMap.post
   ];
   return (getCtx) => {
     return dispatch(0);
@@ -135,6 +141,9 @@ function compose(inspectors) {
   };
 }
 const isInvalidName = (name) => typeof name === "string" && (name.startsWith(" ") || name.endsWith(" "));
+const withBrackets = (s, isOptional) => isOptional ? `[${s}]` : `<${s}>`;
+const ROOT = "<Root>";
+const formatCommandName = (name) => Array.isArray(name) ? name.join(" ") : typeof name === "string" ? name : ROOT;
 
 const { stringify } = JSON;
 function parseParameters(parameters) {
@@ -223,7 +232,7 @@ const _Clerc = class {
     __privateAdd(this, _inspectors, []);
     __privateAdd(this, _commands, {});
     __privateAdd(this, _commandEmitter, new LiteEmit());
-    __privateAdd(this, _usedNames, []);
+    __privateAdd(this, _usedNames, /* @__PURE__ */ new Set());
     __privateSet(this, _name, name || __privateGet(this, _name));
     __privateSet(this, _description, description || __privateGet(this, _description));
     __privateSet(this, _version, version || __privateGet(this, _version));
@@ -262,9 +271,6 @@ const _Clerc = class {
     const checkIsCommandObject = (nameOrCommand2) => !(typeof nameOrCommand2 === "string" || nameOrCommand2 === Root);
     const isCommandObject = checkIsCommandObject(nameOrCommand);
     const name = !isCommandObject ? nameOrCommand : nameOrCommand.name;
-    if (__privateGet(this, _commands)[name]) {
-      throw new CommandExistsError(typeof name === "symbol" ? "" : name);
-    }
     if (isInvalidName(name)) {
       throw new InvalidCommandNameError(name);
     }
@@ -272,12 +278,13 @@ const _Clerc = class {
     const nameList = [commandToSave.name];
     commandToSave.alias && nameList.push(...toArray(commandToSave.alias));
     for (const name2 of nameList) {
-      if (__privateGet(this, _usedNames).includes(name2)) {
-        throw new CommandExistsError(name2);
+      if (__privateGet(this, _usedNames).has(name2)) {
+        throw new CommandExistsError(formatCommandName(name2));
       }
     }
     __privateGet(this, _commands)[name] = commandToSave;
-    __privateGet(this, _usedNames).push(commandToSave.name, ...toArray(commandToSave.alias) || []);
+    __privateGet(this, _usedNames).add(commandToSave.name);
+    (toArray(commandToSave.alias) || []).forEach((a) => __privateGet(this, _usedNames).add(a));
     isCommandObject && handler && this.on(nameOrCommand.name, handler);
     return this;
   }
@@ -341,7 +348,7 @@ const _Clerc = class {
       const mergedFlags = { ...flags, ...unknownFlags };
       const context = {
         name: command == null ? void 0 : command.name,
-        called: name.length === 0 ? Root : stringName,
+        called: name.length === 0 && (command == null ? void 0 : command.name) ? Root : stringName,
         resolved: isCommandResolved,
         hasRootOrAlias: __privateGet(this, _hasRootOrAlias, hasRootOrAlias_get),
         hasRoot: __privateGet(this, _hasRoot, hasRoot_get),
@@ -388,11 +395,11 @@ _commandEmitter = new WeakMap();
 _usedNames = new WeakMap();
 _hasRootOrAlias = new WeakSet();
 hasRootOrAlias_get = function() {
-  return __privateGet(this, _usedNames).includes(Root);
+  return __privateGet(this, _usedNames).has(Root);
 };
 _hasRoot = new WeakSet();
 hasRoot_get = function() {
-  return !!__privateGet(this, _commands)[Root];
+  return Object.hasOwn(this._commands, Root);
 };
 
 const definePlugin = (p) => p;
@@ -400,4 +407,4 @@ const defineHandler = (_cli, _key, handler) => handler;
 const defineInspector = (_cli, inspector) => inspector;
 const defineCommand = (command) => command;
 
-export { Clerc, CommandExistsError, CommandNameConflictError, DescriptionNotSetError, InvalidCommandNameError, NameNotSetError, NoCommandGivenError, NoSuchCommandError, Root, VersionNotSetError, compose, defineCommand, defineHandler, defineInspector, definePlugin, isInvalidName, mapParametersToArguments, parseParameters, resolveArgv, resolveCommand, resolveFlattenCommands, resolveParametersBeforeFlag, resolveRootCommands, resolveSubcommandsByParent };
+export { Clerc, CommandExistsError, CommandNameConflictError, DescriptionNotSetError, InvalidCommandNameError, NameNotSetError, NoCommandGivenError, NoSuchCommandError, Root, VersionNotSetError, compose, defineCommand, defineHandler, defineInspector, definePlugin, formatCommandName, isInvalidName, resolveArgv, resolveCommand, resolveFlattenCommands, resolveParametersBeforeFlag, resolveRootCommands, resolveSubcommandsByParent, withBrackets };

package/dist/index.mjs

@@ -4,15 +4,15 @@ import { toArray, arrayStartsWith, camelCase } from '@clerc/utils';
 import { isNode, isDeno } from 'is-platform';
 
 class CommandExistsError extends Error {
-  constructor(name) {
-    super(`Command "${name}" exists.`);
-    this.name = name;
+  constructor(commandName) {
+    super(`Command "${commandName}" exists.`);
+    this.commandName = commandName;
   }
 }
 class NoSuchCommandError extends Error {
-  constructor(name) {
-    super(`No such command: ${name}`);
-    this.name = name;
+  constructor(commandName) {
+    super(`No such command: ${commandName}`);
+    this.commandName = commandName;
   }
 }
 class NoCommandGivenError extends Error {
@@ -43,9 +43,9 @@ class VersionNotSetError extends Error {
   }
 }
 class InvalidCommandNameError extends Error {
-  constructor(name) {
-    super(`Bad name format: ${name}`);
-    this.name = name;
+  constructor(commandName) {
+    super(`Bad name format: ${commandName}`);
+    this.commandName = commandName;
   }
 }
 
@@ -113,18 +113,24 @@ function resolveParametersBeforeFlag(argv) {
 }
 const resolveArgv = () => isNode() ? process.argv.slice(2) : isDeno() ? Deno.args : [];
 function compose(inspectors) {
-  const preInspectors = [];
-  const normalInspectors = [];
-  const postInspectors = [];
+  const inspectorMap = {
+    pre: [],
+    normal: [],
+    post: []
+  };
   for (const inspector of inspectors) {
     const objectInspector = typeof inspector === "object" ? inspector : { fn: inspector };
-    const { enforce } = objectInspector;
-    (enforce === "pre" ? preInspectors : enforce === "post" ? postInspectors : normalInspectors).push(objectInspector.fn);
+    const { enforce, fn } = objectInspector;
+    if (enforce === "post" || enforce === "pre") {
+      inspectorMap[enforce].push(fn);
+    } else {
+      inspectorMap.normal.push(fn);
+    }
   }
   const mergedInspectorFns = [
-    ...preInspectors,
-    ...normalInspectors,
-    ...postInspectors
+    ...inspectorMap.pre,
+    ...inspectorMap.normal,
+    ...inspectorMap.post
   ];
   return (getCtx) => {
     return dispatch(0);
@@ -135,6 +141,9 @@ function compose(inspectors) {
   };
 }
 const isInvalidName = (name) => typeof name === "string" && (name.startsWith(" ") || name.endsWith(" "));
+const withBrackets = (s, isOptional) => isOptional ? `[${s}]` : `<${s}>`;
+const ROOT = "<Root>";
+const formatCommandName = (name) => Array.isArray(name) ? name.join(" ") : typeof name === "string" ? name : ROOT;
 
 const { stringify } = JSON;
 function parseParameters(parameters) {
@@ -223,7 +232,7 @@ const _Clerc = class {
     __privateAdd(this, _inspectors, []);
     __privateAdd(this, _commands, {});
     __privateAdd(this, _commandEmitter, new LiteEmit());
-    __privateAdd(this, _usedNames, []);
+    __privateAdd(this, _usedNames, /* @__PURE__ */ new Set());
     __privateSet(this, _name, name || __privateGet(this, _name));
     __privateSet(this, _description, description || __privateGet(this, _description));
     __privateSet(this, _version, version || __privateGet(this, _version));
@@ -262,9 +271,6 @@ const _Clerc = class {
     const checkIsCommandObject = (nameOrCommand2) => !(typeof nameOrCommand2 === "string" || nameOrCommand2 === Root);
     const isCommandObject = checkIsCommandObject(nameOrCommand);
     const name = !isCommandObject ? nameOrCommand : nameOrCommand.name;
-    if (__privateGet(this, _commands)[name]) {
-      throw new CommandExistsError(typeof name === "symbol" ? "" : name);
-    }
     if (isInvalidName(name)) {
       throw new InvalidCommandNameError(name);
     }
@@ -272,12 +278,13 @@ const _Clerc = class {
     const nameList = [commandToSave.name];
     commandToSave.alias && nameList.push(...toArray(commandToSave.alias));
     for (const name2 of nameList) {
-      if (__privateGet(this, _usedNames).includes(name2)) {
-        throw new CommandExistsError(name2);
+      if (__privateGet(this, _usedNames).has(name2)) {
+        throw new CommandExistsError(formatCommandName(name2));
       }
     }
     __privateGet(this, _commands)[name] = commandToSave;
-    __privateGet(this, _usedNames).push(commandToSave.name, ...toArray(commandToSave.alias) || []);
+    __privateGet(this, _usedNames).add(commandToSave.name);
+    (toArray(commandToSave.alias) || []).forEach((a) => __privateGet(this, _usedNames).add(a));
     isCommandObject && handler && this.on(nameOrCommand.name, handler);
     return this;
   }
@@ -341,7 +348,7 @@ const _Clerc = class {
       const mergedFlags = { ...flags, ...unknownFlags };
       const context = {
         name: command == null ? void 0 : command.name,
-        called: name.length === 0 ? Root : stringName,
+        called: name.length === 0 && (command == null ? void 0 : command.name) ? Root : stringName,
         resolved: isCommandResolved,
         hasRootOrAlias: __privateGet(this, _hasRootOrAlias, hasRootOrAlias_get),
         hasRoot: __privateGet(this, _hasRoot, hasRoot_get),
@@ -388,11 +395,11 @@ _commandEmitter = new WeakMap();
 _usedNames = new WeakMap();
 _hasRootOrAlias = new WeakSet();
 hasRootOrAlias_get = function() {
-  return __privateGet(this, _usedNames).includes(Root);
+  return __privateGet(this, _usedNames).has(Root);
 };
 _hasRoot = new WeakSet();
 hasRoot_get = function() {
-  return !!__privateGet(this, _commands)[Root];
+  return Object.hasOwn(this._commands, Root);
 };
 
 const definePlugin = (p) => p;
@@ -400,4 +407,4 @@ const defineHandler = (_cli, _key, handler) => handler;
 const defineInspector = (_cli, inspector) => inspector;
 const defineCommand = (command) => command;
 
-export { Clerc, CommandExistsError, CommandNameConflictError, DescriptionNotSetError, InvalidCommandNameError, NameNotSetError, NoCommandGivenError, NoSuchCommandError, Root, VersionNotSetError, compose, defineCommand, defineHandler, defineInspector, definePlugin, isInvalidName, mapParametersToArguments, parseParameters, resolveArgv, resolveCommand, resolveFlattenCommands, resolveParametersBeforeFlag, resolveRootCommands, resolveSubcommandsByParent };
+export { Clerc, CommandExistsError, CommandNameConflictError, DescriptionNotSetError, InvalidCommandNameError, NameNotSetError, NoCommandGivenError, NoSuchCommandError, Root, VersionNotSetError, compose, defineCommand, defineHandler, defineInspector, definePlugin, formatCommandName, isInvalidName, resolveArgv, resolveCommand, resolveFlattenCommands, resolveParametersBeforeFlag, resolveRootCommands, resolveSubcommandsByParent, withBrackets };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clerc/core",
-  "version": "0.22.0",
+  "version": "0.22.1",
   "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.22.0"
+    "@clerc/utils": "0.22.1"
   },
   "scripts": {
     "build": "puild",