@clerc/core 0.17.2 → 0.18.0

package/dist/index.d.ts

@@ -69,6 +69,7 @@ type TypeFlag<Schemas extends Flags> = ParsedFlags<{
     [flag in keyof Schemas]: InferFlagType<Schemas[flag]>;
 }>;
 
+type CommandType = SingleCommandType | string;
 type FlagOptions = FlagSchema & {
     description?: string;
 };
@@ -305,15 +306,6 @@ declare class NoSuchCommandError extends Error {
 declare class NoCommandGivenError extends Error {
     constructor();
 }
-declare class ParentCommandExistsError extends Error {
-    constructor(name: string);
-}
-declare class SubcommandExistsError extends Error {
-    constructor(name: string);
-}
-declare class MultipleCommandsMatchedError extends Error {
-    constructor(name: string);
-}
 declare class CommandNameConflictError extends Error {
     constructor(n1: string, n2: string);
 }
@@ -325,6 +317,9 @@ declare class DescriptionNotSetError extends Error {
 }
 declare class VersionNotSetError extends Error {
     constructor();
+}
+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>>>>;
@@ -333,7 +328,8 @@ declare function resolveSubcommandsByParent(commands: CommandRecord, parent: str
 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 const resolveArgv: () => string[];
-declare function compose(inspectors: Inspector[]): (getCtx: () => InspectorContext) => void;
+declare function compose(inspectors: Inspector[]): (getCtx: () => InspectorContext) => void;
+declare const isInvalidName: (name: CommandType) => boolean;
 
 interface ParsedParameter {
     name: string;
@@ -343,4 +339,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, CommandWithHandler, CommonCommandExistsError, DescriptionNotSetError, FallbackType, Flag, FlagOptions, Handler, HandlerContext, HandlerInCommand, Inspector, InspectorContext, InspectorFn, InspectorObject, MakeEventMap, MultipleCommandsMatchedError, NameNotSetError, NoCommandGivenError, NoSuchCommandError, ParentCommandExistsError, Plugin, PossibleInputKind, SingleCommand, SingleCommandAliasError, SingleCommandError, SingleCommandType, SubcommandExistsError, VersionNotSetError, compose, defineCommand, defineHandler, defineInspector, definePlugin, mapParametersToArguments, parseParameters, resolveArgv, resolveCommand, resolveFlattenCommands, resolveParametersBeforeFlag, resolveRootCommands, resolveSubcommandsByParent };
+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 };

package/dist/index.js

@@ -1,6 +1,6 @@
 import { LiteEmit } from 'lite-emit';
 import { typeFlag } from 'type-flag';
-import { mustArray, arrayStartsWith, camelCase } from '@clerc/utils';
+import { toArray, arrayStartsWith, camelCase } from '@clerc/utils';
 import { isNode, isDeno } from 'is-platform';
 
 class SingleCommandError extends Error {
@@ -33,21 +33,6 @@ class NoCommandGivenError extends Error {
     super("No command given.");
   }
 }
-class ParentCommandExistsError extends Error {
-  constructor(name) {
-    super(`Command "${name}" cannot exist with its parent.`);
-  }
-}
-class SubcommandExistsError extends Error {
-  constructor(name) {
-    super(`Command "${name}" cannot exist with its subcommand.`);
-  }
-}
-class MultipleCommandsMatchedError extends Error {
-  constructor(name) {
-    super(`Multiple commands matched: ${name}`);
-  }
-}
 class CommandNameConflictError extends Error {
   constructor(n1, n2) {
     super(`Command name ${n1} conflicts with ${n2}. Maybe caused by alias.`);
@@ -68,12 +53,17 @@ class VersionNotSetError extends Error {
     super("Version not set.");
   }
 }
+class InvalidCommandNameError extends Error {
+  constructor(name) {
+    super(`Bad name format: ${name}`);
+  }
+}
 
 function resolveFlattenCommands(commands) {
   const commandsMap = /* @__PURE__ */ new Map();
   for (const command of Object.values(commands)) {
     if (command.alias) {
-      const aliases = mustArray(command.alias);
+      const aliases = toArray(command.alias);
       for (const alias of aliases) {
         if (alias in commands) {
           throw new CommandNameConflictError(commands[alias].name, command.name);
@@ -89,19 +79,17 @@ function resolveCommand(commands, name) {
   if (name === SingleCommand) {
     return commands[SingleCommand];
   }
-  const nameArr = mustArray(name);
+  const nameArr = toArray(name);
   const commandsMap = resolveFlattenCommands(commands);
-  const possibleCommands = [];
+  let current;
+  let currentName;
   commandsMap.forEach((v, k) => {
-    if (arrayStartsWith(nameArr, k)) {
-      possibleCommands.push(v);
+    if (arrayStartsWith(nameArr, k) && (!currentName || k.length > currentName.length)) {
+      current = v;
+      currentName = k;
     }
   });
-  if (possibleCommands.length > 1) {
-    const matchedCommandNames = possibleCommands.map((c) => c.name).join(", ");
-    throw new MultipleCommandsMatchedError(matchedCommandNames);
-  }
-  return possibleCommands[0];
+  return current;
 }
 function resolveSubcommandsByParent(commands, parent, depth = Infinity) {
   const parentArr = parent === "" ? [] : Array.isArray(parent) ? parent : parent.split(" ");
@@ -147,6 +135,7 @@ function compose(inspectors) {
     }
   };
 }
+const isInvalidName = (name) => typeof name === "string" && (name.startsWith(" ") || name.endsWith(" "));
 
 const { stringify } = JSON;
 function parseParameters(parameters) {
@@ -275,6 +264,9 @@ const _Clerc = class {
         throw new CommandExistsError("SingleCommand");
       }
     }
+    if (isInvalidName(name)) {
+      throw new InvalidCommandNameError(name);
+    }
     if (__privateGet(this, _isSingleCommand, isSingleCommand_get)) {
       throw new SingleCommandError();
     }
@@ -284,21 +276,16 @@ const _Clerc = class {
     if (name === SingleCommand && (isCommandObject ? nameOrCommand : options).alias) {
       throw new SingleCommandAliasError();
     }
-    if (name !== SingleCommand) {
-      const splitedName = name.split(" ");
-      const existedCommandNames = Object.keys(__privateGet(this, _commands)).filter((name2) => typeof name2 === "string").map((name2) => name2.split(" "));
-      if (existedCommandNames.some((name2) => arrayStartsWith(splitedName, name2))) {
-        throw new ParentCommandExistsError(splitedName.join(" "));
-      }
-      if (existedCommandNames.some((name2) => arrayStartsWith(name2, splitedName))) {
-        throw new SubcommandExistsError(splitedName.join(" "));
+    const { handler = void 0, ...commandToSave } = isCommandObject ? nameOrCommand : { name, description, ...options };
+    const nameList = [commandToSave.name];
+    commandToSave.alias && nameList.push(...toArray(commandToSave.alias));
+    for (const name2 of nameList) {
+      if (Object.keys(__privateGet(this, _commands)).includes(name2) || Object.values(__privateGet(this, _commands)).some(({ alias }) => alias ? toArray(alias).includes(name2) : false)) {
+        throw new CommandExistsError(name2);
       }
     }
-    const { handler = void 0, ...commandToSave } = isCommandObject ? nameOrCommand : { name, description, ...options };
     __privateGet(this, _commands)[name] = commandToSave;
-    if (isCommandObject && handler) {
-      this.on(nameOrCommand.name, handler);
-    }
+    isCommandObject && handler && this.on(nameOrCommand.name, handler);
     return this;
   }
   on(name, handler) {
@@ -417,4 +404,4 @@ const defineHandler = (_cli, _key, handler) => handler;
 const defineInspector = (_cli, inspector) => inspector;
 const defineCommand = (command) => command;
 
-export { Clerc, CommandExistsError, CommandNameConflictError, CommonCommandExistsError, DescriptionNotSetError, MultipleCommandsMatchedError, NameNotSetError, NoCommandGivenError, NoSuchCommandError, ParentCommandExistsError, SingleCommand, SingleCommandAliasError, SingleCommandError, SubcommandExistsError, VersionNotSetError, compose, defineCommand, defineHandler, defineInspector, definePlugin, mapParametersToArguments, parseParameters, resolveArgv, resolveCommand, resolveFlattenCommands, resolveParametersBeforeFlag, resolveRootCommands, resolveSubcommandsByParent };
+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 };

package/dist/index.mjs

@@ -1,6 +1,6 @@
 import { LiteEmit } from 'lite-emit';
 import { typeFlag } from 'type-flag';
-import { mustArray, arrayStartsWith, camelCase } from '@clerc/utils';
+import { toArray, arrayStartsWith, camelCase } from '@clerc/utils';
 import { isNode, isDeno } from 'is-platform';
 
 class SingleCommandError extends Error {
@@ -33,21 +33,6 @@ class NoCommandGivenError extends Error {
     super("No command given.");
   }
 }
-class ParentCommandExistsError extends Error {
-  constructor(name) {
-    super(`Command "${name}" cannot exist with its parent.`);
-  }
-}
-class SubcommandExistsError extends Error {
-  constructor(name) {
-    super(`Command "${name}" cannot exist with its subcommand.`);
-  }
-}
-class MultipleCommandsMatchedError extends Error {
-  constructor(name) {
-    super(`Multiple commands matched: ${name}`);
-  }
-}
 class CommandNameConflictError extends Error {
   constructor(n1, n2) {
     super(`Command name ${n1} conflicts with ${n2}. Maybe caused by alias.`);
@@ -68,12 +53,17 @@ class VersionNotSetError extends Error {
     super("Version not set.");
   }
 }
+class InvalidCommandNameError extends Error {
+  constructor(name) {
+    super(`Bad name format: ${name}`);
+  }
+}
 
 function resolveFlattenCommands(commands) {
   const commandsMap = /* @__PURE__ */ new Map();
   for (const command of Object.values(commands)) {
     if (command.alias) {
-      const aliases = mustArray(command.alias);
+      const aliases = toArray(command.alias);
       for (const alias of aliases) {
         if (alias in commands) {
           throw new CommandNameConflictError(commands[alias].name, command.name);
@@ -89,19 +79,17 @@ function resolveCommand(commands, name) {
   if (name === SingleCommand) {
     return commands[SingleCommand];
   }
-  const nameArr = mustArray(name);
+  const nameArr = toArray(name);
   const commandsMap = resolveFlattenCommands(commands);
-  const possibleCommands = [];
+  let current;
+  let currentName;
   commandsMap.forEach((v, k) => {
-    if (arrayStartsWith(nameArr, k)) {
-      possibleCommands.push(v);
+    if (arrayStartsWith(nameArr, k) && (!currentName || k.length > currentName.length)) {
+      current = v;
+      currentName = k;
     }
   });
-  if (possibleCommands.length > 1) {
-    const matchedCommandNames = possibleCommands.map((c) => c.name).join(", ");
-    throw new MultipleCommandsMatchedError(matchedCommandNames);
-  }
-  return possibleCommands[0];
+  return current;
 }
 function resolveSubcommandsByParent(commands, parent, depth = Infinity) {
   const parentArr = parent === "" ? [] : Array.isArray(parent) ? parent : parent.split(" ");
@@ -147,6 +135,7 @@ function compose(inspectors) {
     }
   };
 }
+const isInvalidName = (name) => typeof name === "string" && (name.startsWith(" ") || name.endsWith(" "));
 
 const { stringify } = JSON;
 function parseParameters(parameters) {
@@ -275,6 +264,9 @@ const _Clerc = class {
         throw new CommandExistsError("SingleCommand");
       }
     }
+    if (isInvalidName(name)) {
+      throw new InvalidCommandNameError(name);
+    }
     if (__privateGet(this, _isSingleCommand, isSingleCommand_get)) {
       throw new SingleCommandError();
     }
@@ -284,21 +276,16 @@ const _Clerc = class {
     if (name === SingleCommand && (isCommandObject ? nameOrCommand : options).alias) {
       throw new SingleCommandAliasError();
     }
-    if (name !== SingleCommand) {
-      const splitedName = name.split(" ");
-      const existedCommandNames = Object.keys(__privateGet(this, _commands)).filter((name2) => typeof name2 === "string").map((name2) => name2.split(" "));
-      if (existedCommandNames.some((name2) => arrayStartsWith(splitedName, name2))) {
-        throw new ParentCommandExistsError(splitedName.join(" "));
-      }
-      if (existedCommandNames.some((name2) => arrayStartsWith(name2, splitedName))) {
-        throw new SubcommandExistsError(splitedName.join(" "));
+    const { handler = void 0, ...commandToSave } = isCommandObject ? nameOrCommand : { name, description, ...options };
+    const nameList = [commandToSave.name];
+    commandToSave.alias && nameList.push(...toArray(commandToSave.alias));
+    for (const name2 of nameList) {
+      if (Object.keys(__privateGet(this, _commands)).includes(name2) || Object.values(__privateGet(this, _commands)).some(({ alias }) => alias ? toArray(alias).includes(name2) : false)) {
+        throw new CommandExistsError(name2);
       }
     }
-    const { handler = void 0, ...commandToSave } = isCommandObject ? nameOrCommand : { name, description, ...options };
     __privateGet(this, _commands)[name] = commandToSave;
-    if (isCommandObject && handler) {
-      this.on(nameOrCommand.name, handler);
-    }
+    isCommandObject && handler && this.on(nameOrCommand.name, handler);
     return this;
   }
   on(name, handler) {
@@ -417,4 +404,4 @@ const defineHandler = (_cli, _key, handler) => handler;
 const defineInspector = (_cli, inspector) => inspector;
 const defineCommand = (command) => command;
 
-export { Clerc, CommandExistsError, CommandNameConflictError, CommonCommandExistsError, DescriptionNotSetError, MultipleCommandsMatchedError, NameNotSetError, NoCommandGivenError, NoSuchCommandError, ParentCommandExistsError, SingleCommand, SingleCommandAliasError, SingleCommandError, SubcommandExistsError, VersionNotSetError, compose, defineCommand, defineHandler, defineInspector, definePlugin, mapParametersToArguments, parseParameters, resolveArgv, resolveCommand, resolveFlattenCommands, resolveParametersBeforeFlag, resolveRootCommands, resolveSubcommandsByParent };
+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 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clerc/core",
-  "version": "0.17.2",
+  "version": "0.18.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.17.2"
+    "@clerc/utils": "0.18.0"
   },
   "scripts": {
     "build": "puild",