@decaf-ts/cli 0.3.2 → 0.3.6

package/lib/CliWrapper.cjs

@@ -10,11 +10,19 @@ const path_1 = __importDefault(require("path"));
 const constants_1 = require("./constants.cjs");
 const utils_1 = require("./utils.cjs");
 /**
- * @summary Util class to handle CLI functionality from all Decaf modules
- * @description CLI handler class
+ * @description Utility class to handle CLI functionality from all Decaf modules
+ * @summary This class provides a wrapper around Commander.js to handle CLI commands from different Decaf modules.
+ * It crawls the filesystem to find CLI modules, loads them, and registers their commands.
  *
- * @param {string} [basepath] the base path to look for modules in. defaults to `./`
- * @param {string} [crawlLevels] folders to crawl to find modules from the basePath. defaults to 4
+ * @param {string} [basePath] The base path to look for modules in. Defaults to `./`
+ * @param {number} [crawlLevels] Number of folder levels to crawl to find modules from the basePath. Defaults to 4
+ *
+ * @example
+ * // Create a new CLI wrapper and run it with custom options
+ * const cli = new CliWrapper('./src', 2);
+ * cli.run(process.argv).then(() => {
+ *   console.log('CLI commands executed successfully');
+ * });
  *
  * @class CliWrapper
  */
@@ -23,26 +31,47 @@ class CliWrapper {
         this.basePath = basePath;
         this.crawlLevels = crawlLevels;
         this.modules = {};
+        this.rootPath = path_1.default.resolve(__dirname, "..");
     }
     /**
-     * @description Retrieves and initializes the {@link Command} object
+     * @description Retrieves and initializes the Commander Command object
+     * @summary Lazy-loads the Command object, initializing it with the package name, description, and version
+     * @return {Command} The initialized Command object
      * @private
      */
     get command() {
         if (!this._command) {
             this._command = new commander_1.Command();
-            utils_1.CLIUtils.initialize(this._command, this.basePath);
+            utils_1.CLIUtils.initialize(this._command, this.rootPath);
         }
         return this._command;
     }
     /**
-     * @description loads and registers module from a file
+     * @description Loads and registers a module from a file
+     * @summary Dynamically imports a CLI module from the specified file path, initializes it, and registers it in the modules collection
      *
-     * @param {string} filePath path to look for modules
-     * @param {string} rootPath repo root to find the package.json
-     * @return {string} the module name
+     * @param {string} filePath Path to the module file to load
+     * @param {string} rootPath Repository root path to find the package.json
+     * @return {Promise<string>} A promise that resolves to the module name
      *
      * @private
+     * @mermaid
+     * sequenceDiagram
+     *   participant CliWrapper
+     *   participant CLIUtils
+     *   participant Module
+     *
+     *   CliWrapper->>CLIUtils: loadFromFile(filePath)
+     *   CLIUtils-->>CliWrapper: module
+     *   CliWrapper->>CliWrapper: Get module name
+     *   CliWrapper->>Command: new Command()
+     *   Command-->>CliWrapper: cmd
+     *   CliWrapper->>CLIUtils: initialize(cmd, path.dirname(rootPath))
+     *   CliWrapper->>Module: module()
+     *   Note over CliWrapper,Module: Handle Promise if needed
+     *   Module-->>CliWrapper: Command instance
+     *   CliWrapper->>CliWrapper: Store in modules[name]
+     *   CliWrapper-->>CliWrapper: Return name
      */
     async load(filePath, rootPath) {
         let name;
@@ -50,7 +79,7 @@ class CliWrapper {
             const module = await utils_1.CLIUtils.loadFromFile(filePath);
             name = module.name;
             const cmd = new commander_1.Command();
-            utils_1.CLIUtils.initialize(cmd, path_1.default.dirname(rootPath));
+            utils_1.CLIUtils.initialize(cmd, rootPath);
             let m = module();
             if (m instanceof Promise)
                 m = await m;
@@ -62,12 +91,36 @@ class CliWrapper {
         return name;
     }
     /**
-     * @description finds all the cli modules in the basePath via {@link CliWrapper.crawl}
-     * and loads them
+     * @description Finds and loads all CLI modules in the basePath
+     * @summary Uses the crawl method to find all CLI modules in the specified base path,
+     * then loads and registers each module as a subcommand
+     *
+     * @return {Promise<void>} A promise that resolves when all modules are loaded
+     *
      * @private
+     * @mermaid
+     * sequenceDiagram
+     *   participant CliWrapper
+     *   participant Filesystem
+     *   participant Module
+     *
+     *   CliWrapper->>Filesystem: Join basePath with cwd
+     *   CliWrapper->>CliWrapper: crawl(basePath, crawlLevels)
+     *   CliWrapper-->>CliWrapper: modules[]
+     *   loop For each module
+     *     alt Not @decaf-ts/cli
+     *       CliWrapper->>CliWrapper: load(module, cwd)
+     *       CliWrapper-->>CliWrapper: name
+     *       CliWrapper->>CliWrapper: Check if command exists
+     *       alt Command doesn't exist
+     *         CliWrapper->>Command: command(name).addCommand(modules[name])
+     *       end
+     *     end
+     *   end
+     *   CliWrapper->>Console: Log loaded modules
      */
     async boot() {
-        const basePath = path_1.default.join(process.cwd(), this.basePath);
+        const basePath = path_1.default.resolve(this.rootPath, this.basePath);
         const modules = this.crawl(basePath, this.crawlLevels);
         for (const module of modules) {
             if (module.includes("@decaf-ts/cli")) {
@@ -75,7 +128,7 @@ class CliWrapper {
             }
             let name;
             try {
-                name = await this.load(module, process.cwd());
+                name = await this.load(module, this.rootPath);
             }
             catch (e) {
                 console.error(e);
@@ -94,9 +147,13 @@ class CliWrapper {
             .join("\n")}`);
     }
     /**
-     * @description crawls the basePath up for 'levels' folders to find a module,eg a {@link CLI_FILE_NAME} named file
-     * @param {string} basePath the relative base batch to start searching in
-     * @param {number} [levels] the max number of levels to crawl. defaults to 2
+     * @description Recursively searches for CLI module files in the directory structure
+     * @summary Crawls the basePath up to the specified number of folder levels to find files named according to CLI_FILE_NAME
+     *
+     * @param {string} basePath The absolute base path to start searching in
+     * @param {number} [levels=2] The maximum number of directory levels to crawl
+     * @return {string[]} An array of file paths to CLI modules
+     *
      * @private
      */
     crawl(basePath, levels = 2) {
@@ -114,9 +171,24 @@ class CliWrapper {
         }, []);
     }
     /**
-     * @description runs the given command
+     * @description Executes the CLI with the provided arguments
+     * @summary Boots the CLI by loading all modules, then parses and executes the command specified in the arguments
+     *
+     * @param {string[]} [args=process.argv] Command line arguments to parse and execute
+     * @return {Promise<void>} A promise that resolves when the command execution is complete
+     *
+     * @mermaid
+     * sequenceDiagram
+     *   participant Client
+     *   participant CliWrapper
+     *   participant Command
      *
-     * @param {string[]} [args] args to run. defaults to process.argv
+     *   Client->>CliWrapper: run(args)
+     *   CliWrapper->>CliWrapper: boot()
+     *   Note over CliWrapper: Loads all modules
+     *   CliWrapper->>Command: parseAsync(args)
+     *   Command-->>CliWrapper: result
+     *   CliWrapper-->>Client: result
      */
     async run(args = process.argv) {
         await this.boot();
@@ -124,4 +196,4 @@ class CliWrapper {
     }
 }
 exports.CliWrapper = CliWrapper;
-//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"CliWrapper.js","sourceRoot":"","sources":["../src/CliWrapper.ts"],"names":[],"mappings":";;;;;;AAAA,yCAAoC;AACpC,4CAAoB;AACpB,gDAAwB;AACxB,2CAA4C;AAC5C,mCAAmC;AAEnC;;;;;;;;GAQG;AACH,MAAa,UAAU;IAIrB,YACU,WAAmB,IAAI,EACvB,cAAc,CAAC;QADf,aAAQ,GAAR,QAAQ,CAAe;QACvB,gBAAW,GAAX,WAAW,CAAI;QAJjB,YAAO,GAA4B,EAAE,CAAC;IAK3C,CAAC;IAEJ;;;OAGG;IACH,IAAY,OAAO;QACjB,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnB,IAAI,CAAC,QAAQ,GAAG,IAAI,mBAAO,EAAE,CAAC;YAC9B,gBAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QACpD,CAAC;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;;;;;;;OAQG;IACK,KAAK,CAAC,IAAI,CAAC,QAAgB,EAAE,QAAgB;QACnD,IAAI,IAAI,CAAC;QACT,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,gBAAQ,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;YACrD,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;YACnB,MAAM,GAAG,GAAG,IAAI,mBAAO,EAAE,CAAC;YAC1B,gBAAQ,CAAC,UAAU,CAAC,GAAG,EAAE,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;YACjD,IAAI,CAAC,GAAG,MAAM,EAAE,CAAC;YACjB,IAAI,CAAC,YAAY,OAAO;gBAAE,CAAC,GAAG,MAAM,CAAC,CAAC;YACtC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACzB,CAAC;QAAC,OAAO,CAAU,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CACb,yBAAyB,IAAI,IAAI,SAAS,UAAU,QAAQ,KAAK,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CACtG,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACK,KAAK,CAAC,IAAI;QAChB,MAAM,QAAQ,GAAG,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QACzD,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACvD,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,IAAI,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC;gBACrC,SAAS;YACX,CAAC;YACD,IAAI,IAAY,CAAC;YACjB,IAAI,CAAC;gBACH,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;YAChD,CAAC;YAAC,OAAO,CAAU,EAAE,CAAC;gBACpB,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBACjB,SAAS;YACX,CAAC;YAED,IACE,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CACzB,CAAC,CAAC,EAAE,EAAE,CAAE,CAAuC,CAAC,OAAO,CAAC,KAAK,IAAI,CAClE;gBAED,IAAI,CAAC;oBACH,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;gBAC5D,CAAC;gBAAC,OAAO,CAAU,EAAE,CAAC;oBACpB,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBACnB,CAAC;QACL,CAAC;QACD,OAAO,CAAC,GAAG,CACT,oBAAoB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;aAC1C,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC;aACpB,IAAI,CAAC,IAAI,CAAC,EAAE,CAChB,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,QAAgB,EAAE,SAAiB,CAAC;QAChD,IAAI,MAAM,IAAI,CAAC;YAAE,OAAO,EAAE,CAAC;QAC3B,OAAO,YAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,KAAe,EAAE,IAAI,EAAE,EAAE;YAC/D,IAAI,GAAG,cAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YACjC,IAAI,YAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC;gBACpC,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;YAC9C,CAAC;iBAAM,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,GAAG,yBAAa,WAAW,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC;gBACrE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACnB,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC,EAAE,EAAE,CAAC,CAAC;IACT,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,GAAG,CAAC,OAAiB,OAAO,CAAC,IAAI;QACrC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IACvC,CAAC;CACF;AAlHD,gCAkHC","sourcesContent":["import { Command } from \"commander\";\nimport fs from \"fs\";\nimport path from \"path\";\nimport { CLI_FILE_NAME } from \"./constants\";\nimport { CLIUtils } from \"./utils\";\n\n/**\n * @summary Util class to handle CLI functionality from all Decaf modules\n * @description CLI handler class\n *\n * @param {string} [basepath] the base path to look for modules in. defaults to `./`\n * @param {string} [crawlLevels] folders to crawl to find modules from the basePath. defaults to 4\n *\n * @class CliWrapper\n */\nexport class CliWrapper {\n  private _command?: Command;\n  private modules: Record<string, Command> = {};\n\n  constructor(\n    private basePath: string = \"./\",\n    private crawlLevels = 4\n  ) {}\n\n  /**\n   * @description Retrieves and initializes the {@link Command} object\n   * @private\n   */\n  private get command() {\n    if (!this._command) {\n      this._command = new Command();\n      CLIUtils.initialize(this._command, this.basePath);\n    }\n    return this._command;\n  }\n\n  /**\n   * @description loads and registers module from a file\n   *\n   * @param {string} filePath path to look for modules\n   * @param {string} rootPath repo root to find the package.json\n   * @return {string} the module name\n   *\n   * @private\n   */\n  private async load(filePath: string, rootPath: string): Promise<string> {\n    let name;\n    try {\n      const module = await CLIUtils.loadFromFile(filePath);\n      name = module.name;\n      const cmd = new Command();\n      CLIUtils.initialize(cmd, path.dirname(rootPath));\n      let m = module();\n      if (m instanceof Promise) m = await m;\n      this.modules[name] = m;\n    } catch (e: unknown) {\n      throw new Error(\n        `failed to load module ${name || \"unnamed\"} under ${filePath}: ${e instanceof Error ? e.message : e}`\n      );\n    }\n    return name;\n  }\n\n  /**\n   * @description finds all the cli modules in the basePath via {@link CliWrapper.crawl}\n   * and loads them\n   * @private\n   */\n  private async boot() {\n    const basePath = path.join(process.cwd(), this.basePath);\n    const modules = this.crawl(basePath, this.crawlLevels);\n    for (const module of modules) {\n      if (module.includes(\"@decaf-ts/cli\")) {\n        continue;\n      }\n      let name: string;\n      try {\n        name = await this.load(module, process.cwd());\n      } catch (e: unknown) {\n        console.error(e);\n        continue;\n      }\n\n      if (\n        !this.command.commands.find(\n          (c) => (c as unknown as Record<string, string>)[\"_name\"] === name\n        )\n      )\n        try {\n          this.command.command(name).addCommand(this.modules[name]);\n        } catch (e: unknown) {\n          console.error(e);\n        }\n    }\n    console.log(\n      `loaded modules:\\n${Object.keys(this.modules)\n        .map((k) => `- ${k}`)\n        .join(\"\\n\")}`\n    );\n  }\n\n  /**\n   * @description crawls the basePath up for 'levels' folders to find a module,eg a {@link CLI_FILE_NAME} named file\n   * @param {string} basePath the relative base batch to start searching in\n   * @param {number} [levels] the max number of levels to crawl. defaults to 2\n   * @private\n   */\n  private crawl(basePath: string, levels: number = 2) {\n    if (levels <= 0) return [];\n    return fs.readdirSync(basePath).reduce((accum: string[], file) => {\n      file = path.join(basePath, file);\n      if (fs.statSync(file).isDirectory()) {\n        accum.push(...this.crawl(file, levels - 1));\n      } else if (file.match(new RegExp(`${CLI_FILE_NAME}.[cm]?js$`, \"gm\"))) {\n        accum.push(file);\n      }\n      return accum;\n    }, []);\n  }\n\n  /**\n   * @description runs the given command\n   *\n   * @param {string[]} [args] args to run. defaults to process.argv\n   */\n  async run(args: string[] = process.argv) {\n    await this.boot();\n    return this.command.parseAsync(args);\n  }\n}\n"]}
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"CliWrapper.js","sourceRoot":"","sources":["../src/CliWrapper.ts"],"names":[],"mappings":";;;;;;AAAA,yCAAoC;AACpC,4CAAoB;AACpB,gDAAwB;AACxB,+CAA4C;AAC5C,uCAAmC;AAEnC;;;;;;;;;;;;;;;;GAgBG;AACH,MAAa,UAAU;IAKrB,YACU,WAAmB,IAAI,EACvB,cAAc,CAAC;QADf,aAAQ,GAAR,QAAQ,CAAe;QACvB,gBAAW,GAAX,WAAW,CAAI;QALjB,YAAO,GAA4B,EAAE,CAAC;QAO5C,IAAI,CAAC,QAAQ,GAAG,cAAI,CAAC,OAAO,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;IAChD,CAAC;IAED;;;;;OAKG;IACH,IAAY,OAAO;QACjB,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnB,IAAI,CAAC,QAAQ,GAAG,IAAI,mBAAO,EAAE,CAAC;YAC9B,gBAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QACpD,CAAC;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACK,KAAK,CAAC,IAAI,CAAC,QAAgB,EAAE,QAAgB;QACnD,IAAI,IAAI,CAAC;QACT,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,gBAAQ,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;YACrD,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;YACnB,MAAM,GAAG,GAAG,IAAI,mBAAO,EAAE,CAAC;YAC1B,gBAAQ,CAAC,UAAU,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;YACnC,IAAI,CAAC,GAAG,MAAM,EAAE,CAAC;YACjB,IAAI,CAAC,YAAY,OAAO;gBAAE,CAAC,GAAG,MAAM,CAAC,CAAC;YACtC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACzB,CAAC;QAAC,OAAO,CAAU,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CACb,yBAAyB,IAAI,IAAI,SAAS,UAAU,QAAQ,KAAK,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CACtG,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACK,KAAK,CAAC,IAAI;QAChB,MAAM,QAAQ,GAAG,cAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC5D,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACvD,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,IAAI,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC;gBACrC,SAAS;YACX,CAAC;YACD,IAAI,IAAY,CAAC;YACjB,IAAI,CAAC;gBACH,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YAChD,CAAC;YAAC,OAAO,CAAU,EAAE,CAAC;gBACpB,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBACjB,SAAS;YACX,CAAC;YAED,IACE,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CACzB,CAAC,CAAC,EAAE,EAAE,CAAE,CAAuC,CAAC,OAAO,CAAC,KAAK,IAAI,CAClE;gBAED,IAAI,CAAC;oBACH,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;gBAC5D,CAAC;gBAAC,OAAO,CAAU,EAAE,CAAC;oBACpB,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBACnB,CAAC;QACL,CAAC;QACD,OAAO,CAAC,GAAG,CACT,oBAAoB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;aAC1C,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC;aACpB,IAAI,CAAC,IAAI,CAAC,EAAE,CAChB,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACK,KAAK,CAAC,QAAgB,EAAE,SAAiB,CAAC;QAChD,IAAI,MAAM,IAAI,CAAC;YAAE,OAAO,EAAE,CAAC;QAC3B,OAAO,YAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,KAAe,EAAE,IAAI,EAAE,EAAE;YAC/D,IAAI,GAAG,cAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YACjC,IAAI,YAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC;gBACpC,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;YAC9C,CAAC;iBAAM,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,GAAG,yBAAa,WAAW,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC;gBACrE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACnB,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC,EAAE,EAAE,CAAC,CAAC;IACT,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,GAAG,CAAC,OAAiB,OAAO,CAAC,IAAI;QACrC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IACvC,CAAC;CACF;AApLD,gCAoLC","sourcesContent":["import { Command } from \"commander\";\nimport fs from \"fs\";\nimport path from \"path\";\nimport { CLI_FILE_NAME } from \"./constants\";\nimport { CLIUtils } from \"./utils\";\n\n/**\n * @description Utility class to handle CLI functionality from all Decaf modules\n * @summary This class provides a wrapper around Commander.js to handle CLI commands from different Decaf modules.\n * It crawls the filesystem to find CLI modules, loads them, and registers their commands.\n * \n * @param {string} [basePath] The base path to look for modules in. Defaults to `./`\n * @param {number} [crawlLevels] Number of folder levels to crawl to find modules from the basePath. Defaults to 4\n * \n * @example\n * // Create a new CLI wrapper and run it with custom options\n * const cli = new CliWrapper('./src', 2);\n * cli.run(process.argv).then(() => {\n *   console.log('CLI commands executed successfully');\n * });\n * \n * @class CliWrapper\n */\nexport class CliWrapper {\n  private _command?: Command;\n  private modules: Record<string, Command> = {};\n  private readonly rootPath: string;\n\n  constructor(\n    private basePath: string = \"./\",\n    private crawlLevels = 4\n  ) {\n    this.rootPath = path.resolve(__dirname, \"..\");\n  }\n\n  /**\n   * @description Retrieves and initializes the Commander Command object\n   * @summary Lazy-loads the Command object, initializing it with the package name, description, and version\n   * @return {Command} The initialized Command object\n   * @private\n   */\n  private get command() {\n    if (!this._command) {\n      this._command = new Command();\n      CLIUtils.initialize(this._command, this.rootPath);\n    }\n    return this._command;\n  }\n\n  /**\n   * @description Loads and registers a module from a file\n   * @summary Dynamically imports a CLI module from the specified file path, initializes it, and registers it in the modules collection\n   *\n   * @param {string} filePath Path to the module file to load\n   * @param {string} rootPath Repository root path to find the package.json\n   * @return {Promise<string>} A promise that resolves to the module name\n   *\n   * @private\n   * @mermaid\n   * sequenceDiagram\n   *   participant CliWrapper\n   *   participant CLIUtils\n   *   participant Module\n   *   \n   *   CliWrapper->>CLIUtils: loadFromFile(filePath)\n   *   CLIUtils-->>CliWrapper: module\n   *   CliWrapper->>CliWrapper: Get module name\n   *   CliWrapper->>Command: new Command()\n   *   Command-->>CliWrapper: cmd\n   *   CliWrapper->>CLIUtils: initialize(cmd, path.dirname(rootPath))\n   *   CliWrapper->>Module: module()\n   *   Note over CliWrapper,Module: Handle Promise if needed\n   *   Module-->>CliWrapper: Command instance\n   *   CliWrapper->>CliWrapper: Store in modules[name]\n   *   CliWrapper-->>CliWrapper: Return name\n   */\n  private async load(filePath: string, rootPath: string): Promise<string> {\n    let name;\n    try {\n      const module = await CLIUtils.loadFromFile(filePath);\n      name = module.name;\n      const cmd = new Command();\n      CLIUtils.initialize(cmd, rootPath);\n      let m = module();\n      if (m instanceof Promise) m = await m;\n      this.modules[name] = m;\n    } catch (e: unknown) {\n      throw new Error(\n        `failed to load module ${name || \"unnamed\"} under ${filePath}: ${e instanceof Error ? e.message : e}`\n      );\n    }\n    return name;\n  }\n\n  /**\n   * @description Finds and loads all CLI modules in the basePath\n   * @summary Uses the crawl method to find all CLI modules in the specified base path, \n   * then loads and registers each module as a subcommand\n   * \n   * @return {Promise<void>} A promise that resolves when all modules are loaded\n   * \n   * @private\n   * @mermaid\n   * sequenceDiagram\n   *   participant CliWrapper\n   *   participant Filesystem\n   *   participant Module\n   *   \n   *   CliWrapper->>Filesystem: Join basePath with cwd\n   *   CliWrapper->>CliWrapper: crawl(basePath, crawlLevels)\n   *   CliWrapper-->>CliWrapper: modules[]\n   *   loop For each module\n   *     alt Not @decaf-ts/cli\n   *       CliWrapper->>CliWrapper: load(module, cwd)\n   *       CliWrapper-->>CliWrapper: name\n   *       CliWrapper->>CliWrapper: Check if command exists\n   *       alt Command doesn't exist\n   *         CliWrapper->>Command: command(name).addCommand(modules[name])\n   *       end\n   *     end\n   *   end\n   *   CliWrapper->>Console: Log loaded modules\n   */\n  private async boot() {\n    const basePath = path.resolve(this.rootPath, this.basePath);\n    const modules = this.crawl(basePath, this.crawlLevels);\n    for (const module of modules) {\n      if (module.includes(\"@decaf-ts/cli\")) {\n        continue;\n      }\n      let name: string;\n      try {\n        name = await this.load(module, this.rootPath);\n      } catch (e: unknown) {\n        console.error(e);\n        continue;\n      }\n\n      if (\n        !this.command.commands.find(\n          (c) => (c as unknown as Record<string, string>)[\"_name\"] === name\n        )\n      )\n        try {\n          this.command.command(name).addCommand(this.modules[name]);\n        } catch (e: unknown) {\n          console.error(e);\n        }\n    }\n    console.log(\n      `loaded modules:\\n${Object.keys(this.modules)\n        .map((k) => `- ${k}`)\n        .join(\"\\n\")}`\n    );\n  }\n\n  /**\n   * @description Recursively searches for CLI module files in the directory structure\n   * @summary Crawls the basePath up to the specified number of folder levels to find files named according to CLI_FILE_NAME\n   * \n   * @param {string} basePath The absolute base path to start searching in\n   * @param {number} [levels=2] The maximum number of directory levels to crawl\n   * @return {string[]} An array of file paths to CLI modules\n   * \n   * @private\n   */\n  private crawl(basePath: string, levels: number = 2) {\n    if (levels <= 0) return [];\n    return fs.readdirSync(basePath).reduce((accum: string[], file) => {\n      file = path.join(basePath, file);\n      if (fs.statSync(file).isDirectory()) {\n        accum.push(...this.crawl(file, levels - 1));\n      } else if (file.match(new RegExp(`${CLI_FILE_NAME}.[cm]?js$`, \"gm\"))) {\n        accum.push(file);\n      }\n      return accum;\n    }, []);\n  }\n\n  /**\n   * @description Executes the CLI with the provided arguments\n   * @summary Boots the CLI by loading all modules, then parses and executes the command specified in the arguments\n   *\n   * @param {string[]} [args=process.argv] Command line arguments to parse and execute\n   * @return {Promise<void>} A promise that resolves when the command execution is complete\n   * \n   * @mermaid\n   * sequenceDiagram\n   *   participant Client\n   *   participant CliWrapper\n   *   participant Command\n   *   \n   *   Client->>CliWrapper: run(args)\n   *   CliWrapper->>CliWrapper: boot()\n   *   Note over CliWrapper: Loads all modules\n   *   CliWrapper->>Command: parseAsync(args)\n   *   Command-->>CliWrapper: result\n   *   CliWrapper-->>Client: result\n   */\n  async run(args: string[] = process.argv) {\n    await this.boot();\n    return this.command.parseAsync(args);\n  }\n}\n"]}

package/lib/CliWrapper.d.ts

@@ -1,10 +1,18 @@
 import { Command } from "commander";
 /**
- * @summary Util class to handle CLI functionality from all Decaf modules
- * @description CLI handler class
+ * @description Utility class to handle CLI functionality from all Decaf modules
+ * @summary This class provides a wrapper around Commander.js to handle CLI commands from different Decaf modules.
+ * It crawls the filesystem to find CLI modules, loads them, and registers their commands.
  *
- * @param {string} [basepath] the base path to look for modules in. defaults to `./`
- * @param {string} [crawlLevels] folders to crawl to find modules from the basePath. defaults to 4
+ * @param {string} [basePath] The base path to look for modules in. Defaults to `./`
+ * @param {number} [crawlLevels] Number of folder levels to crawl to find modules from the basePath. Defaults to 4
+ *
+ * @example
+ * // Create a new CLI wrapper and run it with custom options
+ * const cli = new CliWrapper('./src', 2);
+ * cli.run(process.argv).then(() => {
+ *   console.log('CLI commands executed successfully');
+ * });
  *
  * @class CliWrapper
  */
@@ -13,39 +21,103 @@ export declare class CliWrapper {
     private crawlLevels;
     private _command?;
     private modules;
+    private readonly rootPath;
     constructor(basePath?: string, crawlLevels?: number);
     /**
-     * @description Retrieves and initializes the {@link Command} object
+     * @description Retrieves and initializes the Commander Command object
+     * @summary Lazy-loads the Command object, initializing it with the package name, description, and version
+     * @return {Command} The initialized Command object
      * @private
      */
     private get command();
     /**
-     * @description loads and registers module from a file
+     * @description Loads and registers a module from a file
+     * @summary Dynamically imports a CLI module from the specified file path, initializes it, and registers it in the modules collection
      *
-     * @param {string} filePath path to look for modules
-     * @param {string} rootPath repo root to find the package.json
-     * @return {string} the module name
+     * @param {string} filePath Path to the module file to load
+     * @param {string} rootPath Repository root path to find the package.json
+     * @return {Promise<string>} A promise that resolves to the module name
      *
      * @private
+     * @mermaid
+     * sequenceDiagram
+     *   participant CliWrapper
+     *   participant CLIUtils
+     *   participant Module
+     *
+     *   CliWrapper->>CLIUtils: loadFromFile(filePath)
+     *   CLIUtils-->>CliWrapper: module
+     *   CliWrapper->>CliWrapper: Get module name
+     *   CliWrapper->>Command: new Command()
+     *   Command-->>CliWrapper: cmd
+     *   CliWrapper->>CLIUtils: initialize(cmd, path.dirname(rootPath))
+     *   CliWrapper->>Module: module()
+     *   Note over CliWrapper,Module: Handle Promise if needed
+     *   Module-->>CliWrapper: Command instance
+     *   CliWrapper->>CliWrapper: Store in modules[name]
+     *   CliWrapper-->>CliWrapper: Return name
      */
     private load;
     /**
-     * @description finds all the cli modules in the basePath via {@link CliWrapper.crawl}
-     * and loads them
+     * @description Finds and loads all CLI modules in the basePath
+     * @summary Uses the crawl method to find all CLI modules in the specified base path,
+     * then loads and registers each module as a subcommand
+     *
+     * @return {Promise<void>} A promise that resolves when all modules are loaded
+     *
      * @private
+     * @mermaid
+     * sequenceDiagram
+     *   participant CliWrapper
+     *   participant Filesystem
+     *   participant Module
+     *
+     *   CliWrapper->>Filesystem: Join basePath with cwd
+     *   CliWrapper->>CliWrapper: crawl(basePath, crawlLevels)
+     *   CliWrapper-->>CliWrapper: modules[]
+     *   loop For each module
+     *     alt Not @decaf-ts/cli
+     *       CliWrapper->>CliWrapper: load(module, cwd)
+     *       CliWrapper-->>CliWrapper: name
+     *       CliWrapper->>CliWrapper: Check if command exists
+     *       alt Command doesn't exist
+     *         CliWrapper->>Command: command(name).addCommand(modules[name])
+     *       end
+     *     end
+     *   end
+     *   CliWrapper->>Console: Log loaded modules
      */
     private boot;
     /**
-     * @description crawls the basePath up for 'levels' folders to find a module,eg a {@link CLI_FILE_NAME} named file
-     * @param {string} basePath the relative base batch to start searching in
-     * @param {number} [levels] the max number of levels to crawl. defaults to 2
+     * @description Recursively searches for CLI module files in the directory structure
+     * @summary Crawls the basePath up to the specified number of folder levels to find files named according to CLI_FILE_NAME
+     *
+     * @param {string} basePath The absolute base path to start searching in
+     * @param {number} [levels=2] The maximum number of directory levels to crawl
+     * @return {string[]} An array of file paths to CLI modules
+     *
      * @private
      */
     private crawl;
     /**
-     * @description runs the given command
+     * @description Executes the CLI with the provided arguments
+     * @summary Boots the CLI by loading all modules, then parses and executes the command specified in the arguments
+     *
+     * @param {string[]} [args=process.argv] Command line arguments to parse and execute
+     * @return {Promise<void>} A promise that resolves when the command execution is complete
+     *
+     * @mermaid
+     * sequenceDiagram
+     *   participant Client
+     *   participant CliWrapper
+     *   participant Command
      *
-     * @param {string[]} [args] args to run. defaults to process.argv
+     *   Client->>CliWrapper: run(args)
+     *   CliWrapper->>CliWrapper: boot()
+     *   Note over CliWrapper: Loads all modules
+     *   CliWrapper->>Command: parseAsync(args)
+     *   Command-->>CliWrapper: result
+     *   CliWrapper-->>Client: result
      */
     run(args?: string[]): Promise<Command>;
 }

package/lib/bin/cli.cjs

@@ -4,20 +4,28 @@
  * BIN_CALL_PLACEHOLDER - DO NOT REMOVE
  */
 /**
- * @description Decaf-ts' CLI entry file
- * @summary This file will crawl the current working directory for files called {@link CLI_FILE_NAME}
- * within the @decaf-ts namespace and load then as subcommands
+ * @description Decaf-ts' CLI entry point
+ * @summary This file serves as the main executable entry point for the Decaf CLI. It creates a CliWrapper instance
+ * and runs it with the process arguments. The CLI will crawl the current working directory for files called
+ * CLI_FILE_NAME within the @decaf-ts namespace and load them as subcommands.
  *
  * @example
- * run module command     - $ npx decaf <module name> <module command> ...<module command options>
- * get module help        - $ npx decaf help <module name>;
- * list imported modules  - $ npx decaf list;
- * get cli help           - $ npx decaf help;
+ * // Run a module command
+ * $ npx decaf <module name> <module command> ...<module command options>
+ *
+ * // Get help for a specific module
+ * $ npx decaf help <module name>
+ *
+ * // List all imported modules
+ * $ npx decaf list
+ *
+ * // Get general CLI help
+ * $ npx decaf help
  *
  * @memberOf module:CLI
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-const CliWrapper_1 = require("../CliWrapper.cjs");
+const CliWrapper_1 = require("./../CliWrapper.cjs");
 new CliWrapper_1.CliWrapper()
     .run(process.argv)
     .then(() => {
@@ -27,4 +35,4 @@ new CliWrapper_1.CliWrapper()
     console.error(`${e instanceof Error ? e.message : e}`);
     process.exit(1);
 });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2xpLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2Jpbi9jbGkudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBOztHQUVHO0FBQ0g7Ozs7Ozs7Ozs7OztHQVlHOztBQUVILDhDQUEyQztBQUMzQyxJQUFJLHVCQUFVLEVBQUU7S0FDYixHQUFHLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQztLQUNqQixJQUFJLENBQUMsR0FBRyxFQUFFO0lBQ1QsT0FBTyxDQUFDLEdBQUcsQ0FBQyxzREFBc0QsQ0FBQyxDQUFDO0FBQ3RFLENBQUMsQ0FBQztLQUNELEtBQUssQ0FBQyxDQUFDLENBQVUsRUFBRSxFQUFFO0lBQ3BCLE9BQU8sQ0FBQyxLQUFLLENBQUMsR0FBRyxDQUFDLFlBQVksS0FBSyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxDQUFDO0lBQ3ZELE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLENBQUM7QUFDbEIsQ0FBQyxDQUFDLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyIvKipcbiAqIEJJTl9DQUxMX1BMQUNFSE9MREVSIC0gRE8gTk9UIFJFTU9WRVxuICovXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBEZWNhZi10cycgQ0xJIGVudHJ5IGZpbGVcbiAqIEBzdW1tYXJ5IFRoaXMgZmlsZSB3aWxsIGNyYXdsIHRoZSBjdXJyZW50IHdvcmtpbmcgZGlyZWN0b3J5IGZvciBmaWxlcyBjYWxsZWQge0BsaW5rIENMSV9GSUxFX05BTUV9XG4gKiB3aXRoaW4gdGhlIEBkZWNhZi10cyBuYW1lc3BhY2UgYW5kIGxvYWQgdGhlbiBhcyBzdWJjb21tYW5kc1xuICpcbiAqIEBleGFtcGxlXG4gKiBydW4gbW9kdWxlIGNvbW1hbmQgICAgIC0gJCBucHggZGVjYWYgPG1vZHVsZSBuYW1lPiA8bW9kdWxlIGNvbW1hbmQ+IC4uLjxtb2R1bGUgY29tbWFuZCBvcHRpb25zPlxuICogZ2V0IG1vZHVsZSBoZWxwICAgICAgICAtICQgbnB4IGRlY2FmIGhlbHAgPG1vZHVsZSBuYW1lPjtcbiAqIGxpc3QgaW1wb3J0ZWQgbW9kdWxlcyAgLSAkIG5weCBkZWNhZiBsaXN0O1xuICogZ2V0IGNsaSBoZWxwICAgICAgICAgICAtICQgbnB4IGRlY2FmIGhlbHA7XG4gKlxuICogQG1lbWJlck9mIG1vZHVsZTpDTElcbiAqL1xuXG5pbXBvcnQgeyBDbGlXcmFwcGVyIH0gZnJvbSBcIi4uL0NsaVdyYXBwZXJcIjtcbm5ldyBDbGlXcmFwcGVyKClcbiAgLnJ1bihwcm9jZXNzLmFyZ3YpXG4gIC50aGVuKCgpID0+IHtcbiAgICBjb25zb2xlLmxvZyhcIlRoYW5rIHlvdSBmb3IgdXNpbmcgZGVjYWYtdHMnIGNvbW1hbmQgbGluZSBpbnRlcmZhY2VcIik7XG4gIH0pXG4gIC5jYXRjaCgoZTogdW5rbm93bikgPT4ge1xuICAgIGNvbnNvbGUuZXJyb3IoYCR7ZSBpbnN0YW5jZW9mIEVycm9yID8gZS5tZXNzYWdlIDogZX1gKTtcbiAgICBwcm9jZXNzLmV4aXQoMSk7XG4gIH0pO1xuIl19
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2xpLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2Jpbi9jbGkudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBOztHQUVHO0FBQ0g7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0dBb0JHOztBQUVILG9EQUEyQztBQUMzQyxJQUFJLHVCQUFVLEVBQUU7S0FDYixHQUFHLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQztLQUNqQixJQUFJLENBQUMsR0FBRyxFQUFFO0lBQ1QsT0FBTyxDQUFDLEdBQUcsQ0FBQyxzREFBc0QsQ0FBQyxDQUFDO0FBQ3RFLENBQUMsQ0FBQztLQUNELEtBQUssQ0FBQyxDQUFDLENBQVUsRUFBRSxFQUFFO0lBQ3BCLE9BQU8sQ0FBQyxLQUFLLENBQUMsR0FBRyxDQUFDLFlBQVksS0FBSyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxDQUFDO0lBQ3ZELE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLENBQUM7QUFDbEIsQ0FBQyxDQUFDLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyIvKipcbiAqIEJJTl9DQUxMX1BMQUNFSE9MREVSIC0gRE8gTk9UIFJFTU9WRVxuICovXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBEZWNhZi10cycgQ0xJIGVudHJ5IHBvaW50XG4gKiBAc3VtbWFyeSBUaGlzIGZpbGUgc2VydmVzIGFzIHRoZSBtYWluIGV4ZWN1dGFibGUgZW50cnkgcG9pbnQgZm9yIHRoZSBEZWNhZiBDTEkuIEl0IGNyZWF0ZXMgYSBDbGlXcmFwcGVyIGluc3RhbmNlXG4gKiBhbmQgcnVucyBpdCB3aXRoIHRoZSBwcm9jZXNzIGFyZ3VtZW50cy4gVGhlIENMSSB3aWxsIGNyYXdsIHRoZSBjdXJyZW50IHdvcmtpbmcgZGlyZWN0b3J5IGZvciBmaWxlcyBjYWxsZWRcbiAqIENMSV9GSUxFX05BTUUgd2l0aGluIHRoZSBAZGVjYWYtdHMgbmFtZXNwYWNlIGFuZCBsb2FkIHRoZW0gYXMgc3ViY29tbWFuZHMuXG4gKlxuICogQGV4YW1wbGVcbiAqIC8vIFJ1biBhIG1vZHVsZSBjb21tYW5kXG4gKiAkIG5weCBkZWNhZiA8bW9kdWxlIG5hbWU+IDxtb2R1bGUgY29tbWFuZD4gLi4uPG1vZHVsZSBjb21tYW5kIG9wdGlvbnM+XG4gKiBcbiAqIC8vIEdldCBoZWxwIGZvciBhIHNwZWNpZmljIG1vZHVsZVxuICogJCBucHggZGVjYWYgaGVscCA8bW9kdWxlIG5hbWU+XG4gKiBcbiAqIC8vIExpc3QgYWxsIGltcG9ydGVkIG1vZHVsZXNcbiAqICQgbnB4IGRlY2FmIGxpc3RcbiAqIFxuICogLy8gR2V0IGdlbmVyYWwgQ0xJIGhlbHBcbiAqICQgbnB4IGRlY2FmIGhlbHBcbiAqXG4gKiBAbWVtYmVyT2YgbW9kdWxlOkNMSVxuICovXG5cbmltcG9ydCB7IENsaVdyYXBwZXIgfSBmcm9tIFwiLi4vQ2xpV3JhcHBlclwiO1xubmV3IENsaVdyYXBwZXIoKVxuICAucnVuKHByb2Nlc3MuYXJndilcbiAgLnRoZW4oKCkgPT4ge1xuICAgIGNvbnNvbGUubG9nKFwiVGhhbmsgeW91IGZvciB1c2luZyBkZWNhZi10cycgY29tbWFuZCBsaW5lIGludGVyZmFjZVwiKTtcbiAgfSlcbiAgLmNhdGNoKChlOiB1bmtub3duKSA9PiB7XG4gICAgY29uc29sZS5lcnJvcihgJHtlIGluc3RhbmNlb2YgRXJyb3IgPyBlLm1lc3NhZ2UgOiBlfWApO1xuICAgIHByb2Nlc3MuZXhpdCgxKTtcbiAgfSk7XG4iXX0=

package/lib/bin/cli.d.ts

@@ -2,15 +2,23 @@
  * BIN_CALL_PLACEHOLDER - DO NOT REMOVE
  */
 /**
- * @description Decaf-ts' CLI entry file
- * @summary This file will crawl the current working directory for files called {@link CLI_FILE_NAME}
- * within the @decaf-ts namespace and load then as subcommands
+ * @description Decaf-ts' CLI entry point
+ * @summary This file serves as the main executable entry point for the Decaf CLI. It creates a CliWrapper instance
+ * and runs it with the process arguments. The CLI will crawl the current working directory for files called
+ * CLI_FILE_NAME within the @decaf-ts namespace and load them as subcommands.
  *
  * @example
- * run module command     - $ npx decaf <module name> <module command> ...<module command options>
- * get module help        - $ npx decaf help <module name>;
- * list imported modules  - $ npx decaf list;
- * get cli help           - $ npx decaf help;
+ * // Run a module command
+ * $ npx decaf <module name> <module command> ...<module command options>
+ *
+ * // Get help for a specific module
+ * $ npx decaf help <module name>
+ *
+ * // List all imported modules
+ * $ npx decaf list
+ *
+ * // Get general CLI help
+ * $ npx decaf help
  *
  * @memberOf module:CLI
  */

package/lib/constants.cjs

@@ -2,11 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CLI_FILE_NAME = void 0;
 /**
- * @description The name for decaf cli modules where each library must export
- * a single {@link CliModule}
+ * @description The filename that identifies Decaf CLI modules
+ * @summary The standard filename for CLI module files where each library must export a single CliModule function
  *
- * @constant
- * @memberOf module:CLI.cli
+ * @const CLI_FILE_NAME
+ * @memberOf module:CLI
  */
 exports.CLI_FILE_NAME = "cli-module";
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uc3RhbnRzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2NvbnN0YW50cy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFHQTs7Ozs7O0dBTUc7QUFDVSxRQUFBLGFBQWEsR0FBRyxZQUFZLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyIvLyBlc2xpbnQtZGlzYWJsZS1uZXh0LWxpbmUgQHR5cGVzY3JpcHQtZXNsaW50L25vLXVudXNlZC12YXJzXG5pbXBvcnQgeyBDbGlNb2R1bGUgfSBmcm9tIFwiLi90eXBlc1wiO1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBUaGUgbmFtZSBmb3IgZGVjYWYgY2xpIG1vZHVsZXMgd2hlcmUgZWFjaCBsaWJyYXJ5IG11c3QgZXhwb3J0XG4gKiBhIHNpbmdsZSB7QGxpbmsgQ2xpTW9kdWxlfVxuICpcbiAqIEBjb25zdGFudFxuICogQG1lbWJlck9mIG1vZHVsZTpDTEkuY2xpXG4gKi9cbmV4cG9ydCBjb25zdCBDTElfRklMRV9OQU1FID0gXCJjbGktbW9kdWxlXCI7XG4iXX0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uc3RhbnRzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2NvbnN0YW50cy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFHQTs7Ozs7O0dBTUc7QUFDVSxRQUFBLGFBQWEsR0FBRyxZQUFZLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyIvLyBlc2xpbnQtZGlzYWJsZS1uZXh0LWxpbmUgQHR5cGVzY3JpcHQtZXNsaW50L25vLXVudXNlZC12YXJzXG5pbXBvcnQgeyBDbGlNb2R1bGUgfSBmcm9tIFwiLi90eXBlc1wiO1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBUaGUgZmlsZW5hbWUgdGhhdCBpZGVudGlmaWVzIERlY2FmIENMSSBtb2R1bGVzXG4gKiBAc3VtbWFyeSBUaGUgc3RhbmRhcmQgZmlsZW5hbWUgZm9yIENMSSBtb2R1bGUgZmlsZXMgd2hlcmUgZWFjaCBsaWJyYXJ5IG11c3QgZXhwb3J0IGEgc2luZ2xlIENsaU1vZHVsZSBmdW5jdGlvblxuICpcbiAqIEBjb25zdCBDTElfRklMRV9OQU1FXG4gKiBAbWVtYmVyT2YgbW9kdWxlOkNMSVxuICovXG5leHBvcnQgY29uc3QgQ0xJX0ZJTEVfTkFNRSA9IFwiY2xpLW1vZHVsZVwiO1xuIl19

package/lib/constants.d.ts

@@ -1,8 +1,8 @@
 /**
- * @description The name for decaf cli modules where each library must export
- * a single {@link CliModule}
+ * @description The filename that identifies Decaf CLI modules
+ * @summary The standard filename for CLI module files where each library must export a single CliModule function
  *
- * @constant
- * @memberOf module:CLI.cli
+ * @const CLI_FILE_NAME
+ * @memberOf module:CLI
  */
 export declare const CLI_FILE_NAME = "cli-module";

package/lib/demo/cli-module.cjs

@@ -3,29 +3,37 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = demo;
 const commander_1 = require("commander");
 /**
- * @description demo CLI module for libraries
- * @summary minimal implementation on how to extend the decaf-ts cli
+ * @description Demo CLI module for Decaf libraries
+ * @summary A minimal implementation showing how to extend the Decaf CLI with custom commands.
+ * This module demonstrates the pattern for creating CLI modules that can be discovered and loaded by the Decaf CLI.
  *
- * - the function must be ***exported by default***!;
- * - The name of the returned function will be considered to be the base command;
- * - the command you return will be considered as a subCommand and will not be called directly
- * - Commands must be transpiled under the same ts-configuration as this module
- * (so copy the ts-config of this module to your project. we propose `tsconfig.cli.json`)
- * - Following your build pipeline include `tsc --project tsconfig.cli.json --outDir <dist folder>/cli`
- *
- * Note the extra use of `cli` on the outDir param. this is meant to completely separate
- * the cli code from your source, in case they are transpiled under different ts-configurations
- *
- * @returns {Command} the subCommand to be added to the main decaf CLI
+ * @return {Command} The Command object to be added to the main Decaf CLI
  *
  * @function demo
- *
- * @category Command Line Interface
+ * @memberOf module:CLI
  *
  * @example
- * `npx decaf demo command "something something" `
+ * // Run the demo command with an argument
+ * npx decaf demo command "something something"
+ *
+ * // Output:
+ * // executed demo command with type variable: something something
+ *
+ * @mermaid
+ * sequenceDiagram
+ *   participant User
+ *   participant CLI
+ *   participant DemoModule
+ *   participant Command
  *
- * will output `executed demo command with type variable: something something`
+ *   User->>CLI: npx decaf demo command "arg"
+ *   CLI->>DemoModule: Load module
+ *   DemoModule->>Command: Create command
+ *   Command->>Command: Configure action
+ *   Command-->>DemoModule: Return command
+ *   DemoModule-->>CLI: Return command
+ *   CLI->>Command: Execute with args
+ *   Command->>Console: Log output
  */
 function demo() {
     return new commander_1.Command()
@@ -35,4 +43,4 @@ function demo() {
         console.log(`executed demo command with type variable: ${args}`);
     });
 }
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2xpLW1vZHVsZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9kZW1vL2NsaS1tb2R1bGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUEyQkEsdUJBT0M7QUFsQ0QseUNBQW9DO0FBRXBDOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7R0F3Qkc7QUFDSCxTQUF3QixJQUFJO0lBQzFCLE9BQU8sSUFBSSxtQkFBTyxFQUFFO1NBQ2pCLE9BQU8sQ0FBQyxnQkFBZ0IsQ0FBQztTQUN6QixXQUFXLENBQUMsZ0JBQWdCLENBQUM7U0FDN0IsTUFBTSxDQUFDLENBQUMsSUFBWSxFQUFFLEVBQUU7UUFDdkIsT0FBTyxDQUFDLEdBQUcsQ0FBQyw2Q0FBNkMsSUFBSSxFQUFFLENBQUMsQ0FBQztJQUNuRSxDQUFDLENBQUMsQ0FBQztBQUNQLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBDb21tYW5kIH0gZnJvbSBcImNvbW1hbmRlclwiO1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBkZW1vIENMSSBtb2R1bGUgZm9yIGxpYnJhcmllc1xuICogQHN1bW1hcnkgbWluaW1hbCBpbXBsZW1lbnRhdGlvbiBvbiBob3cgdG8gZXh0ZW5kIHRoZSBkZWNhZi10cyBjbGlcbiAqXG4gKiAtIHRoZSBmdW5jdGlvbiBtdXN0IGJlICoqKmV4cG9ydGVkIGJ5IGRlZmF1bHQqKiohO1xuICogLSBUaGUgbmFtZSBvZiB0aGUgcmV0dXJuZWQgZnVuY3Rpb24gd2lsbCBiZSBjb25zaWRlcmVkIHRvIGJlIHRoZSBiYXNlIGNvbW1hbmQ7XG4gKiAtIHRoZSBjb21tYW5kIHlvdSByZXR1cm4gd2lsbCBiZSBjb25zaWRlcmVkIGFzIGEgc3ViQ29tbWFuZCBhbmQgd2lsbCBub3QgYmUgY2FsbGVkIGRpcmVjdGx5XG4gKiAtIENvbW1hbmRzIG11c3QgYmUgdHJhbnNwaWxlZCB1bmRlciB0aGUgc2FtZSB0cy1jb25maWd1cmF0aW9uIGFzIHRoaXMgbW9kdWxlXG4gKiAoc28gY29weSB0aGUgdHMtY29uZmlnIG9mIHRoaXMgbW9kdWxlIHRvIHlvdXIgcHJvamVjdC4gd2UgcHJvcG9zZSBgdHNjb25maWcuY2xpLmpzb25gKVxuICogLSBGb2xsb3dpbmcgeW91ciBidWlsZCBwaXBlbGluZSBpbmNsdWRlIGB0c2MgLS1wcm9qZWN0IHRzY29uZmlnLmNsaS5qc29uIC0tb3V0RGlyIDxkaXN0IGZvbGRlcj4vY2xpYFxuICpcbiAqIE5vdGUgdGhlIGV4dHJhIHVzZSBvZiBgY2xpYCBvbiB0aGUgb3V0RGlyIHBhcmFtLiB0aGlzIGlzIG1lYW50IHRvIGNvbXBsZXRlbHkgc2VwYXJhdGVcbiAqIHRoZSBjbGkgY29kZSBmcm9tIHlvdXIgc291cmNlLCBpbiBjYXNlIHRoZXkgYXJlIHRyYW5zcGlsZWQgdW5kZXIgZGlmZmVyZW50IHRzLWNvbmZpZ3VyYXRpb25zXG4gKlxuICogQHJldHVybnMge0NvbW1hbmR9IHRoZSBzdWJDb21tYW5kIHRvIGJlIGFkZGVkIHRvIHRoZSBtYWluIGRlY2FmIENMSVxuICpcbiAqIEBmdW5jdGlvbiBkZW1vXG4gKlxuICogQGNhdGVnb3J5IENvbW1hbmQgTGluZSBJbnRlcmZhY2VcbiAqXG4gKiBAZXhhbXBsZVxuICogYG5weCBkZWNhZiBkZW1vIGNvbW1hbmQgXCJzb21ldGhpbmcgc29tZXRoaW5nXCIgYFxuICpcbiAqIHdpbGwgb3V0cHV0IGBleGVjdXRlZCBkZW1vIGNvbW1hbmQgd2l0aCB0eXBlIHZhcmlhYmxlOiBzb21ldGhpbmcgc29tZXRoaW5nYFxuICovXG5leHBvcnQgZGVmYXVsdCBmdW5jdGlvbiBkZW1vKCk6IENvbW1hbmQge1xuICByZXR1cm4gbmV3IENvbW1hbmQoKVxuICAgIC5jb21tYW5kKFwiY29tbWFuZCA8dHlwZT5cIilcbiAgICAuZGVzY3JpcHRpb24oXCJBIGRlbW8gY29tbWFuZFwiKVxuICAgIC5hY3Rpb24oKGFyZ3M6IHN0cmluZykgPT4ge1xuICAgICAgY29uc29sZS5sb2coYGV4ZWN1dGVkIGRlbW8gY29tbWFuZCB3aXRoIHR5cGUgdmFyaWFibGU6ICR7YXJnc31gKTtcbiAgICB9KTtcbn1cbiJdfQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2xpLW1vZHVsZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9kZW1vL2NsaS1tb2R1bGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFtQ0EsdUJBT0M7QUExQ0QseUNBQW9DO0FBRXBDOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztHQWdDRztBQUNILFNBQXdCLElBQUk7SUFDMUIsT0FBTyxJQUFJLG1CQUFPLEVBQUU7U0FDakIsT0FBTyxDQUFDLGdCQUFnQixDQUFDO1NBQ3pCLFdBQVcsQ0FBQyxnQkFBZ0IsQ0FBQztTQUM3QixNQUFNLENBQUMsQ0FBQyxJQUFZLEVBQUUsRUFBRTtRQUN2QixPQUFPLENBQUMsR0FBRyxDQUFDLDZDQUE2QyxJQUFJLEVBQUUsQ0FBQyxDQUFDO0lBQ25FLENBQUMsQ0FBQyxDQUFDO0FBQ1AsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IENvbW1hbmQgfSBmcm9tIFwiY29tbWFuZGVyXCI7XG5cbi8qKlxuICogQGRlc2NyaXB0aW9uIERlbW8gQ0xJIG1vZHVsZSBmb3IgRGVjYWYgbGlicmFyaWVzXG4gKiBAc3VtbWFyeSBBIG1pbmltYWwgaW1wbGVtZW50YXRpb24gc2hvd2luZyBob3cgdG8gZXh0ZW5kIHRoZSBEZWNhZiBDTEkgd2l0aCBjdXN0b20gY29tbWFuZHMuXG4gKiBUaGlzIG1vZHVsZSBkZW1vbnN0cmF0ZXMgdGhlIHBhdHRlcm4gZm9yIGNyZWF0aW5nIENMSSBtb2R1bGVzIHRoYXQgY2FuIGJlIGRpc2NvdmVyZWQgYW5kIGxvYWRlZCBieSB0aGUgRGVjYWYgQ0xJLlxuICpcbiAqIEByZXR1cm4ge0NvbW1hbmR9IFRoZSBDb21tYW5kIG9iamVjdCB0byBiZSBhZGRlZCB0byB0aGUgbWFpbiBEZWNhZiBDTElcbiAqXG4gKiBAZnVuY3Rpb24gZGVtb1xuICogQG1lbWJlck9mIG1vZHVsZTpDTElcbiAqXG4gKiBAZXhhbXBsZVxuICogLy8gUnVuIHRoZSBkZW1vIGNvbW1hbmQgd2l0aCBhbiBhcmd1bWVudFxuICogbnB4IGRlY2FmIGRlbW8gY29tbWFuZCBcInNvbWV0aGluZyBzb21ldGhpbmdcIlxuICpcbiAqIC8vIE91dHB1dDpcbiAqIC8vIGV4ZWN1dGVkIGRlbW8gY29tbWFuZCB3aXRoIHR5cGUgdmFyaWFibGU6IHNvbWV0aGluZyBzb21ldGhpbmdcbiAqXG4gKiBAbWVybWFpZFxuICogc2VxdWVuY2VEaWFncmFtXG4gKiAgIHBhcnRpY2lwYW50IFVzZXJcbiAqICAgcGFydGljaXBhbnQgQ0xJXG4gKiAgIHBhcnRpY2lwYW50IERlbW9Nb2R1bGVcbiAqICAgcGFydGljaXBhbnQgQ29tbWFuZFxuICpcbiAqICAgVXNlci0+PkNMSTogbnB4IGRlY2FmIGRlbW8gY29tbWFuZCBcImFyZ1wiXG4gKiAgIENMSS0+PkRlbW9Nb2R1bGU6IExvYWQgbW9kdWxlXG4gKiAgIERlbW9Nb2R1bGUtPj5Db21tYW5kOiBDcmVhdGUgY29tbWFuZFxuICogICBDb21tYW5kLT4+Q29tbWFuZDogQ29uZmlndXJlIGFjdGlvblxuICogICBDb21tYW5kLS0+PkRlbW9Nb2R1bGU6IFJldHVybiBjb21tYW5kXG4gKiAgIERlbW9Nb2R1bGUtLT4+Q0xJOiBSZXR1cm4gY29tbWFuZFxuICogICBDTEktPj5Db21tYW5kOiBFeGVjdXRlIHdpdGggYXJnc1xuICogICBDb21tYW5kLT4+Q29uc29sZTogTG9nIG91dHB1dFxuICovXG5leHBvcnQgZGVmYXVsdCBmdW5jdGlvbiBkZW1vKCk6IENvbW1hbmQge1xuICByZXR1cm4gbmV3IENvbW1hbmQoKVxuICAgIC5jb21tYW5kKFwiY29tbWFuZCA8dHlwZT5cIilcbiAgICAuZGVzY3JpcHRpb24oXCJBIGRlbW8gY29tbWFuZFwiKVxuICAgIC5hY3Rpb24oKGFyZ3M6IHN0cmluZykgPT4ge1xuICAgICAgY29uc29sZS5sb2coYGV4ZWN1dGVkIGRlbW8gY29tbWFuZCB3aXRoIHR5cGUgdmFyaWFibGU6ICR7YXJnc31gKTtcbiAgICB9KTtcbn1cbiJdfQ==

package/lib/demo/cli-module.d.ts

@@ -1,27 +1,35 @@
 import { Command } from "commander";
 /**
- * @description demo CLI module for libraries
- * @summary minimal implementation on how to extend the decaf-ts cli
+ * @description Demo CLI module for Decaf libraries
+ * @summary A minimal implementation showing how to extend the Decaf CLI with custom commands.
+ * This module demonstrates the pattern for creating CLI modules that can be discovered and loaded by the Decaf CLI.
  *
- * - the function must be ***exported by default***!;
- * - The name of the returned function will be considered to be the base command;
- * - the command you return will be considered as a subCommand and will not be called directly
- * - Commands must be transpiled under the same ts-configuration as this module
- * (so copy the ts-config of this module to your project. we propose `tsconfig.cli.json`)
- * - Following your build pipeline include `tsc --project tsconfig.cli.json --outDir <dist folder>/cli`
- *
- * Note the extra use of `cli` on the outDir param. this is meant to completely separate
- * the cli code from your source, in case they are transpiled under different ts-configurations
- *
- * @returns {Command} the subCommand to be added to the main decaf CLI
+ * @return {Command} The Command object to be added to the main Decaf CLI
  *
  * @function demo
- *
- * @category Command Line Interface
+ * @memberOf module:CLI
  *
  * @example
- * `npx decaf demo command "something something" `
+ * // Run the demo command with an argument
+ * npx decaf demo command "something something"
+ *
+ * // Output:
+ * // executed demo command with type variable: something something
+ *
+ * @mermaid
+ * sequenceDiagram
+ *   participant User
+ *   participant CLI
+ *   participant DemoModule
+ *   participant Command
  *
- * will output `executed demo command with type variable: something something`
+ *   User->>CLI: npx decaf demo command "arg"
+ *   CLI->>DemoModule: Load module
+ *   DemoModule->>Command: Create command
+ *   Command->>Command: Configure action
+ *   Command-->>DemoModule: Return command
+ *   DemoModule-->>CLI: Return command
+ *   CLI->>Command: Execute with args
+ *   Command->>Console: Log output
  */
 export default function demo(): Command;