@akanjs/devkit 1.0.7-canary.5 → 1.0.8

package/cjs/src/commandDecorators/command.js

@@ -38,6 +38,7 @@ var import_fs = __toESM(require("fs"));
 var import__ = require("..");
 var import_executors = require("../executors");
 var import_argMeta = require("./argMeta");
+var import_helpFormatter = require("./helpFormatter");
 var import_targetMeta = require("./targetMeta");
 const import_meta = {};
 const camelToKebabCase = (str) => str.replace(/([A-Z])/g, "-$1").toLowerCase();
@@ -221,7 +222,17 @@ const runCommands = async (...commands) => {
   const __dirname = (0, import__.getDirname)(import_meta.url);
   const hasPackageJson = import_fs.default.existsSync(`${__dirname}/../package.json`);
   process.env.AKAN_VERSION = hasPackageJson ? JSON.parse(import_fs.default.readFileSync(`${__dirname}/../package.json`, "utf8")).version : "0.0.1";
-  import_commander.program.version(process.env.AKAN_VERSION).description("Akan CLI");
+  const hasHelpFlag = process.argv.includes("--help") || process.argv.includes("-h");
+  const hasCommand = process.argv.length > 2 && !process.argv[2].startsWith("-");
+  if (hasHelpFlag || !hasCommand) {
+    if (process.argv.length === 2 || process.argv.length === 3 && hasHelpFlag) {
+      import_common.Logger.rawLog((0, import_helpFormatter.formatHelp)(commands, process.env.AKAN_VERSION));
+      process.exit(0);
+    }
+  }
+  import_commander.program.version(process.env.AKAN_VERSION).description("Akan CLI").configureHelp({
+    helpWidth: 100
+  });
   const akanBasePackageJson = import_fs.default.existsSync("./node_modules/@akanjs/base/package.json") ? JSON.parse(import_fs.default.readFileSync("./node_modules/@akanjs/base/package.json", "utf8")) : null;
   if (akanBasePackageJson && akanBasePackageJson.version !== process.env.AKAN_VERSION) {
     import_common.Logger.rawLog(
@@ -266,6 +277,9 @@ It may cause unexpected behavior. Run \`akan update\` to update latest akanjs.`
           }
         }
         programCommand = programCommand.option(`-v, --verbose [boolean]`, `verbose output`);
+        programCommand.helpInformation = () => {
+          return (0, import_helpFormatter.formatCommandHelp)(command, targetMeta.key);
+        };
         programCommand.action(async (...args) => {
           import_common.Logger.rawLog();
           const cmdArgs = args.slice(0, args.length - 2);

package/cjs/src/commandDecorators/helpFormatter.js

@@ -0,0 +1,211 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var helpFormatter_exports = {};
+__export(helpFormatter_exports, {
+  formatCommandHelp: () => formatCommandHelp,
+  formatHelp: () => formatHelp
+});
+module.exports = __toCommonJS(helpFormatter_exports);
+var import_chalk = __toESM(require("chalk"));
+var import_argMeta = require("./argMeta");
+var import_targetMeta = require("./targetMeta");
+const camelToKebabCase = (str) => str.replace(/([A-Z])/g, "-$1").toLowerCase();
+const groupCommands = (commands) => {
+  const groups = /* @__PURE__ */ new Map();
+  for (const command of commands) {
+    const className = command.name.replace("Command", "");
+    const groupName = className;
+    if (!groups.has(groupName)) {
+      groups.set(groupName, { name: groupName, commands: [] });
+    }
+    const targetMetas = (0, import_targetMeta.getTargetMetas)(command);
+    for (const targetMeta of targetMetas) {
+      if (targetMeta.targetOption.devOnly)
+        continue;
+      const [allArgMetas] = (0, import_argMeta.getArgMetas)(command, targetMeta.key);
+      const args = allArgMetas.filter((arg) => arg.type !== "Option").map((arg) => {
+        if (arg.type === "Workspace")
+          return "";
+        if (arg.type === "Module")
+          return "[sys:module]";
+        if (arg.type === "Argument") {
+          return `[${arg.name}]`;
+        }
+        return `[${arg.type.toLowerCase()}]`;
+      }).filter(Boolean);
+      const group = groups.get(groupName);
+      if (group) {
+        group.commands.push({
+          key: camelToKebabCase(targetMeta.key),
+          args,
+          desc: targetMeta.targetOption.desc
+        });
+      }
+    }
+  }
+  return groups;
+};
+const formatHelp = (commands, version) => {
+  const groups = groupCommands(commands);
+  const lines = [];
+  lines.push("");
+  lines.push(import_chalk.default.bold.cyan("  \u2554\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2557"));
+  lines.push(
+    import_chalk.default.bold.cyan("  \u2551") + import_chalk.default.bold.white("              Akan.js Framework CLI            ") + import_chalk.default.bold.cyan("    \u2551")
+  );
+  lines.push(import_chalk.default.bold.cyan("  \u255A\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u255D"));
+  lines.push("");
+  lines.push(import_chalk.default.gray(`  Version: ${version}`));
+  lines.push("");
+  lines.push(import_chalk.default.bold.yellow("  USAGE"));
+  lines.push("");
+  lines.push(import_chalk.default.gray("    $ ") + import_chalk.default.white("akan") + import_chalk.default.gray(" <command> [options]"));
+  lines.push("");
+  lines.push(import_chalk.default.bold.yellow("  COMMANDS"));
+  lines.push("");
+  for (const [groupName, group] of groups) {
+    if (group.commands.length === 0)
+      continue;
+    lines.push(import_chalk.default.bold.magenta(`    ${groupName}`));
+    lines.push("");
+    for (const cmd of group.commands) {
+      const cmdName = import_chalk.default.green(cmd.key);
+      const cmdArgs = cmd.args.length > 0 ? import_chalk.default.gray(` ${cmd.args.join(" ")}`) : "";
+      if (cmd.desc) {
+        const maxLineLength = 70;
+        const cmdPrefix = `      ${cmdName}${cmdArgs}`;
+        const indent = "        ";
+        if (cmdPrefix.length + cmd.desc.length + 3 < maxLineLength) {
+          lines.push(`${cmdPrefix}  ${import_chalk.default.gray(cmd.desc)}`);
+        } else {
+          lines.push(cmdPrefix);
+          lines.push(`${indent}${import_chalk.default.gray(cmd.desc)}`);
+        }
+      } else {
+        lines.push(`      ${cmdName}${cmdArgs}`);
+      }
+    }
+    lines.push("");
+  }
+  lines.push(import_chalk.default.bold.yellow("  OPTIONS"));
+  lines.push("");
+  lines.push(`      ${import_chalk.default.green("-v, --verbose")}      ${import_chalk.default.gray("Enable verbose output")}`);
+  lines.push(`      ${import_chalk.default.green("-h, --help")}         ${import_chalk.default.gray("Display this help message")}`);
+  lines.push(`      ${import_chalk.default.green("-V, --version")}      ${import_chalk.default.gray("Output version number")}`);
+  lines.push("");
+  lines.push(import_chalk.default.bold.yellow("  EXAMPLES"));
+  lines.push("");
+  lines.push(import_chalk.default.gray("    # Create a new workspace"));
+  lines.push(import_chalk.default.white("    $ akan create-workspace myproject"));
+  lines.push("");
+  lines.push(import_chalk.default.gray("    # Start development server"));
+  lines.push(import_chalk.default.white("    $ akan start myapp"));
+  lines.push("");
+  lines.push(import_chalk.default.gray("    # Create a new module"));
+  lines.push(import_chalk.default.white("    $ akan create-module userProfile"));
+  lines.push("");
+  lines.push(import_chalk.default.gray("  Documentation: ") + import_chalk.default.cyan("https://akanjs.com/docs"));
+  lines.push(import_chalk.default.gray("  Report issues: ") + import_chalk.default.cyan("https://github.com/akan-team/akanjs/issues"));
+  lines.push("");
+  return lines.join("\n");
+};
+const formatCommandHelp = (command, key) => {
+  const [allArgMetas, argMetas] = (0, import_argMeta.getArgMetas)(command, key);
+  const kebabKey = camelToKebabCase(key);
+  const lines = [];
+  const targetMetas = (0, import_targetMeta.getTargetMetas)(command);
+  const targetMeta = targetMetas.find((t) => t.key === key);
+  const commandDesc = targetMeta?.targetOption.desc;
+  lines.push("");
+  lines.push(import_chalk.default.bold.cyan(`  Command: ${kebabKey}`));
+  if (commandDesc) {
+    lines.push(import_chalk.default.gray(`  ${commandDesc}`));
+  }
+  lines.push("");
+  const args = allArgMetas.filter((arg) => arg.type !== "Option").map((arg) => {
+    if (arg.type === "Workspace")
+      return "";
+    if (arg.type === "Module")
+      return "[sys:module]";
+    if (arg.type === "Argument") {
+      return `[${camelToKebabCase(arg.name)}]`;
+    }
+    return `[${arg.type.toLowerCase()}]`;
+  }).filter(Boolean).join(" ");
+  lines.push(import_chalk.default.bold.yellow("  USAGE"));
+  lines.push("");
+  lines.push(import_chalk.default.gray("    $ ") + import_chalk.default.white(`akan ${kebabKey}`) + (args ? import_chalk.default.gray(` ${args}`) : ""));
+  lines.push("");
+  const nonOptionArgs = allArgMetas.filter((arg) => arg.type !== "Option");
+  if (nonOptionArgs.length > 0) {
+    lines.push(import_chalk.default.bold.yellow("  ARGUMENTS"));
+    lines.push("");
+    for (const arg of nonOptionArgs) {
+      if (arg.type === "Workspace")
+        continue;
+      let argName;
+      let argDesc;
+      let example = "";
+      if (arg.type === "Argument") {
+        argName = camelToKebabCase(arg.name);
+        argDesc = arg.argsOption.desc ?? "";
+        example = arg.argsOption.example ? import_chalk.default.gray(` (e.g., ${String(arg.argsOption.example)})`) : "";
+      } else if (arg.type === "Module") {
+        argName = "sys:module";
+        argDesc = "Module in format: app-name:module-name or lib-name:module-name";
+      } else {
+        argName = arg.type.toLowerCase();
+        argDesc = `${arg.type} name in this workspace`;
+      }
+      lines.push(`      ${import_chalk.default.green(argName)}      ${import_chalk.default.gray(argDesc)}${example}`);
+    }
+    lines.push("");
+  }
+  const optionArgs = argMetas.filter((a) => a.type === "Option");
+  if (optionArgs.length > 0) {
+    lines.push(import_chalk.default.bold.yellow("  OPTIONS"));
+    lines.push("");
+    for (const arg of optionArgs) {
+      const opt = arg.argsOption;
+      const flag = opt.flag ? `-${opt.flag}, ` : "";
+      const kebabName = camelToKebabCase(arg.name);
+      const optName = `${flag}--${kebabName}`;
+      const optDesc = opt.desc ?? "";
+      const defaultVal = opt.default !== void 0 ? import_chalk.default.gray(` [default: ${String(opt.default)}]`) : "";
+      const choices = opt.enum ? import_chalk.default.gray(` (${opt.enum.join(", ")})`) : "";
+      lines.push(`      ${import_chalk.default.green(optName)}      ${import_chalk.default.gray(optDesc)}${defaultVal}${choices}`);
+    }
+    lines.push("");
+  }
+  return lines.join("\n");
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  formatCommandHelp,
+  formatHelp
+});

package/cjs/src/commandDecorators/index.js

@@ -18,6 +18,7 @@ __reExport(commandDecorators_exports, require("./argMeta"), module.exports);
 __reExport(commandDecorators_exports, require("./commandMeta"), module.exports);
 __reExport(commandDecorators_exports, require("./targetMeta"), module.exports);
 __reExport(commandDecorators_exports, require("./types"), module.exports);
+__reExport(commandDecorators_exports, require("./helpFormatter"), module.exports);
 __reExport(commandDecorators_exports, require("./command"), module.exports);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
@@ -25,5 +26,6 @@ __reExport(commandDecorators_exports, require("./command"), module.exports);
   ...require("./commandMeta"),
   ...require("./targetMeta"),
   ...require("./types"),
+  ...require("./helpFormatter"),
   ...require("./command")
 });

package/esm/src/commandDecorators/command.js

@@ -6,6 +6,7 @@ import fs from "fs";
 import { getDirname } from "..";
 import { AppExecutor, Executor, LibExecutor, ModuleExecutor, PkgExecutor, WorkspaceExecutor } from "../executors";
 import { getArgMetas } from "./argMeta";
+import { formatCommandHelp, formatHelp } from "./helpFormatter";
 import { getTargetMetas } from "./targetMeta";
 const camelToKebabCase = (str) => str.replace(/([A-Z])/g, "-$1").toLowerCase();
 const handleOption = (programCommand, argMeta) => {
@@ -188,7 +189,17 @@ const runCommands = async (...commands) => {
   const __dirname = getDirname(import.meta.url);
   const hasPackageJson = fs.existsSync(`${__dirname}/../package.json`);
   process.env.AKAN_VERSION = hasPackageJson ? JSON.parse(fs.readFileSync(`${__dirname}/../package.json`, "utf8")).version : "0.0.1";
-  program.version(process.env.AKAN_VERSION).description("Akan CLI");
+  const hasHelpFlag = process.argv.includes("--help") || process.argv.includes("-h");
+  const hasCommand = process.argv.length > 2 && !process.argv[2].startsWith("-");
+  if (hasHelpFlag || !hasCommand) {
+    if (process.argv.length === 2 || process.argv.length === 3 && hasHelpFlag) {
+      Logger.rawLog(formatHelp(commands, process.env.AKAN_VERSION));
+      process.exit(0);
+    }
+  }
+  program.version(process.env.AKAN_VERSION).description("Akan CLI").configureHelp({
+    helpWidth: 100
+  });
   const akanBasePackageJson = fs.existsSync("./node_modules/@akanjs/base/package.json") ? JSON.parse(fs.readFileSync("./node_modules/@akanjs/base/package.json", "utf8")) : null;
   if (akanBasePackageJson && akanBasePackageJson.version !== process.env.AKAN_VERSION) {
     Logger.rawLog(
@@ -233,6 +244,9 @@ It may cause unexpected behavior. Run \`akan update\` to update latest akanjs.`
           }
         }
         programCommand = programCommand.option(`-v, --verbose [boolean]`, `verbose output`);
+        programCommand.helpInformation = () => {
+          return formatCommandHelp(command, targetMeta.key);
+        };
         programCommand.action(async (...args) => {
           Logger.rawLog();
           const cmdArgs = args.slice(0, args.length - 2);

package/esm/src/commandDecorators/helpFormatter.js

@@ -0,0 +1,177 @@
+import chalk from "chalk";
+import { getArgMetas } from "./argMeta";
+import { getTargetMetas } from "./targetMeta";
+const camelToKebabCase = (str) => str.replace(/([A-Z])/g, "-$1").toLowerCase();
+const groupCommands = (commands) => {
+  const groups = /* @__PURE__ */ new Map();
+  for (const command of commands) {
+    const className = command.name.replace("Command", "");
+    const groupName = className;
+    if (!groups.has(groupName)) {
+      groups.set(groupName, { name: groupName, commands: [] });
+    }
+    const targetMetas = getTargetMetas(command);
+    for (const targetMeta of targetMetas) {
+      if (targetMeta.targetOption.devOnly)
+        continue;
+      const [allArgMetas] = getArgMetas(command, targetMeta.key);
+      const args = allArgMetas.filter((arg) => arg.type !== "Option").map((arg) => {
+        if (arg.type === "Workspace")
+          return "";
+        if (arg.type === "Module")
+          return "[sys:module]";
+        if (arg.type === "Argument") {
+          return `[${arg.name}]`;
+        }
+        return `[${arg.type.toLowerCase()}]`;
+      }).filter(Boolean);
+      const group = groups.get(groupName);
+      if (group) {
+        group.commands.push({
+          key: camelToKebabCase(targetMeta.key),
+          args,
+          desc: targetMeta.targetOption.desc
+        });
+      }
+    }
+  }
+  return groups;
+};
+const formatHelp = (commands, version) => {
+  const groups = groupCommands(commands);
+  const lines = [];
+  lines.push("");
+  lines.push(chalk.bold.cyan("  \u2554\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2557"));
+  lines.push(
+    chalk.bold.cyan("  \u2551") + chalk.bold.white("              Akan.js Framework CLI            ") + chalk.bold.cyan("    \u2551")
+  );
+  lines.push(chalk.bold.cyan("  \u255A\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u255D"));
+  lines.push("");
+  lines.push(chalk.gray(`  Version: ${version}`));
+  lines.push("");
+  lines.push(chalk.bold.yellow("  USAGE"));
+  lines.push("");
+  lines.push(chalk.gray("    $ ") + chalk.white("akan") + chalk.gray(" <command> [options]"));
+  lines.push("");
+  lines.push(chalk.bold.yellow("  COMMANDS"));
+  lines.push("");
+  for (const [groupName, group] of groups) {
+    if (group.commands.length === 0)
+      continue;
+    lines.push(chalk.bold.magenta(`    ${groupName}`));
+    lines.push("");
+    for (const cmd of group.commands) {
+      const cmdName = chalk.green(cmd.key);
+      const cmdArgs = cmd.args.length > 0 ? chalk.gray(` ${cmd.args.join(" ")}`) : "";
+      if (cmd.desc) {
+        const maxLineLength = 70;
+        const cmdPrefix = `      ${cmdName}${cmdArgs}`;
+        const indent = "        ";
+        if (cmdPrefix.length + cmd.desc.length + 3 < maxLineLength) {
+          lines.push(`${cmdPrefix}  ${chalk.gray(cmd.desc)}`);
+        } else {
+          lines.push(cmdPrefix);
+          lines.push(`${indent}${chalk.gray(cmd.desc)}`);
+        }
+      } else {
+        lines.push(`      ${cmdName}${cmdArgs}`);
+      }
+    }
+    lines.push("");
+  }
+  lines.push(chalk.bold.yellow("  OPTIONS"));
+  lines.push("");
+  lines.push(`      ${chalk.green("-v, --verbose")}      ${chalk.gray("Enable verbose output")}`);
+  lines.push(`      ${chalk.green("-h, --help")}         ${chalk.gray("Display this help message")}`);
+  lines.push(`      ${chalk.green("-V, --version")}      ${chalk.gray("Output version number")}`);
+  lines.push("");
+  lines.push(chalk.bold.yellow("  EXAMPLES"));
+  lines.push("");
+  lines.push(chalk.gray("    # Create a new workspace"));
+  lines.push(chalk.white("    $ akan create-workspace myproject"));
+  lines.push("");
+  lines.push(chalk.gray("    # Start development server"));
+  lines.push(chalk.white("    $ akan start myapp"));
+  lines.push("");
+  lines.push(chalk.gray("    # Create a new module"));
+  lines.push(chalk.white("    $ akan create-module userProfile"));
+  lines.push("");
+  lines.push(chalk.gray("  Documentation: ") + chalk.cyan("https://akanjs.com/docs"));
+  lines.push(chalk.gray("  Report issues: ") + chalk.cyan("https://github.com/akan-team/akanjs/issues"));
+  lines.push("");
+  return lines.join("\n");
+};
+const formatCommandHelp = (command, key) => {
+  const [allArgMetas, argMetas] = getArgMetas(command, key);
+  const kebabKey = camelToKebabCase(key);
+  const lines = [];
+  const targetMetas = getTargetMetas(command);
+  const targetMeta = targetMetas.find((t) => t.key === key);
+  const commandDesc = targetMeta?.targetOption.desc;
+  lines.push("");
+  lines.push(chalk.bold.cyan(`  Command: ${kebabKey}`));
+  if (commandDesc) {
+    lines.push(chalk.gray(`  ${commandDesc}`));
+  }
+  lines.push("");
+  const args = allArgMetas.filter((arg) => arg.type !== "Option").map((arg) => {
+    if (arg.type === "Workspace")
+      return "";
+    if (arg.type === "Module")
+      return "[sys:module]";
+    if (arg.type === "Argument") {
+      return `[${camelToKebabCase(arg.name)}]`;
+    }
+    return `[${arg.type.toLowerCase()}]`;
+  }).filter(Boolean).join(" ");
+  lines.push(chalk.bold.yellow("  USAGE"));
+  lines.push("");
+  lines.push(chalk.gray("    $ ") + chalk.white(`akan ${kebabKey}`) + (args ? chalk.gray(` ${args}`) : ""));
+  lines.push("");
+  const nonOptionArgs = allArgMetas.filter((arg) => arg.type !== "Option");
+  if (nonOptionArgs.length > 0) {
+    lines.push(chalk.bold.yellow("  ARGUMENTS"));
+    lines.push("");
+    for (const arg of nonOptionArgs) {
+      if (arg.type === "Workspace")
+        continue;
+      let argName;
+      let argDesc;
+      let example = "";
+      if (arg.type === "Argument") {
+        argName = camelToKebabCase(arg.name);
+        argDesc = arg.argsOption.desc ?? "";
+        example = arg.argsOption.example ? chalk.gray(` (e.g., ${String(arg.argsOption.example)})`) : "";
+      } else if (arg.type === "Module") {
+        argName = "sys:module";
+        argDesc = "Module in format: app-name:module-name or lib-name:module-name";
+      } else {
+        argName = arg.type.toLowerCase();
+        argDesc = `${arg.type} name in this workspace`;
+      }
+      lines.push(`      ${chalk.green(argName)}      ${chalk.gray(argDesc)}${example}`);
+    }
+    lines.push("");
+  }
+  const optionArgs = argMetas.filter((a) => a.type === "Option");
+  if (optionArgs.length > 0) {
+    lines.push(chalk.bold.yellow("  OPTIONS"));
+    lines.push("");
+    for (const arg of optionArgs) {
+      const opt = arg.argsOption;
+      const flag = opt.flag ? `-${opt.flag}, ` : "";
+      const kebabName = camelToKebabCase(arg.name);
+      const optName = `${flag}--${kebabName}`;
+      const optDesc = opt.desc ?? "";
+      const defaultVal = opt.default !== void 0 ? chalk.gray(` [default: ${String(opt.default)}]`) : "";
+      const choices = opt.enum ? chalk.gray(` (${opt.enum.join(", ")})`) : "";
+      lines.push(`      ${chalk.green(optName)}      ${chalk.gray(optDesc)}${defaultVal}${choices}`);
+    }
+    lines.push("");
+  }
+  return lines.join("\n");
+};
+export {
+  formatCommandHelp,
+  formatHelp
+};

package/esm/src/commandDecorators/index.js

@@ -2,4 +2,5 @@ export * from "./argMeta";
 export * from "./commandMeta";
 export * from "./targetMeta";
 export * from "./types";
+export * from "./helpFormatter";
 export * from "./command";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@akanjs/devkit",
-  "version": "1.0.7-canary.5",
+  "version": "1.0.8",
   "sourceType": "module",
   "publishConfig": {
     "access": "public"
@@ -28,7 +28,7 @@
     "dotenv": "^16.4.7",
     "esbuild": "^0.19.2",
     "esbuild-plugin-d.ts": "^1.3.1",
-    "eslint": "^9.19.0",
+    "eslint": "^9.0.0",
     "form-data": "^4.0.1",
     "ignore": "^7.0.5",
     "ink": "^6.1.0",

package/src/commandDecorators/helpFormatter.d.ts

@@ -0,0 +1,3 @@
+import type { Type } from "./types";
+export declare const formatHelp: (commands: Type[], version: string) => string;
+export declare const formatCommandHelp: (command: Type, key: string) => string;

package/src/commandDecorators/index.d.ts

@@ -2,4 +2,5 @@ export * from "./argMeta";
 export * from "./commandMeta";
 export * from "./targetMeta";
 export * from "./types";
+export * from "./helpFormatter";
 export * from "./command";

package/src/commandDecorators/targetMeta.d.ts

@@ -9,6 +9,7 @@ interface TargetOption {
     type: "public" | "cloud" | "dev";
     short?: string | true;
     devOnly?: boolean;
+    desc?: string;
 }
 export declare const Target: {
     Public: (targetOption?: Omit<TargetOption, "type">) => (prototype: object, key: string, descriptor: PropertyDescriptor) => void;