breadc 0.8.0 → 0.8.2

package/README.md

@@ -8,7 +8,7 @@ Yet another Command Line Application Framework with fully strong **[TypeScript](
 
 ## Features
 
-+ ⚡️ **Light-weight**: Only 40 kB (Unpacked).
++ ⚡️ **Light-weight**: Only 70 kB (Unpacked).
 + 📖 **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.
 

package/dist/index.cjs

@@ -8,44 +8,71 @@ function makePluginContainer(plugins = []) {
   const onPreCommand = {};
   const onPostCommand = {};
   for (const plugin of plugins) {
-    for (const [key, fn] of Object.entries(plugin.onPreCommand ?? {})) {
+    if (typeof plugin.onPreCommand === "function") {
+      const key = "*";
       if (!(key in onPreCommand)) {
         onPreCommand[key] = [];
       }
-      onPreCommand[key].push(fn);
+      onPreCommand[key].push(plugin.onPreCommand);
+    } else {
+      for (const [key, fn] of Object.entries(plugin.onPreCommand ?? {})) {
+        if (!(key in onPreCommand)) {
+          onPreCommand[key] = [];
+        }
+        onPreCommand[key].push(fn);
+      }
     }
-    for (const [key, fn] of Object.entries(plugin.onPostCommand ?? {})) {
+    if (typeof plugin.onPostCommand === "function") {
+      const key = "*";
       if (!(key in onPostCommand)) {
         onPostCommand[key] = [];
       }
-      onPostCommand[key].push(fn);
+      onPostCommand[key].push(plugin.onPostCommand);
+    } else {
+      for (const [key, fn] of Object.entries(plugin.onPostCommand ?? {})) {
+        if (!(key in onPostCommand)) {
+          onPostCommand[key] = [];
+        }
+        onPostCommand[key].push(fn);
+      }
     }
   }
-  const run = async (container, command) => {
+  const run = async (container, command, result) => {
     const prefix = command._arguments.filter((a) => a.type === "const").map((a) => a.name);
+    if (prefix.length === 0) {
+      prefix.push("_");
+    }
     for (let i = 0; i <= prefix.length; i++) {
       const key = i === 0 ? "*" : prefix.slice(0, i).map(
         (t, idx) => idx === 0 ? t : t[0].toUpperCase() + t.slice(1)
       ).join("");
       const fns = container[key];
       if (fns && fns.length > 0) {
-        await Promise.all(fns.map((fn) => fn()));
+        await Promise.all(fns.map((fn) => fn(result)));
       }
     }
   };
   return {
     async preRun(breadc) {
+      if (plugins.length === 0)
+        return;
       for (const p of plugins) {
         await p.onPreRun?.(breadc);
       }
     },
-    async preCommand(command) {
-      await run(onPreCommand, command);
+    async preCommand(command, result) {
+      if (plugins.length === 0)
+        return;
+      await run(onPreCommand, command, result);
     },
-    async postCommand(command) {
-      await run(onPostCommand, command);
+    async postCommand(command, result) {
+      if (plugins.length === 0)
+        return;
+      await run(onPostCommand, command, result);
     },
     async postRun(breadc) {
+      if (plugins.length === 0)
+        return;
       for (const p of plugins) {
         await p.onPostRun?.(breadc);
       }
@@ -329,10 +356,13 @@ function makeCommand(format, config, root, container) {
       return command;
     },
     action(fn) {
-      command.callback = async (...args2) => {
-        await container.preCommand(command);
-        const result = await fn(...args2);
-        await container.postCommand(command);
+      command.callback = async (parsed) => {
+        await container.preCommand(command, parsed);
+        const result = await fn(...parsed.arguments, {
+          ...parsed.options,
+          "--": parsed["--"]
+        });
+        await container.postCommand(command, parsed);
         return result;
       };
     }
@@ -452,7 +482,7 @@ function makeCommand(format, config, root, container) {
 }
 function makeVersionCommand(name, config) {
   const command = {
-    callback() {
+    async callback() {
       const text = `${name}/${config.version ? config.version : "unknown"}`;
       console.log(text);
       return text;
@@ -527,9 +557,9 @@ function makeHelpCommand(name, config) {
     return commands;
   }
   const command = {
-    callback(option2) {
-      const context = option2.__context__;
-      const cursor = option2.__cursor__;
+    async callback(parsed) {
+      const context = parsed.options.__context__;
+      const cursor = parsed.options.__cursor__;
       const output = [
         `${name}/${config.version ? config.version : "unknown"}`,
         () => {
@@ -642,10 +672,7 @@ function breadc(name, config = {}) {
       if (command) {
         if (command.callback) {
           await container.preRun(breadc2);
-          const r = command.callback(...result.arguments, {
-            ...result.options,
-            "--": result["--"]
-          });
+          const r = await command.callback(result);
           await container.postRun(breadc2);
           return r;
         }

package/dist/index.d.ts

@@ -101,13 +101,13 @@ interface Breadc<GlobalOption extends object = {}> {
     run<T = any>(args: string[]): Promise<T>;
 }
 interface Command<F extends string = string, AT extends any[] = ExtractCommand<F>, CommandOption extends object = {}, GlobalOption extends object = {}> {
-    callback?: ActionFn<ExtractCommand<F>, CommandOption & GlobalOption>;
+    callback?: (result: ParseResult) => Promise<any>;
     format: F;
     description: string;
     _arguments: Argument[];
     _options: Option[];
-    option<OF extends string = string, OT extends string | boolean = ExtractOptionType<F>, OR extends any = ExtractOptionType<F>>(format: OF, description?: string, option?: OptionOption<OT, OR>): Command<F, AT, CommandOption & ExtractOption<OF, OR>, GlobalOption>;
-    option<OF extends string = string, OT extends string | boolean = ExtractOptionType<F>, OR extends any = ExtractOptionType<F>>(format: OF, option?: OptionOption<OT, OR>): Command<F, AT, CommandOption & ExtractOption<OF, OR>, GlobalOption>;
+    option<OF extends string = string, OT extends string | boolean = ExtractOptionType<OF>, OR extends any = ExtractOptionType<OF>>(format: OF, description?: string, option?: OptionOption<OT, OR>): Command<F, AT, CommandOption & ExtractOption<OF, OR>, GlobalOption>;
+    option<OF extends string = string, OT extends string | boolean = ExtractOptionType<OF>, OR extends any = ExtractOptionType<OF>>(format: OF, option?: OptionOption<OT, OR>): Command<F, AT, CommandOption & ExtractOption<OF, OR>, GlobalOption>;
     action(fn: ActionFn<AT, CommandOption & GlobalOption>): void;
 }
 interface CommandOption {
@@ -128,15 +128,16 @@ interface Option<F extends string = string, T extends string | boolean = Extract
     cast?: (value: T extends string ? string : T extends boolean ? boolean : never) => R;
     action?: (cursor: TreeNode, token: Token, context: Context) => TreeNode | false;
 }
-interface OptionOption<T extends string | boolean, R extends any> {
+interface OptionOption<T extends string | boolean, R extends any = T> {
     description?: string;
     default?: T;
     cast?: (value: T) => R;
 }
+type CommandHookFn = (result: ParseResult) => void | Promise<void>;
 interface Plugin {
     onPreRun(breadc: Breadc): void | Promise<void>;
-    onPreCommand: Record<string, () => void | Promise<void>>;
-    onPostCommand: Record<string, () => void | Promise<void>>;
+    onPreCommand: Record<string, CommandHookFn> | CommandHookFn;
+    onPostCommand: Record<string, CommandHookFn> | CommandHookFn;
     onPostRun(breadc: Breadc): void | Promise<void>;
 }
 

package/dist/index.mjs

@@ -4,44 +4,71 @@ function makePluginContainer(plugins = []) {
   const onPreCommand = {};
   const onPostCommand = {};
   for (const plugin of plugins) {
-    for (const [key, fn] of Object.entries(plugin.onPreCommand ?? {})) {
+    if (typeof plugin.onPreCommand === "function") {
+      const key = "*";
       if (!(key in onPreCommand)) {
         onPreCommand[key] = [];
       }
-      onPreCommand[key].push(fn);
+      onPreCommand[key].push(plugin.onPreCommand);
+    } else {
+      for (const [key, fn] of Object.entries(plugin.onPreCommand ?? {})) {
+        if (!(key in onPreCommand)) {
+          onPreCommand[key] = [];
+        }
+        onPreCommand[key].push(fn);
+      }
     }
-    for (const [key, fn] of Object.entries(plugin.onPostCommand ?? {})) {
+    if (typeof plugin.onPostCommand === "function") {
+      const key = "*";
       if (!(key in onPostCommand)) {
         onPostCommand[key] = [];
       }
-      onPostCommand[key].push(fn);
+      onPostCommand[key].push(plugin.onPostCommand);
+    } else {
+      for (const [key, fn] of Object.entries(plugin.onPostCommand ?? {})) {
+        if (!(key in onPostCommand)) {
+          onPostCommand[key] = [];
+        }
+        onPostCommand[key].push(fn);
+      }
     }
   }
-  const run = async (container, command) => {
+  const run = async (container, command, result) => {
     const prefix = command._arguments.filter((a) => a.type === "const").map((a) => a.name);
+    if (prefix.length === 0) {
+      prefix.push("_");
+    }
     for (let i = 0; i <= prefix.length; i++) {
       const key = i === 0 ? "*" : prefix.slice(0, i).map(
         (t, idx) => idx === 0 ? t : t[0].toUpperCase() + t.slice(1)
       ).join("");
       const fns = container[key];
       if (fns && fns.length > 0) {
-        await Promise.all(fns.map((fn) => fn()));
+        await Promise.all(fns.map((fn) => fn(result)));
       }
     }
   };
   return {
     async preRun(breadc) {
+      if (plugins.length === 0)
+        return;
       for (const p of plugins) {
         await p.onPreRun?.(breadc);
       }
     },
-    async preCommand(command) {
-      await run(onPreCommand, command);
+    async preCommand(command, result) {
+      if (plugins.length === 0)
+        return;
+      await run(onPreCommand, command, result);
     },
-    async postCommand(command) {
-      await run(onPostCommand, command);
+    async postCommand(command, result) {
+      if (plugins.length === 0)
+        return;
+      await run(onPostCommand, command, result);
     },
     async postRun(breadc) {
+      if (plugins.length === 0)
+        return;
       for (const p of plugins) {
         await p.onPostRun?.(breadc);
       }
@@ -325,10 +352,13 @@ function makeCommand(format, config, root, container) {
       return command;
     },
     action(fn) {
-      command.callback = async (...args2) => {
-        await container.preCommand(command);
-        const result = await fn(...args2);
-        await container.postCommand(command);
+      command.callback = async (parsed) => {
+        await container.preCommand(command, parsed);
+        const result = await fn(...parsed.arguments, {
+          ...parsed.options,
+          "--": parsed["--"]
+        });
+        await container.postCommand(command, parsed);
         return result;
       };
     }
@@ -448,7 +478,7 @@ function makeCommand(format, config, root, container) {
 }
 function makeVersionCommand(name, config) {
   const command = {
-    callback() {
+    async callback() {
       const text = `${name}/${config.version ? config.version : "unknown"}`;
       console.log(text);
       return text;
@@ -523,9 +553,9 @@ function makeHelpCommand(name, config) {
     return commands;
   }
   const command = {
-    callback(option2) {
-      const context = option2.__context__;
-      const cursor = option2.__cursor__;
+    async callback(parsed) {
+      const context = parsed.options.__context__;
+      const cursor = parsed.options.__cursor__;
       const output = [
         `${name}/${config.version ? config.version : "unknown"}`,
         () => {
@@ -638,10 +668,7 @@ function breadc(name, config = {}) {
       if (command) {
         if (command.callback) {
           await container.preRun(breadc2);
-          const r = command.callback(...result.arguments, {
-            ...result.options,
-            "--": result["--"]
-          });
+          const r = await command.callback(result);
           await container.postRun(breadc2);
           return r;
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "breadc",
-  "version": "0.8.0",
+  "version": "0.8.2",
   "description": "Yet another Command Line Application Framework with fully strong TypeScript support",
   "keywords": [
     "breadc",
@@ -35,7 +35,7 @@
     "dist"
   ],
   "dependencies": {
-    "@breadc/color": "0.8.0"
+    "@breadc/color": "0.8.2"
   },
   "devDependencies": {
     "@types/node": "^18.11.18",