breadc 0.5.0 → 0.6.0

package/README.md

@@ -7,7 +7,7 @@ Yet another Command Line Application Framework powered by [minimist](https://www
 ## Features
 
 + ⚡️ **Light-weight**: Only 40 kB (Unpacked).
-+ 📖 **East to Learn**: Breadc is basically compatible with [cac](https://github.com/cacjs/cac) and there are only 4 APIs for building a CLI application: `command`, `option`, `action`, `run`.
++ 📖 **East to Learn**: Breadc is basically compatible with [cac](https://github.com/cacjs/cac) and there are only 5 APIs for building a CLI application: `Breadc`, `command`, `option`, `action`, `run`.
 + 💻 **TypeScript Infer**: IDE will automatically infer the type of your command action function.
 
 ## Installation

package/dist/index.cjs

@@ -79,8 +79,14 @@ const _Command = class {
     this.arguments = pieces.filter(isArg);
     this.description = config.description ?? "";
     this.logger = config.logger;
-    if (pieces.length > _Command.MaxDep) {
-      this.logger.warn(`Command format string "${format}" is too long`);
+    {
+      const restArgs = this.arguments.findIndex((a) => a.startsWith("[..."));
+      if (restArgs !== -1 && restArgs !== this.arguments.length - 1) {
+        this.logger.warn(`Expand arguments ${this.arguments[restArgs]} should be placed at the last position`);
+      }
+      if (pieces.length > _Command.MaxDep) {
+        this.logger.warn(`Command format string "${format}" is too long`);
+      }
     }
   }
   get isInternal() {
@@ -132,23 +138,30 @@ const _Command = class {
       return true;
     return false;
   }
-  parseArgs(args, globalOptions) {
-    const argumentss = [];
-    for (let i = 0; i < this.arguments.length; i++) {
-      if (i < args["_"].length) {
+  parseArgs(argv, globalOptions) {
+    const pieces = argv["_"];
+    const args = [];
+    const restArgs = [];
+    for (let i = 0, used = 0; i <= this.arguments.length; i++) {
+      if (i === this.arguments.length) {
+        restArgs.push(...pieces.slice(used).map(String));
+        restArgs.push(...(argv["--"] ?? []).map(String));
+      } else if (i < pieces.length) {
         if (this.arguments[i].startsWith("[...")) {
-          argumentss.push(args["_"].slice(i).map(String));
+          args.push(pieces.slice(i).map(String));
+          used = pieces.length;
         } else {
-          argumentss.push(String(args["_"][i]));
+          args.push(String(pieces[i]));
+          used++;
         }
       } else {
         if (this.arguments[i].startsWith("<")) {
           this.logger.warn(`You should provide the argument "${this.arguments[i]}"`);
-          argumentss.push("");
+          args.push("");
         } else if (this.arguments[i].startsWith("[...")) {
-          argumentss.push([]);
+          args.push([]);
         } else if (this.arguments[i].startsWith("[")) {
-          argumentss.push(void 0);
+          args.push(void 0);
         } else {
           this.logger.warn(`unknown format string ("${this.arguments[i]}")`);
         }
@@ -158,7 +171,7 @@ const _Command = class {
       map.set(o.name, o);
       return map;
     }, /* @__PURE__ */ new Map());
-    const options = args;
+    const options = argv;
     delete options["_"];
     for (const [name, rawOption] of fullOptions) {
       if (rawOption.required) {
@@ -190,8 +203,9 @@ const _Command = class {
     }
     return {
       command: this,
-      arguments: argumentss,
-      options
+      arguments: args,
+      options,
+      "--": restArgs
     };
   }
   action(fn) {
@@ -199,9 +213,13 @@ const _Command = class {
   }
   async run(...args) {
     if (this.actionFn) {
-      return await this.actionFn(...args, { logger: this.logger, color: kolorist__default });
+      return await this.actionFn(...args, {
+        logger: this.logger,
+        color: kolorist__default
+      });
     } else {
       this.logger.warn(`You may miss action function in ${this.format ? `"${this.format}"` : "<default command>"}`);
+      return void 0;
     }
   }
 };
@@ -220,7 +238,8 @@ class InternalCommand extends Command {
     return {
       command: this,
       arguments: argumentss,
-      options: args
+      options: args,
+      "--": []
     };
   }
 }
@@ -403,6 +422,7 @@ class Breadc {
       string: allowOptions.filter((o) => o.type === "string").map((o) => o.name),
       boolean: allowOptions.filter((o) => o.type === "boolean").map((o) => o.name).concat(["help", "version"]),
       alias,
+      "--": true,
       unknown: (t) => {
         if (t[0] !== "-")
           return true;
@@ -431,12 +451,14 @@ class Breadc {
     const argumentss = argv["_"];
     const options = argv;
     delete options["_"];
+    delete options["--"];
     delete options["help"];
     delete options["version"];
     return {
       command: void 0,
       arguments: argumentss,
-      options
+      options,
+      "--": []
     };
   }
   on(event, fn) {
@@ -446,9 +468,14 @@ class Breadc {
     const parsed = this.parse(args);
     if (parsed.command) {
       await Promise.all(this.callbacks.pre.map((fn) => fn(parsed.options)));
-      const returnValue = await parsed.command.run(...parsed.arguments, parsed.options);
+      const returnValue = await parsed.command.run(...parsed.arguments, {
+        "--": parsed["--"],
+        ...parsed.options
+      });
       await Promise.all(this.callbacks.post.map((fn) => fn(parsed.options)));
       return returnValue;
+    } else {
+      return void 0;
     }
   }
 }

package/dist/index.d.ts

@@ -59,7 +59,7 @@ declare class Command<F extends string = string, CommandOption extends object =
     option<OF extends string, T = undefined>(format: OF, config?: OptionConfig<OF, T>): Command<F, CommandOption & ExtractOption<OF, T>>;
     hasPrefix(parsedArgs: ParsedArgs): boolean;
     shouldRun(parsedArgs: ParsedArgs): boolean;
-    parseArgs(args: ParsedArgs, globalOptions: Option[]): ParseResult;
+    parseArgs(argv: ParsedArgs, globalOptions: Option[]): ParseResult;
     action(fn: ActionFn<ExtractCommand<F>, CommandOption>): void;
     run(...args: any[]): Promise<any>;
 }
@@ -82,6 +82,7 @@ interface ParseResult {
     command: Command | undefined;
     arguments: any[];
     options: Record<string, string>;
+    '--': string[];
 }
 declare type ExtractOption<T extends string, D = undefined> = {
     [k in ExtractOptionName<T>]: D extends undefined ? ExtractOptionType<T> : D;
@@ -103,7 +104,9 @@ declare type Context = {
     logger: Logger;
     color: typeof kolorist;
 };
-declare type ActionFn<T extends any[], Option extends object = {}, R = any> = (...arg: Push<T, Option, Context>) => R | Promise<R>;
+declare type ActionFn<T extends any[], Option extends object = {}, R = any> = (...arg: Push<T, Option & {
+    '--': string[];
+}, Context>) => R | Promise<R>;
 /**
  * Max Dep: 5
  *
@@ -129,7 +132,7 @@ declare class Breadc<GlobalOption extends object = {}> {
     parse(args: string[]): ParseResult;
     private readonly callbacks;
     on(event: 'pre' | 'post', fn: (option: GlobalOption) => void | Promise<void>): void;
-    run(args: string[]): Promise<any>;
+    run<T>(args: string[]): Promise<T | undefined>;
 }
 
 declare function breadc(name: string, option?: AppOption): Breadc<{}>;

package/dist/index.mjs

@@ -72,8 +72,14 @@ const _Command = class {
     this.arguments = pieces.filter(isArg);
     this.description = config.description ?? "";
     this.logger = config.logger;
-    if (pieces.length > _Command.MaxDep) {
-      this.logger.warn(`Command format string "${format}" is too long`);
+    {
+      const restArgs = this.arguments.findIndex((a) => a.startsWith("[..."));
+      if (restArgs !== -1 && restArgs !== this.arguments.length - 1) {
+        this.logger.warn(`Expand arguments ${this.arguments[restArgs]} should be placed at the last position`);
+      }
+      if (pieces.length > _Command.MaxDep) {
+        this.logger.warn(`Command format string "${format}" is too long`);
+      }
     }
   }
   get isInternal() {
@@ -125,23 +131,30 @@ const _Command = class {
       return true;
     return false;
   }
-  parseArgs(args, globalOptions) {
-    const argumentss = [];
-    for (let i = 0; i < this.arguments.length; i++) {
-      if (i < args["_"].length) {
+  parseArgs(argv, globalOptions) {
+    const pieces = argv["_"];
+    const args = [];
+    const restArgs = [];
+    for (let i = 0, used = 0; i <= this.arguments.length; i++) {
+      if (i === this.arguments.length) {
+        restArgs.push(...pieces.slice(used).map(String));
+        restArgs.push(...(argv["--"] ?? []).map(String));
+      } else if (i < pieces.length) {
         if (this.arguments[i].startsWith("[...")) {
-          argumentss.push(args["_"].slice(i).map(String));
+          args.push(pieces.slice(i).map(String));
+          used = pieces.length;
         } else {
-          argumentss.push(String(args["_"][i]));
+          args.push(String(pieces[i]));
+          used++;
         }
       } else {
         if (this.arguments[i].startsWith("<")) {
           this.logger.warn(`You should provide the argument "${this.arguments[i]}"`);
-          argumentss.push("");
+          args.push("");
         } else if (this.arguments[i].startsWith("[...")) {
-          argumentss.push([]);
+          args.push([]);
         } else if (this.arguments[i].startsWith("[")) {
-          argumentss.push(void 0);
+          args.push(void 0);
         } else {
           this.logger.warn(`unknown format string ("${this.arguments[i]}")`);
         }
@@ -151,7 +164,7 @@ const _Command = class {
       map.set(o.name, o);
       return map;
     }, /* @__PURE__ */ new Map());
-    const options = args;
+    const options = argv;
     delete options["_"];
     for (const [name, rawOption] of fullOptions) {
       if (rawOption.required) {
@@ -183,8 +196,9 @@ const _Command = class {
     }
     return {
       command: this,
-      arguments: argumentss,
-      options
+      arguments: args,
+      options,
+      "--": restArgs
     };
   }
   action(fn) {
@@ -192,9 +206,13 @@ const _Command = class {
   }
   async run(...args) {
     if (this.actionFn) {
-      return await this.actionFn(...args, { logger: this.logger, color: kolorist });
+      return await this.actionFn(...args, {
+        logger: this.logger,
+        color: kolorist
+      });
     } else {
       this.logger.warn(`You may miss action function in ${this.format ? `"${this.format}"` : "<default command>"}`);
+      return void 0;
     }
   }
 };
@@ -213,7 +231,8 @@ class InternalCommand extends Command {
     return {
       command: this,
       arguments: argumentss,
-      options: args
+      options: args,
+      "--": []
     };
   }
 }
@@ -396,6 +415,7 @@ class Breadc {
       string: allowOptions.filter((o) => o.type === "string").map((o) => o.name),
       boolean: allowOptions.filter((o) => o.type === "boolean").map((o) => o.name).concat(["help", "version"]),
       alias,
+      "--": true,
       unknown: (t) => {
         if (t[0] !== "-")
           return true;
@@ -424,12 +444,14 @@ class Breadc {
     const argumentss = argv["_"];
     const options = argv;
     delete options["_"];
+    delete options["--"];
     delete options["help"];
     delete options["version"];
     return {
       command: void 0,
       arguments: argumentss,
-      options
+      options,
+      "--": []
     };
   }
   on(event, fn) {
@@ -439,9 +461,14 @@ class Breadc {
     const parsed = this.parse(args);
     if (parsed.command) {
       await Promise.all(this.callbacks.pre.map((fn) => fn(parsed.options)));
-      const returnValue = await parsed.command.run(...parsed.arguments, parsed.options);
+      const returnValue = await parsed.command.run(...parsed.arguments, {
+        "--": parsed["--"],
+        ...parsed.options
+      });
       await Promise.all(this.callbacks.post.map((fn) => fn(parsed.options)));
       return returnValue;
+    } else {
+      return void 0;
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "breadc",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "Yet another Command Line Application Framework with fully strong TypeScript support",
   "keywords": [
     "cli",
@@ -44,8 +44,8 @@
     "prettier": "^2.7.1",
     "typescript": "^4.7.4",
     "unbuild": "^0.7.6",
-    "vite": "^3.0.2",
-    "vitest": "^0.18.1"
+    "vite": "^3.0.3",
+    "vitest": "^0.19.1"
   },
   "packageManager": "pnpm@7.5.2",
   "scripts": {