breadc 0.8.3 → 0.8.5

package/dist/index.cjs

@@ -53,6 +53,13 @@ function makePluginContainer(plugins = []) {
     }
   };
   return {
+    init(breadc, allCommands, globalOptions) {
+      if (plugins.length === 0)
+        return;
+      for (const p of plugins) {
+        p.onInit?.(breadc, allCommands, globalOptions);
+      }
+    },
     async preRun(breadc) {
       if (plugins.length === 0)
         return;
@@ -547,7 +554,7 @@ function makeVersionCommand(name, config) {
   };
   return option;
 }
-function makeHelpCommand(name, config) {
+function makeHelpCommand(name, config, allCommands) {
   function expandMessage(message) {
     const result = [];
     for (const row of message) {
@@ -569,6 +576,7 @@ function makeHelpCommand(name, config) {
   }
   function expandCommands(cursor) {
     const visited = /* @__PURE__ */ new WeakSet();
+    const added = /* @__PURE__ */ new WeakSet();
     const commands = cursor.command ? [cursor.command] : [];
     const q = [cursor];
     visited.add(cursor);
@@ -577,7 +585,8 @@ function makeHelpCommand(name, config) {
       for (const [_key, cmd] of cur.children) {
         if (!visited.has(cmd)) {
           visited.add(cmd);
-          if (cmd.command) {
+          if (cmd.command && !added.has(cmd.command)) {
+            added.add(cmd.command);
             commands.push(cmd.command);
           }
           q.push(cmd);
@@ -590,6 +599,7 @@ function makeHelpCommand(name, config) {
     async callback(parsed) {
       const context = parsed.options.__context__;
       const cursor = parsed.options.__cursor__;
+      const usage = allCommands.length === 0 ? `[OPTIONS]` : allCommands.length === 1 ? `[OPTIONS] ${allCommands[0].format}` : allCommands.some((c) => c._default) ? `[OPTIONS] [COMMAND]` : `[OPTIONS] <COMMAND>`;
       const output = [
         `${name}/${config.version ? config.version : "unknown"}`,
         () => {
@@ -599,6 +609,8 @@ function makeHelpCommand(name, config) {
             return void 0;
           }
         },
+        "",
+        `${color.bold(color.underline("Usage:"))} ${color.bold(name)} ${usage}`,
         () => {
           const cmds = expandCommands(cursor);
           if (cmds.length > 0) {
@@ -662,7 +674,11 @@ function makeHelpCommand(name, config) {
 
 function breadc(name, config = {}) {
   let defaultCommand = void 0;
-  const globalOptions = [];
+  const allCommands = [];
+  const globalOptions = [
+    makeHelpCommand(name, config, allCommands),
+    makeVersionCommand(name, config)
+  ];
   const container = makePluginContainer(config.plugins);
   const root = makeTreeNode({
     init(context) {
@@ -670,15 +686,13 @@ function breadc(name, config = {}) {
       if (defaultCommand) {
         initContextOptions(defaultCommand._options, context);
       }
-      initContextOptions(
-        [makeHelpCommand(name, config), makeVersionCommand(name, config)],
-        context
-      );
     },
     finish() {
     }
   });
   const breadc2 = {
+    name,
+    description: config.description ?? "",
     option(format, _config, _config2 = {}) {
       const config2 = typeof _config === "string" ? { description: _config, ..._config2 } : _config;
       const option = makeOption(format, config2);
@@ -691,6 +705,7 @@ function breadc(name, config = {}) {
       if (command._default) {
         defaultCommand = command;
       }
+      allCommands.push(command);
       return command;
     },
     parse(args) {
@@ -711,6 +726,7 @@ function breadc(name, config = {}) {
       return void 0;
     }
   };
+  container.init(breadc2, allCommands, globalOptions);
   return breadc2;
 }
 
@@ -719,3 +735,4 @@ exports.ParseError = ParseError;
 exports.breadc = breadc;
 exports.default = breadc;
 exports.definePlugin = definePlugin;
+exports.makeTreeNode = makeTreeNode;

package/dist/index.d.ts

@@ -47,6 +47,8 @@ interface TreeNode {
     finish(context: Context): void;
 }
 
+declare function makeTreeNode(pnode: Partial<TreeNode>): TreeNode;
+
 type Lowercase = 'a' | 'b' | 'c' | 'd' | 'e' | 'f' | 'g' | 'h' | 'i' | 'j' | 'k' | 'l' | 'm' | 'n' | 'o' | 'p' | 'q' | 'r' | 's' | 't' | 'u' | 'v' | 'w' | 'x' | 'y' | 'z';
 type Uppercase = 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'H' | 'I' | 'J' | 'K' | 'L' | 'M' | 'N' | 'O' | 'P' | 'Q' | 'R' | 'S' | 'T' | 'U' | 'V' | 'W' | 'X' | 'Y' | 'Z';
 type Letter = Lowercase | Uppercase;
@@ -91,6 +93,8 @@ interface AppOption {
     plugins?: Partial<Plugin>[];
 }
 interface Breadc<GlobalOption extends object = {}> {
+    name: string;
+    description: string;
     option<F extends string = string, T extends string | boolean = ExtractOptionType<F>, R extends any = ExtractOptionType<F>>(format: F, description?: string, option?: OptionOption<T, R>): Breadc<GlobalOption & ExtractOption<F, R>>;
     option<F extends string = string, T extends string | boolean = ExtractOptionType<F>, R extends any = ExtractOptionType<F>>(format: F, option?: OptionOption<T, R>): Breadc<GlobalOption & ExtractOption<F, R>>;
     command<F extends string = string>(format: F, description?: string): Command<F, ExtractCommand<F>, {}, GlobalOption>;
@@ -137,10 +141,11 @@ interface OptionOption<T extends string | boolean, R extends any = T> {
 }
 type CommandHookFn = (result: ParseResult) => void | Promise<void>;
 interface Plugin {
-    onPreRun(breadc: Breadc): void | Promise<void>;
-    onPreCommand: Record<string, CommandHookFn> | CommandHookFn;
-    onPostCommand: Record<string, CommandHookFn> | CommandHookFn;
-    onPostRun(breadc: Breadc): void | Promise<void>;
+    onInit?(breadc: Breadc, allCommands: Command[], globalOptions: Option[]): void;
+    onPreRun?(breadc: Breadc): void | Promise<void>;
+    onPreCommand?: Record<string, CommandHookFn> | CommandHookFn;
+    onPostCommand?: Record<string, CommandHookFn> | CommandHookFn;
+    onPostRun?(breadc: Breadc): void | Promise<void>;
 }
 
 declare function breadc(name: string, config?: AppOption): Breadc<{}>;
@@ -152,4 +157,4 @@ declare class BreadcError extends Error {
 declare class ParseError extends Error {
 }
 
-export { AppOption, Argument, Breadc, BreadcError, Command, Option, ParseError, Plugin, breadc, breadc as default, definePlugin };
+export { AppOption, Argument, Breadc, BreadcError, Command, Option, ParseError, Plugin, breadc, breadc as default, definePlugin, makeTreeNode };

package/dist/index.mjs

@@ -49,6 +49,13 @@ function makePluginContainer(plugins = []) {
     }
   };
   return {
+    init(breadc, allCommands, globalOptions) {
+      if (plugins.length === 0)
+        return;
+      for (const p of plugins) {
+        p.onInit?.(breadc, allCommands, globalOptions);
+      }
+    },
     async preRun(breadc) {
       if (plugins.length === 0)
         return;
@@ -543,7 +550,7 @@ function makeVersionCommand(name, config) {
   };
   return option;
 }
-function makeHelpCommand(name, config) {
+function makeHelpCommand(name, config, allCommands) {
   function expandMessage(message) {
     const result = [];
     for (const row of message) {
@@ -565,6 +572,7 @@ function makeHelpCommand(name, config) {
   }
   function expandCommands(cursor) {
     const visited = /* @__PURE__ */ new WeakSet();
+    const added = /* @__PURE__ */ new WeakSet();
     const commands = cursor.command ? [cursor.command] : [];
     const q = [cursor];
     visited.add(cursor);
@@ -573,7 +581,8 @@ function makeHelpCommand(name, config) {
       for (const [_key, cmd] of cur.children) {
         if (!visited.has(cmd)) {
           visited.add(cmd);
-          if (cmd.command) {
+          if (cmd.command && !added.has(cmd.command)) {
+            added.add(cmd.command);
             commands.push(cmd.command);
           }
           q.push(cmd);
@@ -586,6 +595,7 @@ function makeHelpCommand(name, config) {
     async callback(parsed) {
       const context = parsed.options.__context__;
       const cursor = parsed.options.__cursor__;
+      const usage = allCommands.length === 0 ? `[OPTIONS]` : allCommands.length === 1 ? `[OPTIONS] ${allCommands[0].format}` : allCommands.some((c) => c._default) ? `[OPTIONS] [COMMAND]` : `[OPTIONS] <COMMAND>`;
       const output = [
         `${name}/${config.version ? config.version : "unknown"}`,
         () => {
@@ -595,6 +605,8 @@ function makeHelpCommand(name, config) {
             return void 0;
           }
         },
+        "",
+        `${bold(underline("Usage:"))} ${bold(name)} ${usage}`,
         () => {
           const cmds = expandCommands(cursor);
           if (cmds.length > 0) {
@@ -658,7 +670,11 @@ function makeHelpCommand(name, config) {
 
 function breadc(name, config = {}) {
   let defaultCommand = void 0;
-  const globalOptions = [];
+  const allCommands = [];
+  const globalOptions = [
+    makeHelpCommand(name, config, allCommands),
+    makeVersionCommand(name, config)
+  ];
   const container = makePluginContainer(config.plugins);
   const root = makeTreeNode({
     init(context) {
@@ -666,15 +682,13 @@ function breadc(name, config = {}) {
       if (defaultCommand) {
         initContextOptions(defaultCommand._options, context);
       }
-      initContextOptions(
-        [makeHelpCommand(name, config), makeVersionCommand(name, config)],
-        context
-      );
     },
     finish() {
     }
   });
   const breadc2 = {
+    name,
+    description: config.description ?? "",
     option(format, _config, _config2 = {}) {
       const config2 = typeof _config === "string" ? { description: _config, ..._config2 } : _config;
       const option = makeOption(format, config2);
@@ -687,6 +701,7 @@ function breadc(name, config = {}) {
       if (command._default) {
         defaultCommand = command;
       }
+      allCommands.push(command);
       return command;
     },
     parse(args) {
@@ -707,7 +722,8 @@ function breadc(name, config = {}) {
       return void 0;
     }
   };
+  container.init(breadc2, allCommands, globalOptions);
   return breadc2;
 }
 
-export { BreadcError, ParseError, breadc, breadc as default, definePlugin };
+export { BreadcError, ParseError, breadc, breadc as default, definePlugin, makeTreeNode };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "breadc",
-  "version": "0.8.3",
+  "version": "0.8.5",
   "description": "Yet another Command Line Application Framework with fully strong TypeScript support",
   "keywords": [
     "breadc",
@@ -34,13 +34,13 @@
     "dist"
   ],
   "dependencies": {
-    "@breadc/color": "0.8.3"
+    "@breadc/color": "0.8.5"
   },
   "devDependencies": {
-    "@types/node": "^18.11.18",
+    "@types/node": "^18.11.19",
     "@vitest/coverage-c8": "^0.28.4",
     "cac": "^6.7.14",
-    "vitest": "0.28.3"
+    "vitest": "0.28.4"
   },
   "scripts": {
     "build": "unbuild",