breadc 0.6.2 → 0.6.5

package/dist/index.cjs

@@ -5,8 +5,20 @@ const kolorist = require('kolorist');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e["default"] : e; }
 
+function _interopNamespace(e) {
+  if (e && e.__esModule) return e;
+  const n = Object.create(null);
+  if (e) {
+    for (const k in e) {
+      n[k] = e[k];
+    }
+  }
+  n["default"] = e;
+  return n;
+}
+
 const minimist__default = /*#__PURE__*/_interopDefaultLegacy(minimist);
-const kolorist__default = /*#__PURE__*/_interopDefaultLegacy(kolorist);
+const kolorist__namespace = /*#__PURE__*/_interopNamespace(kolorist);
 
 function twoColumn(texts, split = "  ") {
   const left = padRight(texts.map((t) => t[0]));
@@ -82,7 +94,9 @@ const _Command = class {
     {
       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`);
+        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`);
@@ -156,7 +170,9 @@ const _Command = class {
         }
       } else {
         if (this.arguments[i].startsWith("<")) {
-          this.logger.warn(`You should provide the argument "${this.arguments[i]}"`);
+          this.logger.warn(
+            `You should provide the argument "${this.arguments[i]}"`
+          );
           args.push("");
         } else if (this.arguments[i].startsWith("[...")) {
           args.push([]);
@@ -174,6 +190,8 @@ const _Command = class {
     const options = argv;
     delete options["_"];
     for (const [name, rawOption] of fullOptions) {
+      if (rawOption.type === "boolean")
+        continue;
       if (rawOption.required) {
         if (options[name] === void 0) {
           options[name] = false;
@@ -187,13 +205,12 @@ const _Command = class {
           options[name] = void 0;
         }
       }
-      if (rawOption.default !== void 0) {
-        if (options[name] === void 0 || options[name] === false) {
-          options[name] = rawOption.default;
-        }
-      }
       if (rawOption.construct !== void 0) {
         options[name] = rawOption.construct(options[name]);
+      } else if (rawOption.default !== void 0) {
+        if (options[name] === void 0 || options[name] === false || options[name] === "") {
+          options[name] = rawOption.default;
+        }
       }
     }
     for (const key of Object.keys(options)) {
@@ -215,10 +232,12 @@ const _Command = class {
     if (this.actionFn) {
       return await this.actionFn(...args, {
         logger: this.logger,
-        color: kolorist__default
+        color: kolorist__namespace
       });
     } else {
-      this.logger.warn(`You may miss action function in ${this.format ? `"${this.format}"` : "<default command>"}`);
+      this.logger.warn(
+        `You may miss action function in ${this.format ? `"${this.format}"` : "<default command>"}`
+      );
       return void 0;
     }
   }
@@ -314,7 +333,10 @@ class Breadc {
     this._version = option.version ?? "unknown";
     this.description = option.description;
     this.logger = createDefaultLogger(name, option.logger);
-    this.commands.push(new VersionCommand(this.version(), this.logger), new HelpCommand(this.commands, this.help.bind(this), this.logger));
+    this.commands.push(
+      new VersionCommand(this.version(), this.logger),
+      new HelpCommand(this.commands, this.help.bind(this), this.logger)
+    );
   }
   version() {
     return `${this.name}/${this._version}`;
@@ -350,10 +372,14 @@ class Breadc {
       println(`  $ ${this.name} ${command.format}`);
     }
     if (commands.length !== 1) {
-      const cmdList = (commands.length === 0 ? this.commands : commands).filter((c) => !c.isInternal);
+      const cmdList = (commands.length === 0 ? this.commands : commands).filter(
+        (c) => !c.isInternal
+      );
       println(``);
       println(`Commands:`);
-      const commandHelps = cmdList.map((c) => [`  $ ${this.name} ${c.format}`, c.description]);
+      const commandHelps = cmdList.map(
+        (c) => [`  $ ${this.name} ${c.format}`, c.description]
+      );
       for (const line of twoColumn(commandHelps)) {
         println(line);
       }
@@ -361,8 +387,14 @@ class Breadc {
     println(``);
     println(`Options:`);
     const optionHelps = [].concat([
-      ...commands.length > 0 ? commands.flatMap((cmd) => cmd.options.map((o) => [`  ${o.format}`, o.description])) : [],
-      ...this.options.map((o) => [`  ${o.format}`, o.description]),
+      ...commands.length > 0 ? commands.flatMap(
+        (cmd) => cmd.options.map(
+          (o) => [`  ${o.format}`, o.description]
+        )
+      ) : [],
+      ...this.options.map(
+        (o) => [`  ${o.format}`, o.description]
+      ),
       [`  -h, --help`, `Display this message`],
       [`  -v, --version`, `Display version number`]
     ]);
@@ -412,15 +444,25 @@ class Breadc {
         }
       }
     }
-    const alias = allowOptions.reduce((map, o) => {
-      if (o.shortcut) {
-        map[o.shortcut] = o.name;
-      }
+    const alias = allowOptions.reduce(
+      (map, o) => {
+        if (o.shortcut) {
+          map[o.shortcut] = o.name;
+        }
+        return map;
+      },
+      { h: "help", v: "version" }
+    );
+    const defaultValue = allowOptions.filter(
+      (o) => o.type === "boolean" && o.default !== void 0 && o.default !== null && typeof o.default === "boolean"
+    ).reduce((map, o) => {
+      map[o.name] = o.default;
       return map;
-    }, { h: "help", v: "version" });
+    }, {});
     const argv = minimist__default(args, {
       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"]),
+      default: defaultValue,
       alias,
       "--": true,
       unknown: (t) => {
@@ -467,12 +509,16 @@ class Breadc {
   async run(args) {
     const parsed = this.parse(args);
     if (parsed.command) {
-      await Promise.all(this.callbacks.pre.map((fn) => fn(parsed.options)));
+      await Promise.all(
+        this.callbacks.pre.map((fn) => fn(parsed.options))
+      );
       const returnValue = await parsed.command.run(...parsed.arguments, {
         "--": parsed["--"],
         ...parsed.options
       });
-      await Promise.all(this.callbacks.post.map((fn) => fn(parsed.options)));
+      await Promise.all(
+        this.callbacks.post.map((fn) => fn(parsed.options))
+      );
       return returnValue;
     } else {
       return void 0;

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import kolorist from 'kolorist';
 import { ParsedArgs } from 'minimist';
 
-interface OptionConfig<F extends string, T = never> {
+interface OptionConfig<F extends string, T = never, O = ExtractOptionType<F>> {
     /**
      * Option description
      */
@@ -9,7 +9,7 @@ interface OptionConfig<F extends string, T = never> {
     /**
      * Option string default value
      */
-    default?: string;
+    default?: O extends boolean ? boolean : string;
     /**
      * Transform option text
      */
@@ -24,17 +24,17 @@ interface OptionConfig<F extends string, T = never> {
  * + --option <arg>
  * + --option [arg]
  */
-declare class Option<T extends string = string, F = string> {
+declare class Option<F extends string = string, T = string, O = ExtractOptionType<F>> {
     private static OptionRE;
     readonly name: string;
     readonly shortcut?: string;
-    readonly default?: string;
+    readonly default?: O extends boolean ? boolean : string;
     readonly format: string;
     readonly description: string;
     readonly type: 'string' | 'boolean';
     readonly required: boolean;
-    readonly construct?: (rawText: ExtractOptionType<T>) => F;
-    constructor(format: T, config?: OptionConfig<T, F>);
+    readonly construct?: (rawText: ExtractOptionType<F>) => T;
+    constructor(format: F, config?: OptionConfig<F, T, O>);
 }
 
 interface CommandConfig {

package/dist/index.mjs

@@ -1,5 +1,6 @@
 import minimist from 'minimist';
-import kolorist, { blue, yellow, red, gray } from 'kolorist';
+import * as kolorist from 'kolorist';
+import { blue, yellow, red, gray } from 'kolorist';
 
 function twoColumn(texts, split = "  ") {
   const left = padRight(texts.map((t) => t[0]));
@@ -75,7 +76,9 @@ const _Command = class {
     {
       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`);
+        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`);
@@ -149,7 +152,9 @@ const _Command = class {
         }
       } else {
         if (this.arguments[i].startsWith("<")) {
-          this.logger.warn(`You should provide the argument "${this.arguments[i]}"`);
+          this.logger.warn(
+            `You should provide the argument "${this.arguments[i]}"`
+          );
           args.push("");
         } else if (this.arguments[i].startsWith("[...")) {
           args.push([]);
@@ -167,6 +172,8 @@ const _Command = class {
     const options = argv;
     delete options["_"];
     for (const [name, rawOption] of fullOptions) {
+      if (rawOption.type === "boolean")
+        continue;
       if (rawOption.required) {
         if (options[name] === void 0) {
           options[name] = false;
@@ -180,13 +187,12 @@ const _Command = class {
           options[name] = void 0;
         }
       }
-      if (rawOption.default !== void 0) {
-        if (options[name] === void 0 || options[name] === false) {
-          options[name] = rawOption.default;
-        }
-      }
       if (rawOption.construct !== void 0) {
         options[name] = rawOption.construct(options[name]);
+      } else if (rawOption.default !== void 0) {
+        if (options[name] === void 0 || options[name] === false || options[name] === "") {
+          options[name] = rawOption.default;
+        }
       }
     }
     for (const key of Object.keys(options)) {
@@ -211,7 +217,9 @@ const _Command = class {
         color: kolorist
       });
     } else {
-      this.logger.warn(`You may miss action function in ${this.format ? `"${this.format}"` : "<default command>"}`);
+      this.logger.warn(
+        `You may miss action function in ${this.format ? `"${this.format}"` : "<default command>"}`
+      );
       return void 0;
     }
   }
@@ -307,7 +315,10 @@ class Breadc {
     this._version = option.version ?? "unknown";
     this.description = option.description;
     this.logger = createDefaultLogger(name, option.logger);
-    this.commands.push(new VersionCommand(this.version(), this.logger), new HelpCommand(this.commands, this.help.bind(this), this.logger));
+    this.commands.push(
+      new VersionCommand(this.version(), this.logger),
+      new HelpCommand(this.commands, this.help.bind(this), this.logger)
+    );
   }
   version() {
     return `${this.name}/${this._version}`;
@@ -343,10 +354,14 @@ class Breadc {
       println(`  $ ${this.name} ${command.format}`);
     }
     if (commands.length !== 1) {
-      const cmdList = (commands.length === 0 ? this.commands : commands).filter((c) => !c.isInternal);
+      const cmdList = (commands.length === 0 ? this.commands : commands).filter(
+        (c) => !c.isInternal
+      );
       println(``);
       println(`Commands:`);
-      const commandHelps = cmdList.map((c) => [`  $ ${this.name} ${c.format}`, c.description]);
+      const commandHelps = cmdList.map(
+        (c) => [`  $ ${this.name} ${c.format}`, c.description]
+      );
       for (const line of twoColumn(commandHelps)) {
         println(line);
       }
@@ -354,8 +369,14 @@ class Breadc {
     println(``);
     println(`Options:`);
     const optionHelps = [].concat([
-      ...commands.length > 0 ? commands.flatMap((cmd) => cmd.options.map((o) => [`  ${o.format}`, o.description])) : [],
-      ...this.options.map((o) => [`  ${o.format}`, o.description]),
+      ...commands.length > 0 ? commands.flatMap(
+        (cmd) => cmd.options.map(
+          (o) => [`  ${o.format}`, o.description]
+        )
+      ) : [],
+      ...this.options.map(
+        (o) => [`  ${o.format}`, o.description]
+      ),
       [`  -h, --help`, `Display this message`],
       [`  -v, --version`, `Display version number`]
     ]);
@@ -405,15 +426,25 @@ class Breadc {
         }
       }
     }
-    const alias = allowOptions.reduce((map, o) => {
-      if (o.shortcut) {
-        map[o.shortcut] = o.name;
-      }
+    const alias = allowOptions.reduce(
+      (map, o) => {
+        if (o.shortcut) {
+          map[o.shortcut] = o.name;
+        }
+        return map;
+      },
+      { h: "help", v: "version" }
+    );
+    const defaultValue = allowOptions.filter(
+      (o) => o.type === "boolean" && o.default !== void 0 && o.default !== null && typeof o.default === "boolean"
+    ).reduce((map, o) => {
+      map[o.name] = o.default;
       return map;
-    }, { h: "help", v: "version" });
+    }, {});
     const argv = minimist(args, {
       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"]),
+      default: defaultValue,
       alias,
       "--": true,
       unknown: (t) => {
@@ -460,12 +491,16 @@ class Breadc {
   async run(args) {
     const parsed = this.parse(args);
     if (parsed.command) {
-      await Promise.all(this.callbacks.pre.map((fn) => fn(parsed.options)));
+      await Promise.all(
+        this.callbacks.pre.map((fn) => fn(parsed.options))
+      );
       const returnValue = await parsed.command.run(...parsed.arguments, {
         "--": parsed["--"],
         ...parsed.options
       });
-      await Promise.all(this.callbacks.post.map((fn) => fn(parsed.options)));
+      await Promise.all(
+        this.callbacks.post.map((fn) => fn(parsed.options))
+      );
       return returnValue;
     } else {
       return void 0;

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "breadc",
-  "version": "0.6.2",
+  "version": "0.6.5",
   "description": "Yet another Command Line Application Framework with fully strong TypeScript support",
   "keywords": [
+    "breadc",
     "cli",
     "framework",
     "command-line",
@@ -34,26 +35,29 @@
     "dist"
   ],
   "dependencies": {
-    "kolorist": "^1.5.1",
+    "kolorist": "^1.6.0",
     "minimist": "^1.2.6"
   },
   "devDependencies": {
     "@types/minimist": "^1.2.2",
     "@types/node": "^18.0.0",
-    "bumpp": "^8.2.1",
+    "cac": "^6.7.14",
     "prettier": "^2.7.1",
-    "typescript": "^4.7.4",
-    "unbuild": "^0.7.6",
-    "vite": "^3.0.4",
-    "vitest": "^0.19.1"
+    "typescript": "^4.8.3",
+    "unbuild": "^0.8.10",
+    "vite": "^3.1.0",
+    "vitest": "^0.23.2"
   },
   "packageManager": "pnpm@7.5.2",
   "scripts": {
     "build": "unbuild",
+    "build:all": "unbuild && pnpm -r build",
     "format": "prettier --write src/**/*.ts test/*.ts examples/*.ts",
-    "release": "bumpp --commit --push --tag && pnpm publish",
+    "release": "bumpp package.json packages/*/package.json --commit --push --tag && pnpm publish && pnpm -r publish --access public",
     "test": "vitest",
+    "test:bench": "vitest bench",
     "typecheck": "tsc --noEmit",
-    "preversion": "pnpm typecheck && pnpm build"
+    "typecheck:all": "tsc --noEmit && pnpm -r typecheck",
+    "preversion": "pnpm typecheck:all && pnpm build:all"
   }
 }