✨ feat(core)!: disallow users to add commands in inspectors; remove limit of commands must before flags

Author: so1ve

packages/core/src/cli.ts

@@ -40,7 +40,7 @@ import {
   isValidName,
   resolveArgv,
   resolveCommand,
-  resolveParametersBeforeFlag,
+  stripFlags,
 } from "./utils";
 import { mapParametersToArguments, parseParameters } from "./parameters";
 import { locales } from "./locales";
@@ -76,30 +76,30 @@ export class Clerc<C extends Commands = {}> {
     },
   };
 
-  private constructor (name?: string, description?: string, version?: string) {
+  private constructor(name?: string, description?: string, version?: string) {
     this.#name = name || this.#name;
     this.#description = description || this.#description;
     this.#version = version || this.#version;
     this.#locale = detectLocale();
     this.#addCoreLocales();
   }
 
-  get #hasRootOrAlias () {
+  get #hasRootOrAlias() {
     return this.#usedNames.has(Root);
   }
 
-  get #hasRoot () {
+  get #hasRoot() {
     return Object.prototype.hasOwnProperty.call(this._commands, Root);
   }
 
-  get _name () { return this.#name; }
-  get _description () { return this.#description; }
-  get _version () { return this.#version; }
-  get _inspectors () { return this.#inspectors; }
-  get _commands () { return this.#commands; }
+  get _name() { return this.#name; }
+  get _description() { return this.#description; }
+  get _version() { return this.#version; }
+  get _inspectors() { return this.#inspectors; }
+  get _commands() { return this.#commands; }
 
-  #addCoreLocales () { this.i18n.add(locales); }
-  #otherMethodCaled () { this.#isOtherMethodCalled = true; }
+  #addCoreLocales() { this.i18n.add(locales); }
+  #otherMethodCaled() { this.#isOtherMethodCalled = true; }
 
   /**
    * Create a new cli
@@ -109,7 +109,7 @@ export class Clerc<C extends Commands = {}> {
    * const cli = Clerc.create()
    * ```
    */
-  static create (name?: string, description?: string, version?: string) {
+  static create(name?: string, description?: string, version?: string) {
     return new Clerc(name, description, version);
   }
 
@@ -123,7 +123,7 @@ export class Clerc<C extends Commands = {}> {
    *   .name("test")
    * ```
    */
-  name (name: string) {
+  name(name: string) {
     this.#otherMethodCaled();
     this.#name = name;
     return this;
@@ -139,7 +139,7 @@ export class Clerc<C extends Commands = {}> {
    *   .description("test cli")
    * ```
    */
-  description (description: string) {
+  description(description: string) {
     this.#otherMethodCaled();
     this.#description = description;
     return this;
@@ -155,7 +155,7 @@ export class Clerc<C extends Commands = {}> {
    *   .version("1.0.0")
    * ```
    */
-  version (version: string) {
+  version(version: string) {
     this.#otherMethodCaled();
     this.#version = version;
     return this;
@@ -173,7 +173,7 @@ export class Clerc<C extends Commands = {}> {
    *   .command(...)
    * ```
    */
-  locale (locale: string) {
+  locale(locale: string) {
     if (this.#isOtherMethodCalled) { throw new LocaleNotCalledFirstError(this.i18n.t); }
     this.#locale = locale;
     return this;
@@ -191,7 +191,7 @@ export class Clerc<C extends Commands = {}> {
    *   .command(...)
    * ```
    */
-  fallbackLocale (fallbackLocale: string) {
+  fallbackLocale(fallbackLocale: string) {
     if (this.#isOtherMethodCalled) { throw new LocaleNotCalledFirstError(this.i18n.t); }
     this.#defaultLocale = fallbackLocale;
     return this;
@@ -207,7 +207,7 @@ export class Clerc<C extends Commands = {}> {
    *   .errorHandler((err) => { console.log(err); })
    * ```
    */
-  errorHandler (handler: (err: any) => void) {
+  errorHandler(handler: (err: any) => void) {
     this.#errorHandlers.push(handler);
     return this;
   }
@@ -246,12 +246,12 @@ export class Clerc<C extends Commands = {}> {
    */
   command<N extends string | RootType, O extends CommandOptions<[...P], A, F>, P extends string[] = string[], A extends MaybeArray<string | RootType> = MaybeArray<string | RootType>, F extends Flags = Flags>(c: CommandWithHandler<N, O & CommandOptions<[...P], A, F>>): this & Clerc<C & Record<N, Command<N, O>>>;
   command<N extends string | RootType, O extends CommandOptions<[...P], A, F>, P extends string[] = string[], A extends MaybeArray<string | RootType> = MaybeArray<string | RootType>, F extends Flags = Flags>(name: N, description: string, options?: O & CommandOptions<[...P], A, F>): this & Clerc<C & Record<N, Command<N, O>>>;
-  command (nameOrCommand: any, description?: any, options: any = {}) {
+  command(nameOrCommand: any, description?: any, options: any = {}) {
     this.#callWithErrorHandling(() => this.#command(nameOrCommand, description, options));
     return this;
   }
 
-  #command (nameOrCommand: any, description?: any, options: any = {}) {
+  #command(nameOrCommand: any, description?: any, options: any = {}) {
     this.#otherMethodCaled();
     const { t } = this.i18n;
     const checkIsCommandObject = (nameOrCommand: any): nameOrCommand is CommandWithHandler => !(typeof nameOrCommand === "string" || nameOrCommand === Root);
@@ -329,7 +329,7 @@ export class Clerc<C extends Commands = {}> {
    *   })
    * ```
    */
-  inspector (inspector: Inspector) {
+  inspector(inspector: Inspector) {
     this.#otherMethodCaled();
     this.#inspectors.push(inspector);
     return this;
@@ -345,7 +345,7 @@ export class Clerc<C extends Commands = {}> {
    *   .parse(process.argv.slice(2)) // Optional
    * ```
    */
-  parse (optionsOrArgv: string[] | ParseOptions = resolveArgv()) {
+  parse(optionsOrArgv: string[] | ParseOptions = resolveArgv()) {
     this.#otherMethodCaled();
     const { argv, run }: ParseOptions = Array.isArray(optionsOrArgv)
       ? {
@@ -364,7 +364,7 @@ export class Clerc<C extends Commands = {}> {
     return this;
   }
 
-  #validateMeta () {
+  #validateMeta() {
     const { t } = this.i18n;
     if (!this.#name) {
       throw new NameNotSetError(t);
@@ -377,7 +377,7 @@ export class Clerc<C extends Commands = {}> {
     }
   }
 
-  #getContext (getCommand: () => ReturnType<typeof resolveCommand>) {
+  #getContext(getCommand: () => ReturnType<typeof resolveCommand>) {
     const argv = this.#argv!;
     const { t } = this.i18n;
     const [command, called] = getCommand();
@@ -433,7 +433,7 @@ export class Clerc<C extends Commands = {}> {
     return context;
   }
 
-  #callWithErrorHandling (fn: () => void) {
+  #callWithErrorHandling(fn: () => void) {
     try {
       fn();
     } catch (e) {
@@ -445,22 +445,21 @@ export class Clerc<C extends Commands = {}> {
     }
   }
 
-  #runMatchedCommand () {
+  #runMatchedCommand() {
     this.#otherMethodCaled();
     const { t } = this.i18n;
     const argv = this.#argv;
     if (!argv) {
       throw new Error(t("core.cliParseMustBeCalled"));
     }
-    const name = resolveParametersBeforeFlag(argv);
-    const stringName = name.join(" ");
-    const getCommand = () => resolveCommand(this.#commands, name, t);
+    const getCommand = () => resolveCommand(this.#commands, argv!, t);
     const getContext = () => this.#getContext(getCommand);
     const emitHandler: Inspector = {
       enforce: "post",
       fn: () => {
         const [command] = getCommand();
         const handlerContext = getContext();
+        const stringName = stripFlags(argv).join(" ");
         if (!command) {
           if (stringName) {
             throw new NoSuchCommandError(stringName, t);
@@ -473,7 +472,7 @@ export class Clerc<C extends Commands = {}> {
     };
     const inspectors = [...this.#inspectors, emitHandler];
     const callInspector = compose(inspectors);
-    callInspector(getContext);
+    callInspector(getContext());
   }
 
   /**
@@ -486,7 +485,7 @@ export class Clerc<C extends Commands = {}> {
    *   .runMatchedCommand()
    * ```
    */
-  runMatchedCommand () {
+  runMatchedCommand() {
     this.#callWithErrorHandling(() => this.#runMatchedCommand());
     process.title = this.#name;
     return this;

packages/core/src/utils.ts

@@ -1,12 +1,13 @@
-import { IS_DENO, IS_ELECTRON, IS_NODE } from "is-platform";
 import { arrayEquals, arrayStartsWith, toArray } from "@clerc/utils";
+import { IS_DENO, IS_ELECTRON, IS_NODE } from "is-platform";
+import { typeFlag } from "type-flag";
 
 import type { RootType } from "./cli";
 import { Root } from "./cli";
 import type { Command, CommandAlias, CommandType, Commands, Inspector, InspectorContext, InspectorFn, InspectorObject, TranslateFn } from "./types";
 import { CommandNameConflictError } from "./errors";
 
-function setCommand (commandsMap: Map<string[] | RootType, CommandAlias>, commands: Commands, command: Command, t: TranslateFn) {
+function setCommand(commandsMap: Map<string[] | RootType, CommandAlias>, commands: Commands, command: Command, t: TranslateFn) {
   if (command.alias) {
     const aliases = toArray(command.alias);
     for (const alias of aliases) {
@@ -18,7 +19,7 @@ function setCommand (commandsMap: Map<string[] | RootType, CommandAlias>, comman
   }
 }
 
-export function resolveFlattenCommands (commands: Commands, t: TranslateFn) {
+export function resolveFlattenCommands(commands: Commands, t: TranslateFn) {
   const commandsMap = new Map<string[] | RootType, CommandAlias>();
   if (commands[Root]) {
     commandsMap.set(Root, commands[Root]);
@@ -31,27 +32,23 @@ export function resolveFlattenCommands (commands: Commands, t: TranslateFn) {
   return commandsMap;
 }
 
-export function resolveCommand (commands: Commands, name: CommandType | string[], t: TranslateFn): [Command<string | RootType> | undefined, string[] | RootType | undefined] {
-  if (name === Root) { return [commands[Root], Root]; }
-  const nameArr = toArray(name) as string[];
+export function resolveCommand(commands: Commands, argv: string[], t: TranslateFn): [Command<string | RootType> | undefined, string[] | RootType | undefined] {
   const commandsMap = resolveFlattenCommands(commands, t);
-  let current: Command | undefined;
-  let currentName: string[] | RootType | undefined;
-  commandsMap.forEach((v, k) => {
-    if (k === Root) {
-      current = commands[Root];
-      currentName = Root;
-      return;
-    }
-    if (arrayStartsWith(nameArr, k) && (!currentName || currentName === Root || k.length > currentName.length)) {
-      current = v;
-      currentName = k;
+  for (const [name, command] of commandsMap.entries()) {
+    const parsed = typeFlag(command?.flags || {}, [...argv]);
+    const { _: args } = parsed;
+    if (name === Root) { continue; }
+    if (arrayStartsWith(args, name)) {
+      return [command, name];
     }
-  });
-  return [current, currentName];
+  }
+  if (commandsMap.has(Root)) {
+    return [commandsMap.get(Root)!, Root];
+  }
+  return [undefined, undefined];
 }
 
-export function resolveCommandStrict (commands: Commands, name: CommandType | string[], t: TranslateFn): [Command<string | RootType> | undefined, string[] | RootType | undefined] {
+export function resolveCommandStrict(commands: Commands, name: CommandType | string[], t: TranslateFn): [Command<string | RootType> | undefined, string[] | RootType | undefined] {
   if (name === Root) { return [commands[Root], Root]; }
   const nameArr = toArray(name) as string[];
   const commandsMap = resolveFlattenCommands(commands, t);
@@ -69,7 +66,7 @@ export function resolveCommandStrict (commands: Commands, name: CommandType | st
   return [current, currentName];
 }
 
-export function resolveSubcommandsByParent (commands: Commands, parent: string | string[], depth = Infinity) {
+export function resolveSubcommandsByParent(commands: Commands, parent: string | string[], depth = Infinity) {
   const parentArr = parent === ""
     ? []
     : Array.isArray(parent)
@@ -84,17 +81,6 @@ export function resolveSubcommandsByParent (commands: Commands, parent: string |
 
 export const resolveRootCommands = (commands: Commands) => resolveSubcommandsByParent(commands, "", 1);
 
-export function resolveParametersBeforeFlag (argv: string[]) {
-  const parameters = [];
-  for (const arg of argv) {
-    if (arg.startsWith("-")) {
-      break;
-    }
-    parameters.push(arg);
-  }
-  return parameters;
-}
-
 export const resolveArgv = (): string[] =>
   IS_NODE
     ? process.argv.slice(IS_ELECTRON ? 1 : 2)
@@ -103,7 +89,7 @@ export const resolveArgv = (): string[] =>
       ? Deno.args
       : [];
 
-export function compose (inspectors: Inspector[]) {
+export function compose(inspectors: Inspector[]) {
   const inspectorMap = {
     pre: [] as InspectorFn[],
     normal: [] as InspectorFn[],
@@ -127,13 +113,13 @@ export function compose (inspectors: Inspector[]) {
     ...inspectorMap.post,
   ];
 
-  return (getCtx: () => InspectorContext) => {
+  return (ctx: InspectorContext) => {
     const callbacks: (() => void)[] = [];
     let called = 0;
     const dispatch = (i: number) => {
       called = i;
       const inspector = mergedInspectorFns[i];
-      const cb = inspector(getCtx(), dispatch.bind(null, i + 1));
+      const cb = inspector(ctx, dispatch.bind(null, i + 1));
       if (cb) {
         callbacks.push(cb);
       }
@@ -165,3 +151,5 @@ export const formatCommandName = (name: string | string[] | RootType) => Array.i
 export const detectLocale = () => process.env.CLERC_LOCALE
   ? process.env.CLERC_LOCALE
   : Intl.DateTimeFormat().resolvedOptions().locale;
+
+export const stripFlags = (argv: string[]) => argv.filter(arg => !arg.startsWith("-"));