@decaf-ts/cli 0.3.5 → 0.3.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -10,11 +10,19 @@ const path_1 = __importDefault(require("path"));
10
10
  const constants_1 = require("./constants.cjs");
11
11
  const utils_1 = require("./utils.cjs");
12
12
  /**
13
- * @summary Util class to handle CLI functionality from all Decaf modules
14
- * @description CLI handler class
13
+ * @description Utility class to handle CLI functionality from all Decaf modules
14
+ * @summary This class provides a wrapper around Commander.js to handle CLI commands from different Decaf modules.
15
+ * It crawls the filesystem to find CLI modules, loads them, and registers their commands.
15
16
  *
16
- * @param {string} [basepath] the base path to look for modules in. defaults to `./`
17
- * @param {string} [crawlLevels] folders to crawl to find modules from the basePath. defaults to 4
17
+ * @param {string} [basePath] The base path to look for modules in. Defaults to `./`
18
+ * @param {number} [crawlLevels] Number of folder levels to crawl to find modules from the basePath. Defaults to 4
19
+ *
20
+ * @example
21
+ * // Create a new CLI wrapper and run it with custom options
22
+ * const cli = new CliWrapper('./src', 2);
23
+ * cli.run(process.argv).then(() => {
24
+ * console.log('CLI commands executed successfully');
25
+ * });
18
26
  *
19
27
  * @class CliWrapper
20
28
  */
@@ -23,26 +31,47 @@ class CliWrapper {
23
31
  this.basePath = basePath;
24
32
  this.crawlLevels = crawlLevels;
25
33
  this.modules = {};
34
+ this.rootPath = path_1.default.resolve(__dirname, "..");
26
35
  }
27
36
  /**
28
- * @description Retrieves and initializes the {@link Command} object
37
+ * @description Retrieves and initializes the Commander Command object
38
+ * @summary Lazy-loads the Command object, initializing it with the package name, description, and version
39
+ * @return {Command} The initialized Command object
29
40
  * @private
30
41
  */
31
42
  get command() {
32
43
  if (!this._command) {
33
44
  this._command = new commander_1.Command();
34
- utils_1.CLIUtils.initialize(this._command, this.basePath);
45
+ utils_1.CLIUtils.initialize(this._command, this.rootPath);
35
46
  }
36
47
  return this._command;
37
48
  }
38
49
  /**
39
- * @description loads and registers module from a file
50
+ * @description Loads and registers a module from a file
51
+ * @summary Dynamically imports a CLI module from the specified file path, initializes it, and registers it in the modules collection
40
52
  *
41
- * @param {string} filePath path to look for modules
42
- * @param {string} rootPath repo root to find the package.json
43
- * @return {string} the module name
53
+ * @param {string} filePath Path to the module file to load
54
+ * @param {string} rootPath Repository root path to find the package.json
55
+ * @return {Promise<string>} A promise that resolves to the module name
44
56
  *
45
57
  * @private
58
+ * @mermaid
59
+ * sequenceDiagram
60
+ * participant CliWrapper
61
+ * participant CLIUtils
62
+ * participant Module
63
+ *
64
+ * CliWrapper->>CLIUtils: loadFromFile(filePath)
65
+ * CLIUtils-->>CliWrapper: module
66
+ * CliWrapper->>CliWrapper: Get module name
67
+ * CliWrapper->>Command: new Command()
68
+ * Command-->>CliWrapper: cmd
69
+ * CliWrapper->>CLIUtils: initialize(cmd, path.dirname(rootPath))
70
+ * CliWrapper->>Module: module()
71
+ * Note over CliWrapper,Module: Handle Promise if needed
72
+ * Module-->>CliWrapper: Command instance
73
+ * CliWrapper->>CliWrapper: Store in modules[name]
74
+ * CliWrapper-->>CliWrapper: Return name
46
75
  */
47
76
  async load(filePath, rootPath) {
48
77
  let name;
@@ -50,7 +79,7 @@ class CliWrapper {
50
79
  const module = await utils_1.CLIUtils.loadFromFile(filePath);
51
80
  name = module.name;
52
81
  const cmd = new commander_1.Command();
53
- utils_1.CLIUtils.initialize(cmd, path_1.default.dirname(rootPath));
82
+ utils_1.CLIUtils.initialize(cmd, rootPath);
54
83
  let m = module();
55
84
  if (m instanceof Promise)
56
85
  m = await m;
@@ -62,12 +91,36 @@ class CliWrapper {
62
91
  return name;
63
92
  }
64
93
  /**
65
- * @description finds all the cli modules in the basePath via {@link CliWrapper.crawl}
66
- * and loads them
94
+ * @description Finds and loads all CLI modules in the basePath
95
+ * @summary Uses the crawl method to find all CLI modules in the specified base path,
96
+ * then loads and registers each module as a subcommand
97
+ *
98
+ * @return {Promise<void>} A promise that resolves when all modules are loaded
99
+ *
67
100
  * @private
101
+ * @mermaid
102
+ * sequenceDiagram
103
+ * participant CliWrapper
104
+ * participant Filesystem
105
+ * participant Module
106
+ *
107
+ * CliWrapper->>Filesystem: Join basePath with cwd
108
+ * CliWrapper->>CliWrapper: crawl(basePath, crawlLevels)
109
+ * CliWrapper-->>CliWrapper: modules[]
110
+ * loop For each module
111
+ * alt Not @decaf-ts/cli
112
+ * CliWrapper->>CliWrapper: load(module, cwd)
113
+ * CliWrapper-->>CliWrapper: name
114
+ * CliWrapper->>CliWrapper: Check if command exists
115
+ * alt Command doesn't exist
116
+ * CliWrapper->>Command: command(name).addCommand(modules[name])
117
+ * end
118
+ * end
119
+ * end
120
+ * CliWrapper->>Console: Log loaded modules
68
121
  */
69
122
  async boot() {
70
- const basePath = path_1.default.join(process.cwd(), this.basePath);
123
+ const basePath = path_1.default.resolve(this.rootPath, this.basePath);
71
124
  const modules = this.crawl(basePath, this.crawlLevels);
72
125
  for (const module of modules) {
73
126
  if (module.includes("@decaf-ts/cli")) {
@@ -75,7 +128,7 @@ class CliWrapper {
75
128
  }
76
129
  let name;
77
130
  try {
78
- name = await this.load(module, process.cwd());
131
+ name = await this.load(module, this.rootPath);
79
132
  }
80
133
  catch (e) {
81
134
  console.error(e);
@@ -94,9 +147,13 @@ class CliWrapper {
94
147
  .join("\n")}`);
95
148
  }
96
149
  /**
97
- * @description crawls the basePath up for 'levels' folders to find a module,eg a {@link CLI_FILE_NAME} named file
98
- * @param {string} basePath the relative base batch to start searching in
99
- * @param {number} [levels] the max number of levels to crawl. defaults to 2
150
+ * @description Recursively searches for CLI module files in the directory structure
151
+ * @summary Crawls the basePath up to the specified number of folder levels to find files named according to CLI_FILE_NAME
152
+ *
153
+ * @param {string} basePath The absolute base path to start searching in
154
+ * @param {number} [levels=2] The maximum number of directory levels to crawl
155
+ * @return {string[]} An array of file paths to CLI modules
156
+ *
100
157
  * @private
101
158
  */
102
159
  crawl(basePath, levels = 2) {
@@ -114,9 +171,24 @@ class CliWrapper {
114
171
  }, []);
115
172
  }
116
173
  /**
117
- * @description runs the given command
174
+ * @description Executes the CLI with the provided arguments
175
+ * @summary Boots the CLI by loading all modules, then parses and executes the command specified in the arguments
176
+ *
177
+ * @param {string[]} [args=process.argv] Command line arguments to parse and execute
178
+ * @return {Promise<void>} A promise that resolves when the command execution is complete
179
+ *
180
+ * @mermaid
181
+ * sequenceDiagram
182
+ * participant Client
183
+ * participant CliWrapper
184
+ * participant Command
118
185
  *
119
- * @param {string[]} [args] args to run. defaults to process.argv
186
+ * Client->>CliWrapper: run(args)
187
+ * CliWrapper->>CliWrapper: boot()
188
+ * Note over CliWrapper: Loads all modules
189
+ * CliWrapper->>Command: parseAsync(args)
190
+ * Command-->>CliWrapper: result
191
+ * CliWrapper-->>Client: result
120
192
  */
121
193
  async run(args = process.argv) {
122
194
  await this.boot();
@@ -124,4 +196,4 @@ class CliWrapper {
124
196
  }
125
197
  }
126
198
  exports.CliWrapper = CliWrapper;
127
- //# 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;;;;;;;;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"]}
199
+ //# 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"]}
@@ -1,10 +1,18 @@
1
1
  import { Command } from "commander";
2
2
  /**
3
- * @summary Util class to handle CLI functionality from all Decaf modules
4
- * @description CLI handler class
3
+ * @description Utility class to handle CLI functionality from all Decaf modules
4
+ * @summary This class provides a wrapper around Commander.js to handle CLI commands from different Decaf modules.
5
+ * It crawls the filesystem to find CLI modules, loads them, and registers their commands.
5
6
  *
6
- * @param {string} [basepath] the base path to look for modules in. defaults to `./`
7
- * @param {string} [crawlLevels] folders to crawl to find modules from the basePath. defaults to 4
7
+ * @param {string} [basePath] The base path to look for modules in. Defaults to `./`
8
+ * @param {number} [crawlLevels] Number of folder levels to crawl to find modules from the basePath. Defaults to 4
9
+ *
10
+ * @example
11
+ * // Create a new CLI wrapper and run it with custom options
12
+ * const cli = new CliWrapper('./src', 2);
13
+ * cli.run(process.argv).then(() => {
14
+ * console.log('CLI commands executed successfully');
15
+ * });
8
16
  *
9
17
  * @class CliWrapper
10
18
  */
@@ -13,39 +21,103 @@ export declare class CliWrapper {
13
21
  private crawlLevels;
14
22
  private _command?;
15
23
  private modules;
24
+ private readonly rootPath;
16
25
  constructor(basePath?: string, crawlLevels?: number);
17
26
  /**
18
- * @description Retrieves and initializes the {@link Command} object
27
+ * @description Retrieves and initializes the Commander Command object
28
+ * @summary Lazy-loads the Command object, initializing it with the package name, description, and version
29
+ * @return {Command} The initialized Command object
19
30
  * @private
20
31
  */
21
32
  private get command();
22
33
  /**
23
- * @description loads and registers module from a file
34
+ * @description Loads and registers a module from a file
35
+ * @summary Dynamically imports a CLI module from the specified file path, initializes it, and registers it in the modules collection
24
36
  *
25
- * @param {string} filePath path to look for modules
26
- * @param {string} rootPath repo root to find the package.json
27
- * @return {string} the module name
37
+ * @param {string} filePath Path to the module file to load
38
+ * @param {string} rootPath Repository root path to find the package.json
39
+ * @return {Promise<string>} A promise that resolves to the module name
28
40
  *
29
41
  * @private
42
+ * @mermaid
43
+ * sequenceDiagram
44
+ * participant CliWrapper
45
+ * participant CLIUtils
46
+ * participant Module
47
+ *
48
+ * CliWrapper->>CLIUtils: loadFromFile(filePath)
49
+ * CLIUtils-->>CliWrapper: module
50
+ * CliWrapper->>CliWrapper: Get module name
51
+ * CliWrapper->>Command: new Command()
52
+ * Command-->>CliWrapper: cmd
53
+ * CliWrapper->>CLIUtils: initialize(cmd, path.dirname(rootPath))
54
+ * CliWrapper->>Module: module()
55
+ * Note over CliWrapper,Module: Handle Promise if needed
56
+ * Module-->>CliWrapper: Command instance
57
+ * CliWrapper->>CliWrapper: Store in modules[name]
58
+ * CliWrapper-->>CliWrapper: Return name
30
59
  */
31
60
  private load;
32
61
  /**
33
- * @description finds all the cli modules in the basePath via {@link CliWrapper.crawl}
34
- * and loads them
62
+ * @description Finds and loads all CLI modules in the basePath
63
+ * @summary Uses the crawl method to find all CLI modules in the specified base path,
64
+ * then loads and registers each module as a subcommand
65
+ *
66
+ * @return {Promise<void>} A promise that resolves when all modules are loaded
67
+ *
35
68
  * @private
69
+ * @mermaid
70
+ * sequenceDiagram
71
+ * participant CliWrapper
72
+ * participant Filesystem
73
+ * participant Module
74
+ *
75
+ * CliWrapper->>Filesystem: Join basePath with cwd
76
+ * CliWrapper->>CliWrapper: crawl(basePath, crawlLevels)
77
+ * CliWrapper-->>CliWrapper: modules[]
78
+ * loop For each module
79
+ * alt Not @decaf-ts/cli
80
+ * CliWrapper->>CliWrapper: load(module, cwd)
81
+ * CliWrapper-->>CliWrapper: name
82
+ * CliWrapper->>CliWrapper: Check if command exists
83
+ * alt Command doesn't exist
84
+ * CliWrapper->>Command: command(name).addCommand(modules[name])
85
+ * end
86
+ * end
87
+ * end
88
+ * CliWrapper->>Console: Log loaded modules
36
89
  */
37
90
  private boot;
38
91
  /**
39
- * @description crawls the basePath up for 'levels' folders to find a module,eg a {@link CLI_FILE_NAME} named file
40
- * @param {string} basePath the relative base batch to start searching in
41
- * @param {number} [levels] the max number of levels to crawl. defaults to 2
92
+ * @description Recursively searches for CLI module files in the directory structure
93
+ * @summary Crawls the basePath up to the specified number of folder levels to find files named according to CLI_FILE_NAME
94
+ *
95
+ * @param {string} basePath The absolute base path to start searching in
96
+ * @param {number} [levels=2] The maximum number of directory levels to crawl
97
+ * @return {string[]} An array of file paths to CLI modules
98
+ *
42
99
  * @private
43
100
  */
44
101
  private crawl;
45
102
  /**
46
- * @description runs the given command
103
+ * @description Executes the CLI with the provided arguments
104
+ * @summary Boots the CLI by loading all modules, then parses and executes the command specified in the arguments
105
+ *
106
+ * @param {string[]} [args=process.argv] Command line arguments to parse and execute
107
+ * @return {Promise<void>} A promise that resolves when the command execution is complete
108
+ *
109
+ * @mermaid
110
+ * sequenceDiagram
111
+ * participant Client
112
+ * participant CliWrapper
113
+ * participant Command
47
114
  *
48
- * @param {string[]} [args] args to run. defaults to process.argv
115
+ * Client->>CliWrapper: run(args)
116
+ * CliWrapper->>CliWrapper: boot()
117
+ * Note over CliWrapper: Loads all modules
118
+ * CliWrapper->>Command: parseAsync(args)
119
+ * Command-->>CliWrapper: result
120
+ * CliWrapper-->>Client: result
49
121
  */
50
122
  run(args?: string[]): Promise<Command>;
51
123
  }
package/lib/bin/cli.cjs CHANGED
@@ -4,15 +4,23 @@
4
4
  * BIN_CALL_PLACEHOLDER - DO NOT REMOVE
5
5
  */
6
6
  /**
7
- * @description Decaf-ts' CLI entry file
8
- * @summary This file will crawl the current working directory for files called {@link CLI_FILE_NAME}
9
- * within the @decaf-ts namespace and load then as subcommands
7
+ * @description Decaf-ts' CLI entry point
8
+ * @summary This file serves as the main executable entry point for the Decaf CLI. It creates a CliWrapper instance
9
+ * and runs it with the process arguments. The CLI will crawl the current working directory for files called
10
+ * CLI_FILE_NAME within the @decaf-ts namespace and load them as subcommands.
10
11
  *
11
12
  * @example
12
- * run module command - $ npx decaf <module name> <module command> ...<module command options>
13
- * get module help - $ npx decaf help <module name>;
14
- * list imported modules - $ npx decaf list;
15
- * get cli help - $ npx decaf help;
13
+ * // Run a module command
14
+ * $ npx decaf <module name> <module command> ...<module command options>
15
+ *
16
+ * // Get help for a specific module
17
+ * $ npx decaf help <module name>
18
+ *
19
+ * // List all imported modules
20
+ * $ npx decaf list
21
+ *
22
+ * // Get general CLI help
23
+ * $ npx decaf help
16
24
  *
17
25
  * @memberOf module:CLI
18
26
  */
@@ -27,4 +35,4 @@ new CliWrapper_1.CliWrapper()
27
35
  console.error(`${e instanceof Error ? e.message : e}`);
28
36
  process.exit(1);
29
37
  });
30
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2xpLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2Jpbi9jbGkudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBOztHQUVHO0FBQ0g7Ozs7Ozs7Ozs7OztHQVlHOztBQUVILG9EQUEyQztBQUMzQyxJQUFJLHVCQUFVLEVBQUU7S0FDYixHQUFHLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQztLQUNqQixJQUFJLENBQUMsR0FBRyxFQUFFO0lBQ1QsT0FBTyxDQUFDLEdBQUcsQ0FBQyxzREFBc0QsQ0FBQyxDQUFDO0FBQ3RFLENBQUMsQ0FBQztLQUNELEtBQUssQ0FBQyxDQUFDLENBQVUsRUFBRSxFQUFFO0lBQ3BCLE9BQU8sQ0FBQyxLQUFLLENBQUMsR0FBRyxDQUFDLFlBQVksS0FBSyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxDQUFDO0lBQ3ZELE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLENBQUM7QUFDbEIsQ0FBQyxDQUFDLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyIvKipcbiAqIEJJTl9DQUxMX1BMQUNFSE9MREVSIC0gRE8gTk9UIFJFTU9WRVxuICovXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBEZWNhZi10cycgQ0xJIGVudHJ5IGZpbGVcbiAqIEBzdW1tYXJ5IFRoaXMgZmlsZSB3aWxsIGNyYXdsIHRoZSBjdXJyZW50IHdvcmtpbmcgZGlyZWN0b3J5IGZvciBmaWxlcyBjYWxsZWQge0BsaW5rIENMSV9GSUxFX05BTUV9XG4gKiB3aXRoaW4gdGhlIEBkZWNhZi10cyBuYW1lc3BhY2UgYW5kIGxvYWQgdGhlbiBhcyBzdWJjb21tYW5kc1xuICpcbiAqIEBleGFtcGxlXG4gKiBydW4gbW9kdWxlIGNvbW1hbmQgICAgIC0gJCBucHggZGVjYWYgPG1vZHVsZSBuYW1lPiA8bW9kdWxlIGNvbW1hbmQ+IC4uLjxtb2R1bGUgY29tbWFuZCBvcHRpb25zPlxuICogZ2V0IG1vZHVsZSBoZWxwICAgICAgICAtICQgbnB4IGRlY2FmIGhlbHAgPG1vZHVsZSBuYW1lPjtcbiAqIGxpc3QgaW1wb3J0ZWQgbW9kdWxlcyAgLSAkIG5weCBkZWNhZiBsaXN0O1xuICogZ2V0IGNsaSBoZWxwICAgICAgICAgICAtICQgbnB4IGRlY2FmIGhlbHA7XG4gKlxuICogQG1lbWJlck9mIG1vZHVsZTpDTElcbiAqL1xuXG5pbXBvcnQgeyBDbGlXcmFwcGVyIH0gZnJvbSBcIi4uL0NsaVdyYXBwZXJcIjtcbm5ldyBDbGlXcmFwcGVyKClcbiAgLnJ1bihwcm9jZXNzLmFyZ3YpXG4gIC50aGVuKCgpID0+IHtcbiAgICBjb25zb2xlLmxvZyhcIlRoYW5rIHlvdSBmb3IgdXNpbmcgZGVjYWYtdHMnIGNvbW1hbmQgbGluZSBpbnRlcmZhY2VcIik7XG4gIH0pXG4gIC5jYXRjaCgoZTogdW5rbm93bikgPT4ge1xuICAgIGNvbnNvbGUuZXJyb3IoYCR7ZSBpbnN0YW5jZW9mIEVycm9yID8gZS5tZXNzYWdlIDogZX1gKTtcbiAgICBwcm9jZXNzLmV4aXQoMSk7XG4gIH0pO1xuIl19
38
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2xpLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2Jpbi9jbGkudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBOztHQUVHO0FBQ0g7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0dBb0JHOztBQUVILG9EQUEyQztBQUMzQyxJQUFJLHVCQUFVLEVBQUU7S0FDYixHQUFHLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQztLQUNqQixJQUFJLENBQUMsR0FBRyxFQUFFO0lBQ1QsT0FBTyxDQUFDLEdBQUcsQ0FBQyxzREFBc0QsQ0FBQyxDQUFDO0FBQ3RFLENBQUMsQ0FBQztLQUNELEtBQUssQ0FBQyxDQUFDLENBQVUsRUFBRSxFQUFFO0lBQ3BCLE9BQU8sQ0FBQyxLQUFLLENBQUMsR0FBRyxDQUFDLFlBQVksS0FBSyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxDQUFDO0lBQ3ZELE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLENBQUM7QUFDbEIsQ0FBQyxDQUFDLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyIvKipcbiAqIEJJTl9DQUxMX1BMQUNFSE9MREVSIC0gRE8gTk9UIFJFTU9WRVxuICovXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBEZWNhZi10cycgQ0xJIGVudHJ5IHBvaW50XG4gKiBAc3VtbWFyeSBUaGlzIGZpbGUgc2VydmVzIGFzIHRoZSBtYWluIGV4ZWN1dGFibGUgZW50cnkgcG9pbnQgZm9yIHRoZSBEZWNhZiBDTEkuIEl0IGNyZWF0ZXMgYSBDbGlXcmFwcGVyIGluc3RhbmNlXG4gKiBhbmQgcnVucyBpdCB3aXRoIHRoZSBwcm9jZXNzIGFyZ3VtZW50cy4gVGhlIENMSSB3aWxsIGNyYXdsIHRoZSBjdXJyZW50IHdvcmtpbmcgZGlyZWN0b3J5IGZvciBmaWxlcyBjYWxsZWRcbiAqIENMSV9GSUxFX05BTUUgd2l0aGluIHRoZSBAZGVjYWYtdHMgbmFtZXNwYWNlIGFuZCBsb2FkIHRoZW0gYXMgc3ViY29tbWFuZHMuXG4gKlxuICogQGV4YW1wbGVcbiAqIC8vIFJ1biBhIG1vZHVsZSBjb21tYW5kXG4gKiAkIG5weCBkZWNhZiA8bW9kdWxlIG5hbWU+IDxtb2R1bGUgY29tbWFuZD4gLi4uPG1vZHVsZSBjb21tYW5kIG9wdGlvbnM+XG4gKiBcbiAqIC8vIEdldCBoZWxwIGZvciBhIHNwZWNpZmljIG1vZHVsZVxuICogJCBucHggZGVjYWYgaGVscCA8bW9kdWxlIG5hbWU+XG4gKiBcbiAqIC8vIExpc3QgYWxsIGltcG9ydGVkIG1vZHVsZXNcbiAqICQgbnB4IGRlY2FmIGxpc3RcbiAqIFxuICogLy8gR2V0IGdlbmVyYWwgQ0xJIGhlbHBcbiAqICQgbnB4IGRlY2FmIGhlbHBcbiAqXG4gKiBAbWVtYmVyT2YgbW9kdWxlOkNMSVxuICovXG5cbmltcG9ydCB7IENsaVdyYXBwZXIgfSBmcm9tIFwiLi4vQ2xpV3JhcHBlclwiO1xubmV3IENsaVdyYXBwZXIoKVxuICAucnVuKHByb2Nlc3MuYXJndilcbiAgLnRoZW4oKCkgPT4ge1xuICAgIGNvbnNvbGUubG9nKFwiVGhhbmsgeW91IGZvciB1c2luZyBkZWNhZi10cycgY29tbWFuZCBsaW5lIGludGVyZmFjZVwiKTtcbiAgfSlcbiAgLmNhdGNoKChlOiB1bmtub3duKSA9PiB7XG4gICAgY29uc29sZS5lcnJvcihgJHtlIGluc3RhbmNlb2YgRXJyb3IgPyBlLm1lc3NhZ2UgOiBlfWApO1xuICAgIHByb2Nlc3MuZXhpdCgxKTtcbiAgfSk7XG4iXX0=
package/lib/bin/cli.d.ts CHANGED
@@ -2,15 +2,23 @@
2
2
  * BIN_CALL_PLACEHOLDER - DO NOT REMOVE
3
3
  */
4
4
  /**
5
- * @description Decaf-ts' CLI entry file
6
- * @summary This file will crawl the current working directory for files called {@link CLI_FILE_NAME}
7
- * within the @decaf-ts namespace and load then as subcommands
5
+ * @description Decaf-ts' CLI entry point
6
+ * @summary This file serves as the main executable entry point for the Decaf CLI. It creates a CliWrapper instance
7
+ * and runs it with the process arguments. The CLI will crawl the current working directory for files called
8
+ * CLI_FILE_NAME within the @decaf-ts namespace and load them as subcommands.
8
9
  *
9
10
  * @example
10
- * run module command - $ npx decaf <module name> <module command> ...<module command options>
11
- * get module help - $ npx decaf help <module name>;
12
- * list imported modules - $ npx decaf list;
13
- * get cli help - $ npx decaf help;
11
+ * // Run a module command
12
+ * $ npx decaf <module name> <module command> ...<module command options>
13
+ *
14
+ * // Get help for a specific module
15
+ * $ npx decaf help <module name>
16
+ *
17
+ * // List all imported modules
18
+ * $ npx decaf list
19
+ *
20
+ * // Get general CLI help
21
+ * $ npx decaf help
14
22
  *
15
23
  * @memberOf module:CLI
16
24
  */
package/lib/constants.cjs CHANGED
@@ -2,11 +2,11 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.CLI_FILE_NAME = void 0;
4
4
  /**
5
- * @description The name for decaf cli modules where each library must export
6
- * a single {@link CliModule}
5
+ * @description The filename that identifies Decaf CLI modules
6
+ * @summary The standard filename for CLI module files where each library must export a single CliModule function
7
7
  *
8
- * @constant
9
- * @memberOf module:CLI.cli
8
+ * @const CLI_FILE_NAME
9
+ * @memberOf module:CLI
10
10
  */
11
11
  exports.CLI_FILE_NAME = "cli-module";
12
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uc3RhbnRzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2NvbnN0YW50cy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFHQTs7Ozs7O0dBTUc7QUFDVSxRQUFBLGFBQWEsR0FBRyxZQUFZLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyIvLyBlc2xpbnQtZGlzYWJsZS1uZXh0LWxpbmUgQHR5cGVzY3JpcHQtZXNsaW50L25vLXVudXNlZC12YXJzXG5pbXBvcnQgeyBDbGlNb2R1bGUgfSBmcm9tIFwiLi90eXBlc1wiO1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBUaGUgbmFtZSBmb3IgZGVjYWYgY2xpIG1vZHVsZXMgd2hlcmUgZWFjaCBsaWJyYXJ5IG11c3QgZXhwb3J0XG4gKiBhIHNpbmdsZSB7QGxpbmsgQ2xpTW9kdWxlfVxuICpcbiAqIEBjb25zdGFudFxuICogQG1lbWJlck9mIG1vZHVsZTpDTEkuY2xpXG4gKi9cbmV4cG9ydCBjb25zdCBDTElfRklMRV9OQU1FID0gXCJjbGktbW9kdWxlXCI7XG4iXX0=
12
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uc3RhbnRzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2NvbnN0YW50cy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFHQTs7Ozs7O0dBTUc7QUFDVSxRQUFBLGFBQWEsR0FBRyxZQUFZLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyIvLyBlc2xpbnQtZGlzYWJsZS1uZXh0LWxpbmUgQHR5cGVzY3JpcHQtZXNsaW50L25vLXVudXNlZC12YXJzXG5pbXBvcnQgeyBDbGlNb2R1bGUgfSBmcm9tIFwiLi90eXBlc1wiO1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBUaGUgZmlsZW5hbWUgdGhhdCBpZGVudGlmaWVzIERlY2FmIENMSSBtb2R1bGVzXG4gKiBAc3VtbWFyeSBUaGUgc3RhbmRhcmQgZmlsZW5hbWUgZm9yIENMSSBtb2R1bGUgZmlsZXMgd2hlcmUgZWFjaCBsaWJyYXJ5IG11c3QgZXhwb3J0IGEgc2luZ2xlIENsaU1vZHVsZSBmdW5jdGlvblxuICpcbiAqIEBjb25zdCBDTElfRklMRV9OQU1FXG4gKiBAbWVtYmVyT2YgbW9kdWxlOkNMSVxuICovXG5leHBvcnQgY29uc3QgQ0xJX0ZJTEVfTkFNRSA9IFwiY2xpLW1vZHVsZVwiO1xuIl19
@@ -1,8 +1,8 @@
1
1
  /**
2
- * @description The name for decaf cli modules where each library must export
3
- * a single {@link CliModule}
2
+ * @description The filename that identifies Decaf CLI modules
3
+ * @summary The standard filename for CLI module files where each library must export a single CliModule function
4
4
  *
5
- * @constant
6
- * @memberOf module:CLI.cli
5
+ * @const CLI_FILE_NAME
6
+ * @memberOf module:CLI
7
7
  */
8
8
  export declare const CLI_FILE_NAME = "cli-module";
@@ -3,29 +3,37 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.default = demo;
4
4
  const commander_1 = require("commander");
5
5
  /**
6
- * @description demo CLI module for libraries
7
- * @summary minimal implementation on how to extend the decaf-ts cli
6
+ * @description Demo CLI module for Decaf libraries
7
+ * @summary A minimal implementation showing how to extend the Decaf CLI with custom commands.
8
+ * This module demonstrates the pattern for creating CLI modules that can be discovered and loaded by the Decaf CLI.
8
9
  *
9
- * - the function must be ***exported by default***!;
10
- * - The name of the returned function will be considered to be the base command;
11
- * - the command you return will be considered as a subCommand and will not be called directly
12
- * - Commands must be transpiled under the same ts-configuration as this module
13
- * (so copy the ts-config of this module to your project. we propose `tsconfig.cli.json`)
14
- * - Following your build pipeline include `tsc --project tsconfig.cli.json --outDir <dist folder>/cli`
15
- *
16
- * Note the extra use of `cli` on the outDir param. this is meant to completely separate
17
- * the cli code from your source, in case they are transpiled under different ts-configurations
18
- *
19
- * @returns {Command} the subCommand to be added to the main decaf CLI
10
+ * @return {Command} The Command object to be added to the main Decaf CLI
20
11
  *
21
12
  * @function demo
22
- *
23
- * @category Command Line Interface
13
+ * @memberOf module:CLI
24
14
  *
25
15
  * @example
26
- * `npx decaf demo command "something something" `
16
+ * // Run the demo command with an argument
17
+ * npx decaf demo command "something something"
18
+ *
19
+ * // Output:
20
+ * // executed demo command with type variable: something something
21
+ *
22
+ * @mermaid
23
+ * sequenceDiagram
24
+ * participant User
25
+ * participant CLI
26
+ * participant DemoModule
27
+ * participant Command
27
28
  *
28
- * will output `executed demo command with type variable: something something`
29
+ * User->>CLI: npx decaf demo command "arg"
30
+ * CLI->>DemoModule: Load module
31
+ * DemoModule->>Command: Create command
32
+ * Command->>Command: Configure action
33
+ * Command-->>DemoModule: Return command
34
+ * DemoModule-->>CLI: Return command
35
+ * CLI->>Command: Execute with args
36
+ * Command->>Console: Log output
29
37
  */
30
38
  function demo() {
31
39
  return new commander_1.Command()
@@ -35,4 +43,4 @@ function demo() {
35
43
  console.log(`executed demo command with type variable: ${args}`);
36
44
  });
37
45
  }
38
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2xpLW1vZHVsZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9kZW1vL2NsaS1tb2R1bGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUEyQkEsdUJBT0M7QUFsQ0QseUNBQW9DO0FBRXBDOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7R0F3Qkc7QUFDSCxTQUF3QixJQUFJO0lBQzFCLE9BQU8sSUFBSSxtQkFBTyxFQUFFO1NBQ2pCLE9BQU8sQ0FBQyxnQkFBZ0IsQ0FBQztTQUN6QixXQUFXLENBQUMsZ0JBQWdCLENBQUM7U0FDN0IsTUFBTSxDQUFDLENBQUMsSUFBWSxFQUFFLEVBQUU7UUFDdkIsT0FBTyxDQUFDLEdBQUcsQ0FBQyw2Q0FBNkMsSUFBSSxFQUFFLENBQUMsQ0FBQztJQUNuRSxDQUFDLENBQUMsQ0FBQztBQUNQLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBDb21tYW5kIH0gZnJvbSBcImNvbW1hbmRlclwiO1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBkZW1vIENMSSBtb2R1bGUgZm9yIGxpYnJhcmllc1xuICogQHN1bW1hcnkgbWluaW1hbCBpbXBsZW1lbnRhdGlvbiBvbiBob3cgdG8gZXh0ZW5kIHRoZSBkZWNhZi10cyBjbGlcbiAqXG4gKiAtIHRoZSBmdW5jdGlvbiBtdXN0IGJlICoqKmV4cG9ydGVkIGJ5IGRlZmF1bHQqKiohO1xuICogLSBUaGUgbmFtZSBvZiB0aGUgcmV0dXJuZWQgZnVuY3Rpb24gd2lsbCBiZSBjb25zaWRlcmVkIHRvIGJlIHRoZSBiYXNlIGNvbW1hbmQ7XG4gKiAtIHRoZSBjb21tYW5kIHlvdSByZXR1cm4gd2lsbCBiZSBjb25zaWRlcmVkIGFzIGEgc3ViQ29tbWFuZCBhbmQgd2lsbCBub3QgYmUgY2FsbGVkIGRpcmVjdGx5XG4gKiAtIENvbW1hbmRzIG11c3QgYmUgdHJhbnNwaWxlZCB1bmRlciB0aGUgc2FtZSB0cy1jb25maWd1cmF0aW9uIGFzIHRoaXMgbW9kdWxlXG4gKiAoc28gY29weSB0aGUgdHMtY29uZmlnIG9mIHRoaXMgbW9kdWxlIHRvIHlvdXIgcHJvamVjdC4gd2UgcHJvcG9zZSBgdHNjb25maWcuY2xpLmpzb25gKVxuICogLSBGb2xsb3dpbmcgeW91ciBidWlsZCBwaXBlbGluZSBpbmNsdWRlIGB0c2MgLS1wcm9qZWN0IHRzY29uZmlnLmNsaS5qc29uIC0tb3V0RGlyIDxkaXN0IGZvbGRlcj4vY2xpYFxuICpcbiAqIE5vdGUgdGhlIGV4dHJhIHVzZSBvZiBgY2xpYCBvbiB0aGUgb3V0RGlyIHBhcmFtLiB0aGlzIGlzIG1lYW50IHRvIGNvbXBsZXRlbHkgc2VwYXJhdGVcbiAqIHRoZSBjbGkgY29kZSBmcm9tIHlvdXIgc291cmNlLCBpbiBjYXNlIHRoZXkgYXJlIHRyYW5zcGlsZWQgdW5kZXIgZGlmZmVyZW50IHRzLWNvbmZpZ3VyYXRpb25zXG4gKlxuICogQHJldHVybnMge0NvbW1hbmR9IHRoZSBzdWJDb21tYW5kIHRvIGJlIGFkZGVkIHRvIHRoZSBtYWluIGRlY2FmIENMSVxuICpcbiAqIEBmdW5jdGlvbiBkZW1vXG4gKlxuICogQGNhdGVnb3J5IENvbW1hbmQgTGluZSBJbnRlcmZhY2VcbiAqXG4gKiBAZXhhbXBsZVxuICogYG5weCBkZWNhZiBkZW1vIGNvbW1hbmQgXCJzb21ldGhpbmcgc29tZXRoaW5nXCIgYFxuICpcbiAqIHdpbGwgb3V0cHV0IGBleGVjdXRlZCBkZW1vIGNvbW1hbmQgd2l0aCB0eXBlIHZhcmlhYmxlOiBzb21ldGhpbmcgc29tZXRoaW5nYFxuICovXG5leHBvcnQgZGVmYXVsdCBmdW5jdGlvbiBkZW1vKCk6IENvbW1hbmQge1xuICByZXR1cm4gbmV3IENvbW1hbmQoKVxuICAgIC5jb21tYW5kKFwiY29tbWFuZCA8dHlwZT5cIilcbiAgICAuZGVzY3JpcHRpb24oXCJBIGRlbW8gY29tbWFuZFwiKVxuICAgIC5hY3Rpb24oKGFyZ3M6IHN0cmluZykgPT4ge1xuICAgICAgY29uc29sZS5sb2coYGV4ZWN1dGVkIGRlbW8gY29tbWFuZCB3aXRoIHR5cGUgdmFyaWFibGU6ICR7YXJnc31gKTtcbiAgICB9KTtcbn1cbiJdfQ==
46
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2xpLW1vZHVsZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9kZW1vL2NsaS1tb2R1bGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFtQ0EsdUJBT0M7QUExQ0QseUNBQW9DO0FBRXBDOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztHQWdDRztBQUNILFNBQXdCLElBQUk7SUFDMUIsT0FBTyxJQUFJLG1CQUFPLEVBQUU7U0FDakIsT0FBTyxDQUFDLGdCQUFnQixDQUFDO1NBQ3pCLFdBQVcsQ0FBQyxnQkFBZ0IsQ0FBQztTQUM3QixNQUFNLENBQUMsQ0FBQyxJQUFZLEVBQUUsRUFBRTtRQUN2QixPQUFPLENBQUMsR0FBRyxDQUFDLDZDQUE2QyxJQUFJLEVBQUUsQ0FBQyxDQUFDO0lBQ25FLENBQUMsQ0FBQyxDQUFDO0FBQ1AsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IENvbW1hbmQgfSBmcm9tIFwiY29tbWFuZGVyXCI7XG5cbi8qKlxuICogQGRlc2NyaXB0aW9uIERlbW8gQ0xJIG1vZHVsZSBmb3IgRGVjYWYgbGlicmFyaWVzXG4gKiBAc3VtbWFyeSBBIG1pbmltYWwgaW1wbGVtZW50YXRpb24gc2hvd2luZyBob3cgdG8gZXh0ZW5kIHRoZSBEZWNhZiBDTEkgd2l0aCBjdXN0b20gY29tbWFuZHMuXG4gKiBUaGlzIG1vZHVsZSBkZW1vbnN0cmF0ZXMgdGhlIHBhdHRlcm4gZm9yIGNyZWF0aW5nIENMSSBtb2R1bGVzIHRoYXQgY2FuIGJlIGRpc2NvdmVyZWQgYW5kIGxvYWRlZCBieSB0aGUgRGVjYWYgQ0xJLlxuICpcbiAqIEByZXR1cm4ge0NvbW1hbmR9IFRoZSBDb21tYW5kIG9iamVjdCB0byBiZSBhZGRlZCB0byB0aGUgbWFpbiBEZWNhZiBDTElcbiAqXG4gKiBAZnVuY3Rpb24gZGVtb1xuICogQG1lbWJlck9mIG1vZHVsZTpDTElcbiAqXG4gKiBAZXhhbXBsZVxuICogLy8gUnVuIHRoZSBkZW1vIGNvbW1hbmQgd2l0aCBhbiBhcmd1bWVudFxuICogbnB4IGRlY2FmIGRlbW8gY29tbWFuZCBcInNvbWV0aGluZyBzb21ldGhpbmdcIlxuICpcbiAqIC8vIE91dHB1dDpcbiAqIC8vIGV4ZWN1dGVkIGRlbW8gY29tbWFuZCB3aXRoIHR5cGUgdmFyaWFibGU6IHNvbWV0aGluZyBzb21ldGhpbmdcbiAqXG4gKiBAbWVybWFpZFxuICogc2VxdWVuY2VEaWFncmFtXG4gKiAgIHBhcnRpY2lwYW50IFVzZXJcbiAqICAgcGFydGljaXBhbnQgQ0xJXG4gKiAgIHBhcnRpY2lwYW50IERlbW9Nb2R1bGVcbiAqICAgcGFydGljaXBhbnQgQ29tbWFuZFxuICpcbiAqICAgVXNlci0+PkNMSTogbnB4IGRlY2FmIGRlbW8gY29tbWFuZCBcImFyZ1wiXG4gKiAgIENMSS0+PkRlbW9Nb2R1bGU6IExvYWQgbW9kdWxlXG4gKiAgIERlbW9Nb2R1bGUtPj5Db21tYW5kOiBDcmVhdGUgY29tbWFuZFxuICogICBDb21tYW5kLT4+Q29tbWFuZDogQ29uZmlndXJlIGFjdGlvblxuICogICBDb21tYW5kLS0+PkRlbW9Nb2R1bGU6IFJldHVybiBjb21tYW5kXG4gKiAgIERlbW9Nb2R1bGUtLT4+Q0xJOiBSZXR1cm4gY29tbWFuZFxuICogICBDTEktPj5Db21tYW5kOiBFeGVjdXRlIHdpdGggYXJnc1xuICogICBDb21tYW5kLT4+Q29uc29sZTogTG9nIG91dHB1dFxuICovXG5leHBvcnQgZGVmYXVsdCBmdW5jdGlvbiBkZW1vKCk6IENvbW1hbmQge1xuICByZXR1cm4gbmV3IENvbW1hbmQoKVxuICAgIC5jb21tYW5kKFwiY29tbWFuZCA8dHlwZT5cIilcbiAgICAuZGVzY3JpcHRpb24oXCJBIGRlbW8gY29tbWFuZFwiKVxuICAgIC5hY3Rpb24oKGFyZ3M6IHN0cmluZykgPT4ge1xuICAgICAgY29uc29sZS5sb2coYGV4ZWN1dGVkIGRlbW8gY29tbWFuZCB3aXRoIHR5cGUgdmFyaWFibGU6ICR7YXJnc31gKTtcbiAgICB9KTtcbn1cbiJdfQ==
@@ -1,27 +1,35 @@
1
1
  import { Command } from "commander";
2
2
  /**
3
- * @description demo CLI module for libraries
4
- * @summary minimal implementation on how to extend the decaf-ts cli
3
+ * @description Demo CLI module for Decaf libraries
4
+ * @summary A minimal implementation showing how to extend the Decaf CLI with custom commands.
5
+ * This module demonstrates the pattern for creating CLI modules that can be discovered and loaded by the Decaf CLI.
5
6
  *
6
- * - the function must be ***exported by default***!;
7
- * - The name of the returned function will be considered to be the base command;
8
- * - the command you return will be considered as a subCommand and will not be called directly
9
- * - Commands must be transpiled under the same ts-configuration as this module
10
- * (so copy the ts-config of this module to your project. we propose `tsconfig.cli.json`)
11
- * - Following your build pipeline include `tsc --project tsconfig.cli.json --outDir <dist folder>/cli`
12
- *
13
- * Note the extra use of `cli` on the outDir param. this is meant to completely separate
14
- * the cli code from your source, in case they are transpiled under different ts-configurations
15
- *
16
- * @returns {Command} the subCommand to be added to the main decaf CLI
7
+ * @return {Command} The Command object to be added to the main Decaf CLI
17
8
  *
18
9
  * @function demo
19
- *
20
- * @category Command Line Interface
10
+ * @memberOf module:CLI
21
11
  *
22
12
  * @example
23
- * `npx decaf demo command "something something" `
13
+ * // Run the demo command with an argument
14
+ * npx decaf demo command "something something"
15
+ *
16
+ * // Output:
17
+ * // executed demo command with type variable: something something
18
+ *
19
+ * @mermaid
20
+ * sequenceDiagram
21
+ * participant User
22
+ * participant CLI
23
+ * participant DemoModule
24
+ * participant Command
24
25
  *
25
- * will output `executed demo command with type variable: something something`
26
+ * User->>CLI: npx decaf demo command "arg"
27
+ * CLI->>DemoModule: Load module
28
+ * DemoModule->>Command: Create command
29
+ * Command->>Command: Configure action
30
+ * Command-->>DemoModule: Return command
31
+ * DemoModule-->>CLI: Return command
32
+ * CLI->>Command: Execute with args
33
+ * Command->>Console: Log output
26
34
  */
27
35
  export default function demo(): Command;