breadc 0.3.0 → 0.4.0

package/README.md

@@ -4,6 +4,12 @@
 
 Yet another Command Line Application Framework powered by [minimist](https://www.npmjs.com/package/minimist), but with fully strong [TypeScript](https://www.typescriptlang.org/) support.
 
+## Features
+
++ ⚡️ **Light-weight**: Only 61 kB.
++ 📖 **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`.
++ 💻 **TypeScript Infer**: IDE will automatically infer the type of your command action function.
+
 ## Installation
 
 ```bash
@@ -18,11 +24,11 @@ Try [./examples/echo.ts](./examples/echo.ts).
 import Breadc from 'breadc'
 
 const cli = Breadc('echo', { version: '1.0.0' })
-  .option('--host <host>')
-  .option('--port <port>')
+  .option('--host <host>', { default: 'localhost' })
+  .option('--port <port>', { construct: (port) => (port ? +port : 3000) });
 
 cli
-  .command('[message]')
+  .command('[message]', 'Say something!')
   .action((message, option) => {
     const host = option.host;
     const port = option.port;

package/dist/index.cjs

@@ -303,7 +303,7 @@ const _Option = class {
     this.description = config.description ?? "";
     this.required = format.indexOf("<") !== -1;
     this.default = config.default;
-    this.construct = config.construct ?? ((text) => text ?? config.default ?? void 0);
+    this.construct = config.construct;
   }
 };
 let Option = _Option;
@@ -407,6 +407,13 @@ const _Command = class {
           options[name] = void 0;
         }
       }
+      if (rawOption.construct) {
+        options[name] = rawOption.construct(options[name]);
+      } else if (rawOption.default) {
+        if (!options[name]) {
+          options[name] = rawOption.default;
+        }
+      }
     }
     return {
       command: this,
@@ -580,17 +587,10 @@ class Breadc {
       }
       return map;
     }, {});
-    const defaults = allowOptions.reduce((map, o) => {
-      if (o.default) {
-        map[o.name] = o.default;
-      }
-      return map;
-    }, {});
     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),
       alias,
-      default: defaults,
       unknown: (t) => {
         if (t[0] !== "-")
           return true;

package/dist/index.d.ts

@@ -250,10 +250,10 @@ function isConstructorOrProto (obj, key) {
     return key === 'constructor' && typeof obj[key] === 'function' || key === '__proto__';
 }
 
-interface OptionConfig<T = string> {
+interface OptionConfig<F extends string, T = never> {
     description?: string;
     default?: T;
-    construct?: (rawText?: string) => T;
+    construct?: (rawText: ExtractOptionType<F>) => T;
 }
 /**
  * Option
@@ -273,8 +273,8 @@ declare class Option<T extends string = string, F = string> {
     readonly description: string;
     readonly type: 'string' | 'boolean';
     readonly required: boolean;
-    readonly construct: (rawText: string | undefined) => any;
-    constructor(format: T, config?: OptionConfig<F>);
+    readonly construct?: (rawText: ExtractOptionType<T>) => F;
+    constructor(format: T, config?: OptionConfig<T, F>);
 }
 
 declare type ConditionFn = (args: minimist.ParsedArgs) => boolean;
@@ -294,8 +294,8 @@ declare class Command<F extends string = string, CommandOption extends object =
         condition?: ConditionFn;
         logger: Logger;
     });
-    option<OF extends string, T = string>(format: OF, description: string, config?: Omit<OptionConfig<T>, 'description'>): Command<F, CommandOption & ExtractOption<OF>>;
-    option<OF extends string, T = string>(format: OF, config?: OptionConfig<T>): Command<F, CommandOption & ExtractOption<OF>>;
+    option<OF extends string, T = undefined>(format: OF, description: string, config?: Omit<OptionConfig<OF, T>, 'description'>): Command<F, CommandOption & ExtractOption<OF, T>>;
+    option<OF extends string, T = undefined>(format: OF, config?: OptionConfig<OF, T>): Command<F, CommandOption & ExtractOption<OF, T>>;
     get hasConditionFn(): boolean;
     shouldRun(args: minimist.ParsedArgs): boolean;
     parseArgs(args: minimist.ParsedArgs, globalOptions: Option[]): ParseResult;
@@ -322,8 +322,8 @@ interface ParseResult {
     arguments: any[];
     options: Record<string, string>;
 }
-declare type ExtractOption<T extends string> = {
-    [k in ExtractOptionName<T>]: ExtractOptionType<T>;
+declare type ExtractOption<T extends string, D = undefined> = {
+    [k in ExtractOptionName<T>]: D extends undefined ? ExtractOptionType<T> : D;
 };
 /**
  * Extract option name type
@@ -357,8 +357,8 @@ declare class Breadc<GlobalOption extends object = {}> {
     constructor(name: string, option: AppOption);
     version(): string;
     help(command?: Command): string[];
-    option<F extends string, T = string>(format: F, description: string, config?: Omit<OptionConfig<T>, 'description'>): Breadc<GlobalOption & ExtractOption<F>>;
-    option<F extends string, T = string>(format: F, config?: OptionConfig<T>): Breadc<GlobalOption & ExtractOption<F>>;
+    option<F extends string, T = undefined>(format: F, description: string, config?: Omit<OptionConfig<F, T>, 'description'>): Breadc<GlobalOption & ExtractOption<F, T>>;
+    option<F extends string, T = undefined>(format: F, config?: OptionConfig<F, T>): Breadc<GlobalOption & ExtractOption<F, T>>;
     command<F extends string>(format: F, description: string, config?: Omit<CommandConfig, 'description'>): Command<F, GlobalOption>;
     command<F extends string>(format: F, config?: CommandConfig): Command<F, GlobalOption>;
     parse(args: string[]): ParseResult;

package/dist/index.mjs

@@ -296,7 +296,7 @@ const _Option = class {
     this.description = config.description ?? "";
     this.required = format.indexOf("<") !== -1;
     this.default = config.default;
-    this.construct = config.construct ?? ((text) => text ?? config.default ?? void 0);
+    this.construct = config.construct;
   }
 };
 let Option = _Option;
@@ -400,6 +400,13 @@ const _Command = class {
           options[name] = void 0;
         }
       }
+      if (rawOption.construct) {
+        options[name] = rawOption.construct(options[name]);
+      } else if (rawOption.default) {
+        if (!options[name]) {
+          options[name] = rawOption.default;
+        }
+      }
     }
     return {
       command: this,
@@ -573,17 +580,10 @@ class Breadc {
       }
       return map;
     }, {});
-    const defaults = allowOptions.reduce((map, o) => {
-      if (o.default) {
-        map[o.name] = o.default;
-      }
-      return map;
-    }, {});
     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),
       alias,
-      default: defaults,
       unknown: (t) => {
         if (t[0] !== "-")
           return true;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "breadc",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Yet another Command Line Application Framework with fully strong TypeScript support",
   "keywords": [
     "cli",