citty 0.1.3 → 0.1.5

package/README.md

@@ -82,9 +82,13 @@ runMain(main);
 
 Runs a command with usage support and graceful error handling.
 
+### `createMain`
+
+Create a wrapper around command that calls `runMain` when called.
+
 ### `runCommand`
 
-Parses input args and runs command and sub-commands (unsupervised).
+Parses input args and runs command and sub-commands (unsupervised). You can access `result` key from returnd/awaited value to access command's result.
 
 ### `parseArgs`
 

package/dist/index.cjs

@@ -293,31 +293,40 @@ async function runCommand(cmd, opts) {
   if (typeof cmd.setup === "function") {
     await cmd.setup(context);
   }
-  const subCommands = await resolveValue(cmd.subCommands);
-  if (subCommands && Object.keys(subCommands).length > 0) {
-    const subCommandArgIndex = opts.rawArgs.findIndex(
-      (arg) => !arg.startsWith("-")
-    );
-    const subCommandName = opts.rawArgs[subCommandArgIndex];
-    if (!subCommandName && !cmd.run) {
-      throw new CLIError(`No command specified.`, "E_NO_COMMAND");
-    }
-    if (!subCommands[subCommandName]) {
-      throw new CLIError(
-        `Unknown command \`${subCommandName}\``,
-        "E_UNKNOWN_COMMAND"
+  let result;
+  try {
+    const subCommands = await resolveValue(cmd.subCommands);
+    if (subCommands && Object.keys(subCommands).length > 0) {
+      const subCommandArgIndex = opts.rawArgs.findIndex(
+        (arg) => !arg.startsWith("-")
       );
+      const subCommandName = opts.rawArgs[subCommandArgIndex];
+      if (subCommandName) {
+        if (!subCommands[subCommandName]) {
+          throw new CLIError(
+            `Unknown command \`${subCommandName}\``,
+            "E_UNKNOWN_COMMAND"
+          );
+        }
+        const subCommand = await resolveValue(subCommands[subCommandName]);
+        if (subCommand) {
+          await runCommand(subCommand, {
+            rawArgs: opts.rawArgs.slice(subCommandArgIndex + 1)
+          });
+        }
+      } else if (!cmd.run) {
+        throw new CLIError(`No command specified.`, "E_NO_COMMAND");
+      }
     }
-    const subCommand = await resolveValue(subCommands[subCommandName]);
-    if (subCommand) {
-      await runCommand(subCommand, {
-        rawArgs: opts.rawArgs.slice(subCommandArgIndex + 1)
-      });
+    if (typeof cmd.run === "function") {
+      result = await cmd.run(context);
+    }
+  } finally {
+    if (typeof cmd.cleanup === "function") {
+      await cmd.cleanup(context);
     }
   }
-  if (typeof cmd.run === "function") {
-    await cmd.run(context);
-  }
+  return { result };
 }
 async function resolveSubCommand(cmd, rawArgs, parent) {
   const subCommands = await resolveValue(cmd.subCommands);
@@ -423,10 +432,17 @@ async function renderUsage(cmd, parent) {
 
 async function runMain(cmd, opts = {}) {
   const rawArgs = opts.rawArgs || process.argv.slice(2);
+  const showUsage$1 = opts.showUsage || showUsage;
   try {
     if (rawArgs.includes("--help") || rawArgs.includes("-h")) {
-      await showUsage(...await resolveSubCommand(cmd, rawArgs));
+      await showUsage$1(...await resolveSubCommand(cmd, rawArgs));
       process.exit(0);
+    } else if (rawArgs.length === 1 && rawArgs[0] === "--version") {
+      const meta = typeof cmd.meta === "function" ? await cmd.meta() : await cmd.meta;
+      if (!meta?.version) {
+        throw new CLIError("No version specified", "E_NO_VERSION");
+      }
+      consola__default.log(meta.version);
     } else {
       await runCommand(cmd, { rawArgs });
     }
@@ -436,13 +452,17 @@ async function runMain(cmd, opts = {}) {
       consola__default.error(error, "\n");
     }
     if (isCLIError) {
-      await showUsage(...await resolveSubCommand(cmd, rawArgs));
+      await showUsage$1(...await resolveSubCommand(cmd, rawArgs));
     }
     consola__default.error(error.message);
     process.exit(1);
   }
 }
+function createMain(cmd) {
+  return (opts = {}) => runMain(cmd, opts);
+}
 
+exports.createMain = createMain;
 exports.defineCommand = defineCommand;
 exports.parseArgs = parseArgs;
 exports.renderUsage = renderUsage;

package/dist/index.d.cts

@@ -61,16 +61,20 @@ interface RunCommandOptions {
     data?: any;
     showUsage?: boolean;
 }
-declare function runCommand<T extends ArgsDef = ArgsDef>(cmd: CommandDef<T>, opts: RunCommandOptions): Promise<void>;
+declare function runCommand<T extends ArgsDef = ArgsDef>(cmd: CommandDef<T>, opts: RunCommandOptions): Promise<{
+    result: unknown;
+}>;
+
+declare function showUsage<T extends ArgsDef = ArgsDef>(cmd: CommandDef<T>, parent?: CommandDef<T>): Promise<void>;
+declare function renderUsage<T extends ArgsDef = ArgsDef>(cmd: CommandDef<T>, parent?: CommandDef<T>): Promise<string>;
 
 interface RunMainOptions {
     rawArgs?: string[];
+    showUsage?: typeof showUsage;
 }
 declare function runMain<T extends ArgsDef = ArgsDef>(cmd: CommandDef<T>, opts?: RunMainOptions): Promise<void>;
+declare function createMain<T extends ArgsDef = ArgsDef>(cmd: CommandDef<T>): (opts?: RunMainOptions) => Promise<void>;
 
 declare function parseArgs<T extends ArgsDef = ArgsDef>(rawArgs: string[], argsDef: ArgsDef): ParsedArgs<T>;
 
-declare function showUsage<T extends ArgsDef = ArgsDef>(cmd: CommandDef<T>, parent?: CommandDef<T>): Promise<void>;
-declare function renderUsage<T extends ArgsDef = ArgsDef>(cmd: CommandDef<T>, parent?: CommandDef<T>): Promise<string>;
-
-export { type Arg, type ArgDef, type ArgType, type ArgsDef, type Awaitable, type BooleanArgDef, type CommandContext, type CommandDef, type CommandMeta, type ParsedArgs, type PositionalArgDef, type Resolvable, type RunCommandOptions, type RunMainOptions, type StringArgDef, type SubCommandsDef, type _ArgDef, defineCommand, parseArgs, renderUsage, runCommand, runMain, showUsage };
+export { type Arg, type ArgDef, type ArgType, type ArgsDef, type Awaitable, type BooleanArgDef, type CommandContext, type CommandDef, type CommandMeta, type ParsedArgs, type PositionalArgDef, type Resolvable, type RunCommandOptions, type RunMainOptions, type StringArgDef, type SubCommandsDef, type _ArgDef, createMain, defineCommand, parseArgs, renderUsage, runCommand, runMain, showUsage };

package/dist/index.d.mts

@@ -61,16 +61,20 @@ interface RunCommandOptions {
     data?: any;
     showUsage?: boolean;
 }
-declare function runCommand<T extends ArgsDef = ArgsDef>(cmd: CommandDef<T>, opts: RunCommandOptions): Promise<void>;
+declare function runCommand<T extends ArgsDef = ArgsDef>(cmd: CommandDef<T>, opts: RunCommandOptions): Promise<{
+    result: unknown;
+}>;
+
+declare function showUsage<T extends ArgsDef = ArgsDef>(cmd: CommandDef<T>, parent?: CommandDef<T>): Promise<void>;
+declare function renderUsage<T extends ArgsDef = ArgsDef>(cmd: CommandDef<T>, parent?: CommandDef<T>): Promise<string>;
 
 interface RunMainOptions {
     rawArgs?: string[];
+    showUsage?: typeof showUsage;
 }
 declare function runMain<T extends ArgsDef = ArgsDef>(cmd: CommandDef<T>, opts?: RunMainOptions): Promise<void>;
+declare function createMain<T extends ArgsDef = ArgsDef>(cmd: CommandDef<T>): (opts?: RunMainOptions) => Promise<void>;
 
 declare function parseArgs<T extends ArgsDef = ArgsDef>(rawArgs: string[], argsDef: ArgsDef): ParsedArgs<T>;
 
-declare function showUsage<T extends ArgsDef = ArgsDef>(cmd: CommandDef<T>, parent?: CommandDef<T>): Promise<void>;
-declare function renderUsage<T extends ArgsDef = ArgsDef>(cmd: CommandDef<T>, parent?: CommandDef<T>): Promise<string>;
-
-export { type Arg, type ArgDef, type ArgType, type ArgsDef, type Awaitable, type BooleanArgDef, type CommandContext, type CommandDef, type CommandMeta, type ParsedArgs, type PositionalArgDef, type Resolvable, type RunCommandOptions, type RunMainOptions, type StringArgDef, type SubCommandsDef, type _ArgDef, defineCommand, parseArgs, renderUsage, runCommand, runMain, showUsage };
+export { type Arg, type ArgDef, type ArgType, type ArgsDef, type Awaitable, type BooleanArgDef, type CommandContext, type CommandDef, type CommandMeta, type ParsedArgs, type PositionalArgDef, type Resolvable, type RunCommandOptions, type RunMainOptions, type StringArgDef, type SubCommandsDef, type _ArgDef, createMain, defineCommand, parseArgs, renderUsage, runCommand, runMain, showUsage };

package/dist/index.d.ts

@@ -61,16 +61,20 @@ interface RunCommandOptions {
     data?: any;
     showUsage?: boolean;
 }
-declare function runCommand<T extends ArgsDef = ArgsDef>(cmd: CommandDef<T>, opts: RunCommandOptions): Promise<void>;
+declare function runCommand<T extends ArgsDef = ArgsDef>(cmd: CommandDef<T>, opts: RunCommandOptions): Promise<{
+    result: unknown;
+}>;
+
+declare function showUsage<T extends ArgsDef = ArgsDef>(cmd: CommandDef<T>, parent?: CommandDef<T>): Promise<void>;
+declare function renderUsage<T extends ArgsDef = ArgsDef>(cmd: CommandDef<T>, parent?: CommandDef<T>): Promise<string>;
 
 interface RunMainOptions {
     rawArgs?: string[];
+    showUsage?: typeof showUsage;
 }
 declare function runMain<T extends ArgsDef = ArgsDef>(cmd: CommandDef<T>, opts?: RunMainOptions): Promise<void>;
+declare function createMain<T extends ArgsDef = ArgsDef>(cmd: CommandDef<T>): (opts?: RunMainOptions) => Promise<void>;
 
 declare function parseArgs<T extends ArgsDef = ArgsDef>(rawArgs: string[], argsDef: ArgsDef): ParsedArgs<T>;
 
-declare function showUsage<T extends ArgsDef = ArgsDef>(cmd: CommandDef<T>, parent?: CommandDef<T>): Promise<void>;
-declare function renderUsage<T extends ArgsDef = ArgsDef>(cmd: CommandDef<T>, parent?: CommandDef<T>): Promise<string>;
-
-export { type Arg, type ArgDef, type ArgType, type ArgsDef, type Awaitable, type BooleanArgDef, type CommandContext, type CommandDef, type CommandMeta, type ParsedArgs, type PositionalArgDef, type Resolvable, type RunCommandOptions, type RunMainOptions, type StringArgDef, type SubCommandsDef, type _ArgDef, defineCommand, parseArgs, renderUsage, runCommand, runMain, showUsage };
+export { type Arg, type ArgDef, type ArgType, type ArgsDef, type Awaitable, type BooleanArgDef, type CommandContext, type CommandDef, type CommandMeta, type ParsedArgs, type PositionalArgDef, type Resolvable, type RunCommandOptions, type RunMainOptions, type StringArgDef, type SubCommandsDef, type _ArgDef, createMain, defineCommand, parseArgs, renderUsage, runCommand, runMain, showUsage };

package/dist/index.mjs

@@ -287,31 +287,40 @@ async function runCommand(cmd, opts) {
   if (typeof cmd.setup === "function") {
     await cmd.setup(context);
   }
-  const subCommands = await resolveValue(cmd.subCommands);
-  if (subCommands && Object.keys(subCommands).length > 0) {
-    const subCommandArgIndex = opts.rawArgs.findIndex(
-      (arg) => !arg.startsWith("-")
-    );
-    const subCommandName = opts.rawArgs[subCommandArgIndex];
-    if (!subCommandName && !cmd.run) {
-      throw new CLIError(`No command specified.`, "E_NO_COMMAND");
-    }
-    if (!subCommands[subCommandName]) {
-      throw new CLIError(
-        `Unknown command \`${subCommandName}\``,
-        "E_UNKNOWN_COMMAND"
+  let result;
+  try {
+    const subCommands = await resolveValue(cmd.subCommands);
+    if (subCommands && Object.keys(subCommands).length > 0) {
+      const subCommandArgIndex = opts.rawArgs.findIndex(
+        (arg) => !arg.startsWith("-")
       );
+      const subCommandName = opts.rawArgs[subCommandArgIndex];
+      if (subCommandName) {
+        if (!subCommands[subCommandName]) {
+          throw new CLIError(
+            `Unknown command \`${subCommandName}\``,
+            "E_UNKNOWN_COMMAND"
+          );
+        }
+        const subCommand = await resolveValue(subCommands[subCommandName]);
+        if (subCommand) {
+          await runCommand(subCommand, {
+            rawArgs: opts.rawArgs.slice(subCommandArgIndex + 1)
+          });
+        }
+      } else if (!cmd.run) {
+        throw new CLIError(`No command specified.`, "E_NO_COMMAND");
+      }
     }
-    const subCommand = await resolveValue(subCommands[subCommandName]);
-    if (subCommand) {
-      await runCommand(subCommand, {
-        rawArgs: opts.rawArgs.slice(subCommandArgIndex + 1)
-      });
+    if (typeof cmd.run === "function") {
+      result = await cmd.run(context);
+    }
+  } finally {
+    if (typeof cmd.cleanup === "function") {
+      await cmd.cleanup(context);
     }
   }
-  if (typeof cmd.run === "function") {
-    await cmd.run(context);
-  }
+  return { result };
 }
 async function resolveSubCommand(cmd, rawArgs, parent) {
   const subCommands = await resolveValue(cmd.subCommands);
@@ -417,10 +426,17 @@ async function renderUsage(cmd, parent) {
 
 async function runMain(cmd, opts = {}) {
   const rawArgs = opts.rawArgs || process.argv.slice(2);
+  const showUsage$1 = opts.showUsage || showUsage;
   try {
     if (rawArgs.includes("--help") || rawArgs.includes("-h")) {
-      await showUsage(...await resolveSubCommand(cmd, rawArgs));
+      await showUsage$1(...await resolveSubCommand(cmd, rawArgs));
       process.exit(0);
+    } else if (rawArgs.length === 1 && rawArgs[0] === "--version") {
+      const meta = typeof cmd.meta === "function" ? await cmd.meta() : await cmd.meta;
+      if (!meta?.version) {
+        throw new CLIError("No version specified", "E_NO_VERSION");
+      }
+      consola.log(meta.version);
     } else {
       await runCommand(cmd, { rawArgs });
     }
@@ -430,11 +446,14 @@ async function runMain(cmd, opts = {}) {
       consola.error(error, "\n");
     }
     if (isCLIError) {
-      await showUsage(...await resolveSubCommand(cmd, rawArgs));
+      await showUsage$1(...await resolveSubCommand(cmd, rawArgs));
     }
     consola.error(error.message);
     process.exit(1);
   }
 }
+function createMain(cmd) {
+  return (opts = {}) => runMain(cmd, opts);
+}
 
-export { defineCommand, parseArgs, renderUsage, runCommand, runMain, showUsage };
+export { createMain, defineCommand, parseArgs, renderUsage, runCommand, runMain, showUsage };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "citty",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "Elegant CLI Builder",
   "repository": "unjs/citty",
   "license": "MIT",
@@ -33,17 +33,17 @@
     "consola": "^3.2.3"
   },
   "devDependencies": {
-    "@types/node": "^20.5.4",
-    "@vitest/coverage-v8": "^0.34.2",
+    "@types/node": "^20.9.0",
+    "@vitest/coverage-v8": "^0.34.6",
     "changelogen": "^0.5.5",
-    "eslint": "^8.47.0",
+    "eslint": "^8.53.0",
     "eslint-config-unjs": "^0.2.1",
-    "jiti": "^1.19.3",
-    "prettier": "^3.0.2",
+    "jiti": "^1.21.0",
+    "prettier": "^3.1.0",
     "scule": "^1.0.0",
     "typescript": "^5.2.2",
     "unbuild": "^2.0.0",
-    "vitest": "^0.34.2"
+    "vitest": "^0.34.6"
   },
-  "packageManager": "pnpm@8.6.12"
+  "packageManager": "pnpm@8.10.3"
 }