citty 0.1.1 → 0.1.3

package/LICENSE

@@ -34,14 +34,3 @@ The above copyright notice and this permission notice shall be included in all c
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
----
-
-Colorette dependency is bundled (https://github.com/jorgebucaran/colorette)
-
-Copyright © Jorge Bucaran <https://jorgebucaran.com>
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/dist/index.cjs

@@ -1,26 +1,17 @@
 'use strict';
 
-const tty = require('tty');
+const consola = require('consola');
+const utils = require('consola/utils');
 
-function _interopNamespaceCompat(e) {
-  if (e && typeof e === 'object' && 'default' in e) return e;
-  const n = Object.create(null);
-  if (e) {
-    for (const k in e) {
-      n[k] = e[k];
-    }
-  }
-  n.default = e;
-  return n;
-}
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e.default : e; }
 
-const tty__namespace = /*#__PURE__*/_interopNamespaceCompat(tty);
+const consola__default = /*#__PURE__*/_interopDefaultCompat(consola);
 
 function toArray(val) {
   if (Array.isArray(val)) {
     return val;
   }
-  return val !== void 0 ? [val] : [];
+  return val === void 0 ? [] : [val];
 }
 function formatLineColumns(lines, linePrefix = "") {
   const maxLengh = [];
@@ -261,13 +252,13 @@ function parseArgs(rawArgs, argsDef) {
       const nextPositionalArgument = positionalArguments.shift();
       if (nextPositionalArgument !== void 0) {
         parsedArgsProxy[arg.name] = nextPositionalArgument;
-      } else if (arg.default !== void 0) {
-        parsedArgsProxy[arg.name] = arg.default;
-      } else {
+      } else if (arg.default === void 0 && arg.required !== false) {
         throw new CLIError(
           `Missing required positional argument: ${arg.name.toUpperCase()}`,
           "EARG"
         );
+      } else {
+        parsedArgsProxy[arg.name] = arg.default;
       }
     } else if (arg.required && parsedArgsProxy[arg.name] === void 0) {
       throw new CLIError(`Missing required argument: --${arg.name}`, "EARG");
@@ -296,6 +287,7 @@ async function runCommand(cmd, opts) {
   const context = {
     rawArgs: opts.rawArgs,
     args: parsedArgs,
+    data: opts.data,
     cmd
   };
   if (typeof cmd.setup === "function") {
@@ -308,15 +300,12 @@ async function runCommand(cmd, opts) {
     );
     const subCommandName = opts.rawArgs[subCommandArgIndex];
     if (!subCommandName && !cmd.run) {
-      throw new CLIError(
-        `Missing sub command. Use --help to see available sub commands.`,
-        "ESUBCOMMAND"
-      );
+      throw new CLIError(`No command specified.`, "E_NO_COMMAND");
     }
     if (!subCommands[subCommandName]) {
       throw new CLIError(
-        `Unknown sub command: ${subCommandName}`,
-        "ESUBCOMMAND"
+        `Unknown command \`${subCommandName}\``,
+        "E_UNKNOWN_COMMAND"
       );
     }
     const subCommand = await resolveValue(subCommands[subCommandName]);
@@ -349,9 +338,9 @@ async function resolveSubCommand(cmd, rawArgs, parent) {
 
 async function showUsage(cmd, parent) {
   try {
-    console.log(await renderUsage(cmd, parent) + "\n");
+    consola__default.log(await renderUsage(cmd, parent) + "\n");
   } catch (error) {
-    console.error(error);
+    consola__default.error(error);
   }
 }
 async function renderUsage(cmd, parent) {
@@ -368,7 +357,7 @@ async function renderUsage(cmd, parent) {
       const name = arg.name.toUpperCase();
       const isRequired = arg.required !== false && arg.default === void 0;
       const usageHint = arg.default ? `="${arg.default}"` : "";
-      posLines.push([name + usageHint, arg.description || ""]);
+      posLines.push(["`" + name + usageHint + "`", arg.description || ""]);
       usageLine.push(isRequired ? `<${name}>` : `[${name}]`);
     } else {
       const isRequired = arg.required === true && arg.default === void 0;
@@ -379,7 +368,7 @@ async function renderUsage(cmd, parent) {
         ", "
       )) + (arg.type === "string" && (arg.valueHint || arg.default) ? `=${arg.valueHint ? `<${arg.valueHint}>` : `"${arg.default || ""}"`}` : "");
       argLines.push([
-        argStr + (isRequired ? " (required)" : ""),
+        "`" + argStr + (isRequired ? " (required)" : "") + "`",
         arg.description || ""
       ]);
       if (isRequired) {
@@ -389,8 +378,11 @@ async function renderUsage(cmd, parent) {
   }
   if (cmd.subCommands) {
     const commandNames = [];
-    for (const [name, sub] of Object.entries(cmd.subCommands)) {
-      commandsLines.push([name, sub.meta?.description || ""]);
+    const subCommands = await resolveValue(cmd.subCommands);
+    for (const [name, sub] of Object.entries(subCommands)) {
+      const subCmd = await resolveValue(sub);
+      const meta = await resolveValue(subCmd?.meta);
+      commandsLines.push([`\`${name}\``, meta?.description || ""]);
       commandNames.push(name);
     }
     usageLine.push(commandNames.join("|"));
@@ -398,29 +390,28 @@ async function renderUsage(cmd, parent) {
   const usageLines = [];
   const version = cmdMeta.version || parentMeta.version;
   usageLines.push(
-    commandName + (version ? ` v${version}` : ""),
-    cmdMeta.description,
+    utils.colors.gray(
+      `${cmdMeta.description} (${commandName + (version ? ` v${version}` : "")})`
+    ),
     ""
   );
   const hasOptions = argLines.length > 0 || posLines.length > 0;
   usageLines.push(
-    `USAGE: ${commandName}${hasOptions ? " [OPTIONS]" : ""} ${usageLine.join(
-      " "
-    )}`,
+    `${utils.colors.underline(utils.colors.bold("USAGE"))} \`${commandName}${hasOptions ? " [OPTIONS]" : ""} ${usageLine.join(" ")}\``,
     ""
   );
   if (posLines.length > 0) {
-    usageLines.push("ARGUMENTS:", "");
+    usageLines.push(utils.colors.underline(utils.colors.bold("ARGUMENTS")), "");
     usageLines.push(formatLineColumns(posLines, "  "));
     usageLines.push("");
   }
   if (argLines.length > 0) {
-    usageLines.push("OPTIONS:", "");
+    usageLines.push(utils.colors.underline(utils.colors.bold("OPTIONS")), "");
     usageLines.push(formatLineColumns(argLines, "  "));
     usageLines.push("");
   }
   if (commandsLines.length > 0) {
-    usageLines.push("COMMANDS:", "");
+    usageLines.push(utils.colors.underline(utils.colors.bold("COMMANDS")), "");
     usageLines.push(formatLineColumns(commandsLines, "  "));
     usageLines.push(
       "",
@@ -430,155 +421,6 @@ async function renderUsage(cmd, parent) {
   return usageLines.filter((l) => typeof l === "string").join("\n");
 }
 
-const {
-  env = {},
-  argv = [],
-  platform = "",
-} = typeof process === "undefined" ? {} : process;
-
-const isDisabled = "NO_COLOR" in env || argv.includes("--no-color");
-const isForced = "FORCE_COLOR" in env || argv.includes("--color");
-const isWindows = platform === "win32";
-const isDumbTerminal = env.TERM === "dumb";
-
-const isCompatibleTerminal =
-  tty__namespace && tty__namespace.isatty && tty__namespace.isatty(1) && env.TERM && !isDumbTerminal;
-
-const isCI =
-  "CI" in env &&
-  ("GITHUB_ACTIONS" in env || "GITLAB_CI" in env || "CIRCLECI" in env);
-
-const isColorSupported =
-  !isDisabled &&
-  (isForced || (isWindows && !isDumbTerminal) || isCompatibleTerminal || isCI);
-
-const replaceClose = (
-  index,
-  string,
-  close,
-  replace,
-  head = string.substring(0, index) + replace,
-  tail = string.substring(index + close.length),
-  next = tail.indexOf(close)
-) => head + (next < 0 ? tail : replaceClose(next, tail, close, replace));
-
-const clearBleed = (index, string, open, close, replace) =>
-  index < 0
-    ? open + string + close
-    : open + replaceClose(index, string, close, replace) + close;
-
-const filterEmpty =
-  (open, close, replace = open, at = open.length + 1) =>
-  (string) =>
-    string || !(string === "" || string === undefined)
-      ? clearBleed(
-          ("" + string).indexOf(close, at),
-          string,
-          open,
-          close,
-          replace
-        )
-      : "";
-
-const init = (open, close, replace) =>
-  filterEmpty(`\x1b[${open}m`, `\x1b[${close}m`, replace);
-
-const colors = {
-  reset: init(0, 0),
-  bold: init(1, 22, "\x1b[22m\x1b[1m"),
-  dim: init(2, 22, "\x1b[22m\x1b[2m"),
-  italic: init(3, 23),
-  underline: init(4, 24),
-  inverse: init(7, 27),
-  hidden: init(8, 28),
-  strikethrough: init(9, 29),
-  black: init(30, 39),
-  red: init(31, 39),
-  green: init(32, 39),
-  yellow: init(33, 39),
-  blue: init(34, 39),
-  magenta: init(35, 39),
-  cyan: init(36, 39),
-  white: init(37, 39),
-  gray: init(90, 39),
-  bgBlack: init(40, 49),
-  bgRed: init(41, 49),
-  bgGreen: init(42, 49),
-  bgYellow: init(43, 49),
-  bgBlue: init(44, 49),
-  bgMagenta: init(45, 49),
-  bgCyan: init(46, 49),
-  bgWhite: init(47, 49),
-  blackBright: init(90, 39),
-  redBright: init(91, 39),
-  greenBright: init(92, 39),
-  yellowBright: init(93, 39),
-  blueBright: init(94, 39),
-  magentaBright: init(95, 39),
-  cyanBright: init(96, 39),
-  whiteBright: init(97, 39),
-  bgBlackBright: init(100, 49),
-  bgRedBright: init(101, 49),
-  bgGreenBright: init(102, 49),
-  bgYellowBright: init(103, 49),
-  bgBlueBright: init(104, 49),
-  bgMagentaBright: init(105, 49),
-  bgCyanBright: init(106, 49),
-  bgWhiteBright: init(107, 49),
-};
-
-const createColors = ({ useColor = isColorSupported } = {}) =>
-  useColor
-    ? colors
-    : Object.keys(colors).reduce(
-        (colors, key) => ({ ...colors, [key]: String }),
-        {}
-      );
-
-const {
-  reset,
-  bold,
-  dim,
-  italic,
-  underline,
-  inverse,
-  hidden,
-  strikethrough,
-  black,
-  red,
-  green,
-  yellow,
-  blue,
-  magenta,
-  cyan,
-  white,
-  gray,
-  bgBlack,
-  bgRed,
-  bgGreen,
-  bgYellow,
-  bgBlue,
-  bgMagenta,
-  bgCyan,
-  bgWhite,
-  blackBright,
-  redBright,
-  greenBright,
-  yellowBright,
-  blueBright,
-  magentaBright,
-  cyanBright,
-  whiteBright,
-  bgBlackBright,
-  bgRedBright,
-  bgGreenBright,
-  bgYellowBright,
-  bgBlueBright,
-  bgMagentaBright,
-  bgCyanBright,
-  bgWhiteBright,
-} = createColors();
-
 async function runMain(cmd, opts = {}) {
   const rawArgs = opts.rawArgs || process.argv.slice(2);
   try {
@@ -591,16 +433,12 @@ async function runMain(cmd, opts = {}) {
   } catch (error) {
     const isCLIError = error instanceof CLIError;
     if (!isCLIError) {
-      console.error(error, "\n");
+      consola__default.error(error, "\n");
     }
-    console.error(
-      `
-${bgRed(` ${error.code || error.name} `)} ${error.message}
-`
-    );
     if (isCLIError) {
       await showUsage(...await resolveSubCommand(cmd, rawArgs));
     }
+    consola__default.error(error.message);
     process.exit(1);
   }
 }

package/dist/index.d.cts

@@ -0,0 +1,76 @@
+type ArgType = "boolean" | "string" | "positional" | undefined;
+type _ArgDef<T extends ArgType, VT extends boolean | string> = {
+    type?: T;
+    description?: string;
+    valueHint?: string;
+    alias?: string | string[];
+    default?: VT;
+    required?: boolean;
+};
+type BooleanArgDef = _ArgDef<"boolean", boolean>;
+type StringArgDef = _ArgDef<"string", string>;
+type PositionalArgDef = Omit<_ArgDef<"positional", string>, "alias">;
+type ArgDef = BooleanArgDef | StringArgDef | PositionalArgDef;
+type ArgsDef = Record<string, ArgDef>;
+type Arg = ArgDef & {
+    name: string;
+    alias: string[];
+};
+type ParsedArgs<T extends ArgsDef = ArgsDef> = {
+    _: string[];
+} & Record<{
+    [K in keyof T]: T[K] extends {
+        type: "positional";
+    } ? K : never;
+}[keyof T], string> & Record<{
+    [K in keyof T]: T[K] extends {
+        type: "string";
+    } ? K : never;
+}[keyof T], string> & Record<{
+    [K in keyof T]: T[K] extends {
+        type: "boolean";
+    } ? K : never;
+}[keyof T], boolean> & Record<string, string | boolean | string[]>;
+interface CommandMeta {
+    name?: string;
+    version?: string;
+    description?: string;
+}
+type SubCommandsDef = Record<string, Resolvable<CommandDef<any>>>;
+type CommandDef<T extends ArgsDef = ArgsDef> = {
+    meta?: Resolvable<CommandMeta>;
+    args?: Resolvable<T>;
+    subCommands?: Resolvable<SubCommandsDef>;
+    setup?: (context: CommandContext<T>) => any | Promise<any>;
+    cleanup?: (context: CommandContext<T>) => any | Promise<any>;
+    run?: (context: CommandContext<T>) => any | Promise<any>;
+};
+type CommandContext<T extends ArgsDef = ArgsDef> = {
+    rawArgs: string[];
+    args: ParsedArgs<T>;
+    cmd: CommandDef<T>;
+    subCommand?: CommandDef<T>;
+    data?: any;
+};
+type Awaitable<T> = () => T | Promise<T>;
+type Resolvable<T> = T | Promise<T> | (() => T) | (() => Promise<T>);
+
+declare function defineCommand<T extends ArgsDef = ArgsDef>(def: CommandDef<T>): CommandDef<T>;
+interface RunCommandOptions {
+    rawArgs: string[];
+    data?: any;
+    showUsage?: boolean;
+}
+declare function runCommand<T extends ArgsDef = ArgsDef>(cmd: CommandDef<T>, opts: RunCommandOptions): Promise<void>;
+
+interface RunMainOptions {
+    rawArgs?: string[];
+}
+declare function runMain<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 };

package/dist/index.d.mts

@@ -0,0 +1,76 @@
+type ArgType = "boolean" | "string" | "positional" | undefined;
+type _ArgDef<T extends ArgType, VT extends boolean | string> = {
+    type?: T;
+    description?: string;
+    valueHint?: string;
+    alias?: string | string[];
+    default?: VT;
+    required?: boolean;
+};
+type BooleanArgDef = _ArgDef<"boolean", boolean>;
+type StringArgDef = _ArgDef<"string", string>;
+type PositionalArgDef = Omit<_ArgDef<"positional", string>, "alias">;
+type ArgDef = BooleanArgDef | StringArgDef | PositionalArgDef;
+type ArgsDef = Record<string, ArgDef>;
+type Arg = ArgDef & {
+    name: string;
+    alias: string[];
+};
+type ParsedArgs<T extends ArgsDef = ArgsDef> = {
+    _: string[];
+} & Record<{
+    [K in keyof T]: T[K] extends {
+        type: "positional";
+    } ? K : never;
+}[keyof T], string> & Record<{
+    [K in keyof T]: T[K] extends {
+        type: "string";
+    } ? K : never;
+}[keyof T], string> & Record<{
+    [K in keyof T]: T[K] extends {
+        type: "boolean";
+    } ? K : never;
+}[keyof T], boolean> & Record<string, string | boolean | string[]>;
+interface CommandMeta {
+    name?: string;
+    version?: string;
+    description?: string;
+}
+type SubCommandsDef = Record<string, Resolvable<CommandDef<any>>>;
+type CommandDef<T extends ArgsDef = ArgsDef> = {
+    meta?: Resolvable<CommandMeta>;
+    args?: Resolvable<T>;
+    subCommands?: Resolvable<SubCommandsDef>;
+    setup?: (context: CommandContext<T>) => any | Promise<any>;
+    cleanup?: (context: CommandContext<T>) => any | Promise<any>;
+    run?: (context: CommandContext<T>) => any | Promise<any>;
+};
+type CommandContext<T extends ArgsDef = ArgsDef> = {
+    rawArgs: string[];
+    args: ParsedArgs<T>;
+    cmd: CommandDef<T>;
+    subCommand?: CommandDef<T>;
+    data?: any;
+};
+type Awaitable<T> = () => T | Promise<T>;
+type Resolvable<T> = T | Promise<T> | (() => T) | (() => Promise<T>);
+
+declare function defineCommand<T extends ArgsDef = ArgsDef>(def: CommandDef<T>): CommandDef<T>;
+interface RunCommandOptions {
+    rawArgs: string[];
+    data?: any;
+    showUsage?: boolean;
+}
+declare function runCommand<T extends ArgsDef = ArgsDef>(cmd: CommandDef<T>, opts: RunCommandOptions): Promise<void>;
+
+interface RunMainOptions {
+    rawArgs?: string[];
+}
+declare function runMain<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 };

package/dist/index.d.ts

@@ -30,7 +30,7 @@ type ParsedArgs<T extends ArgsDef = ArgsDef> = {
     [K in keyof T]: T[K] extends {
         type: "boolean";
     } ? K : never;
-}[keyof T], boolean> & Record<string, string | boolean>;
+}[keyof T], boolean> & Record<string, string | boolean | string[]>;
 interface CommandMeta {
     name?: string;
     version?: string;
@@ -48,8 +48,9 @@ type CommandDef<T extends ArgsDef = ArgsDef> = {
 type CommandContext<T extends ArgsDef = ArgsDef> = {
     rawArgs: string[];
     args: ParsedArgs<T>;
-    cmd: CommandDef;
+    cmd: CommandDef<T>;
     subCommand?: CommandDef<T>;
+    data?: any;
 };
 type Awaitable<T> = () => T | Promise<T>;
 type Resolvable<T> = T | Promise<T> | (() => T) | (() => Promise<T>);
@@ -57,18 +58,19 @@ type Resolvable<T> = T | Promise<T> | (() => T) | (() => Promise<T>);
 declare function defineCommand<T extends ArgsDef = ArgsDef>(def: CommandDef<T>): CommandDef<T>;
 interface RunCommandOptions {
     rawArgs: string[];
+    data?: any;
     showUsage?: boolean;
 }
-declare function runCommand(cmd: CommandDef, opts: RunCommandOptions): Promise<void>;
+declare function runCommand<T extends ArgsDef = ArgsDef>(cmd: CommandDef<T>, opts: RunCommandOptions): Promise<void>;
 
 interface RunMainOptions {
     rawArgs?: string[];
 }
-declare function runMain(cmd: CommandDef, opts?: RunMainOptions): Promise<void>;
+declare function runMain<T extends ArgsDef = ArgsDef>(cmd: CommandDef<T>, opts?: RunMainOptions): Promise<void>;
 
-declare function parseArgs(rawArgs: string[], argsDef: ArgsDef): ParsedArgs;
+declare function parseArgs<T extends ArgsDef = ArgsDef>(rawArgs: string[], argsDef: ArgsDef): ParsedArgs<T>;
 
-declare function showUsage(cmd: CommandDef, parent?: CommandDef): Promise<void>;
-declare function renderUsage(cmd: CommandDef, parent?: CommandDef): Promise<string>;
+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 { Arg, ArgDef, ArgType, ArgsDef, Awaitable, BooleanArgDef, CommandContext, CommandDef, CommandMeta, ParsedArgs, PositionalArgDef, Resolvable, RunCommandOptions, RunMainOptions, StringArgDef, SubCommandsDef, _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, defineCommand, parseArgs, renderUsage, runCommand, runMain, showUsage };

package/dist/index.mjs

@@ -1,10 +1,11 @@
-import * as tty from 'tty';
+import consola from 'consola';
+import { colors } from 'consola/utils';
 
 function toArray(val) {
   if (Array.isArray(val)) {
     return val;
   }
-  return val !== void 0 ? [val] : [];
+  return val === void 0 ? [] : [val];
 }
 function formatLineColumns(lines, linePrefix = "") {
   const maxLengh = [];
@@ -245,13 +246,13 @@ function parseArgs(rawArgs, argsDef) {
       const nextPositionalArgument = positionalArguments.shift();
       if (nextPositionalArgument !== void 0) {
         parsedArgsProxy[arg.name] = nextPositionalArgument;
-      } else if (arg.default !== void 0) {
-        parsedArgsProxy[arg.name] = arg.default;
-      } else {
+      } else if (arg.default === void 0 && arg.required !== false) {
         throw new CLIError(
           `Missing required positional argument: ${arg.name.toUpperCase()}`,
           "EARG"
         );
+      } else {
+        parsedArgsProxy[arg.name] = arg.default;
       }
     } else if (arg.required && parsedArgsProxy[arg.name] === void 0) {
       throw new CLIError(`Missing required argument: --${arg.name}`, "EARG");
@@ -280,6 +281,7 @@ async function runCommand(cmd, opts) {
   const context = {
     rawArgs: opts.rawArgs,
     args: parsedArgs,
+    data: opts.data,
     cmd
   };
   if (typeof cmd.setup === "function") {
@@ -292,15 +294,12 @@ async function runCommand(cmd, opts) {
     );
     const subCommandName = opts.rawArgs[subCommandArgIndex];
     if (!subCommandName && !cmd.run) {
-      throw new CLIError(
-        `Missing sub command. Use --help to see available sub commands.`,
-        "ESUBCOMMAND"
-      );
+      throw new CLIError(`No command specified.`, "E_NO_COMMAND");
     }
     if (!subCommands[subCommandName]) {
       throw new CLIError(
-        `Unknown sub command: ${subCommandName}`,
-        "ESUBCOMMAND"
+        `Unknown command \`${subCommandName}\``,
+        "E_UNKNOWN_COMMAND"
       );
     }
     const subCommand = await resolveValue(subCommands[subCommandName]);
@@ -333,9 +332,9 @@ async function resolveSubCommand(cmd, rawArgs, parent) {
 
 async function showUsage(cmd, parent) {
   try {
-    console.log(await renderUsage(cmd, parent) + "\n");
+    consola.log(await renderUsage(cmd, parent) + "\n");
   } catch (error) {
-    console.error(error);
+    consola.error(error);
   }
 }
 async function renderUsage(cmd, parent) {
@@ -352,7 +351,7 @@ async function renderUsage(cmd, parent) {
       const name = arg.name.toUpperCase();
       const isRequired = arg.required !== false && arg.default === void 0;
       const usageHint = arg.default ? `="${arg.default}"` : "";
-      posLines.push([name + usageHint, arg.description || ""]);
+      posLines.push(["`" + name + usageHint + "`", arg.description || ""]);
       usageLine.push(isRequired ? `<${name}>` : `[${name}]`);
     } else {
       const isRequired = arg.required === true && arg.default === void 0;
@@ -363,7 +362,7 @@ async function renderUsage(cmd, parent) {
         ", "
       )) + (arg.type === "string" && (arg.valueHint || arg.default) ? `=${arg.valueHint ? `<${arg.valueHint}>` : `"${arg.default || ""}"`}` : "");
       argLines.push([
-        argStr + (isRequired ? " (required)" : ""),
+        "`" + argStr + (isRequired ? " (required)" : "") + "`",
         arg.description || ""
       ]);
       if (isRequired) {
@@ -373,8 +372,11 @@ async function renderUsage(cmd, parent) {
   }
   if (cmd.subCommands) {
     const commandNames = [];
-    for (const [name, sub] of Object.entries(cmd.subCommands)) {
-      commandsLines.push([name, sub.meta?.description || ""]);
+    const subCommands = await resolveValue(cmd.subCommands);
+    for (const [name, sub] of Object.entries(subCommands)) {
+      const subCmd = await resolveValue(sub);
+      const meta = await resolveValue(subCmd?.meta);
+      commandsLines.push([`\`${name}\``, meta?.description || ""]);
       commandNames.push(name);
     }
     usageLine.push(commandNames.join("|"));
@@ -382,29 +384,28 @@ async function renderUsage(cmd, parent) {
   const usageLines = [];
   const version = cmdMeta.version || parentMeta.version;
   usageLines.push(
-    commandName + (version ? ` v${version}` : ""),
-    cmdMeta.description,
+    colors.gray(
+      `${cmdMeta.description} (${commandName + (version ? ` v${version}` : "")})`
+    ),
     ""
   );
   const hasOptions = argLines.length > 0 || posLines.length > 0;
   usageLines.push(
-    `USAGE: ${commandName}${hasOptions ? " [OPTIONS]" : ""} ${usageLine.join(
-      " "
-    )}`,
+    `${colors.underline(colors.bold("USAGE"))} \`${commandName}${hasOptions ? " [OPTIONS]" : ""} ${usageLine.join(" ")}\``,
     ""
   );
   if (posLines.length > 0) {
-    usageLines.push("ARGUMENTS:", "");
+    usageLines.push(colors.underline(colors.bold("ARGUMENTS")), "");
     usageLines.push(formatLineColumns(posLines, "  "));
     usageLines.push("");
   }
   if (argLines.length > 0) {
-    usageLines.push("OPTIONS:", "");
+    usageLines.push(colors.underline(colors.bold("OPTIONS")), "");
     usageLines.push(formatLineColumns(argLines, "  "));
     usageLines.push("");
   }
   if (commandsLines.length > 0) {
-    usageLines.push("COMMANDS:", "");
+    usageLines.push(colors.underline(colors.bold("COMMANDS")), "");
     usageLines.push(formatLineColumns(commandsLines, "  "));
     usageLines.push(
       "",
@@ -414,155 +415,6 @@ async function renderUsage(cmd, parent) {
   return usageLines.filter((l) => typeof l === "string").join("\n");
 }
 
-const {
-  env = {},
-  argv = [],
-  platform = "",
-} = typeof process === "undefined" ? {} : process;
-
-const isDisabled = "NO_COLOR" in env || argv.includes("--no-color");
-const isForced = "FORCE_COLOR" in env || argv.includes("--color");
-const isWindows = platform === "win32";
-const isDumbTerminal = env.TERM === "dumb";
-
-const isCompatibleTerminal =
-  tty && tty.isatty && tty.isatty(1) && env.TERM && !isDumbTerminal;
-
-const isCI =
-  "CI" in env &&
-  ("GITHUB_ACTIONS" in env || "GITLAB_CI" in env || "CIRCLECI" in env);
-
-const isColorSupported =
-  !isDisabled &&
-  (isForced || (isWindows && !isDumbTerminal) || isCompatibleTerminal || isCI);
-
-const replaceClose = (
-  index,
-  string,
-  close,
-  replace,
-  head = string.substring(0, index) + replace,
-  tail = string.substring(index + close.length),
-  next = tail.indexOf(close)
-) => head + (next < 0 ? tail : replaceClose(next, tail, close, replace));
-
-const clearBleed = (index, string, open, close, replace) =>
-  index < 0
-    ? open + string + close
-    : open + replaceClose(index, string, close, replace) + close;
-
-const filterEmpty =
-  (open, close, replace = open, at = open.length + 1) =>
-  (string) =>
-    string || !(string === "" || string === undefined)
-      ? clearBleed(
-          ("" + string).indexOf(close, at),
-          string,
-          open,
-          close,
-          replace
-        )
-      : "";
-
-const init = (open, close, replace) =>
-  filterEmpty(`\x1b[${open}m`, `\x1b[${close}m`, replace);
-
-const colors = {
-  reset: init(0, 0),
-  bold: init(1, 22, "\x1b[22m\x1b[1m"),
-  dim: init(2, 22, "\x1b[22m\x1b[2m"),
-  italic: init(3, 23),
-  underline: init(4, 24),
-  inverse: init(7, 27),
-  hidden: init(8, 28),
-  strikethrough: init(9, 29),
-  black: init(30, 39),
-  red: init(31, 39),
-  green: init(32, 39),
-  yellow: init(33, 39),
-  blue: init(34, 39),
-  magenta: init(35, 39),
-  cyan: init(36, 39),
-  white: init(37, 39),
-  gray: init(90, 39),
-  bgBlack: init(40, 49),
-  bgRed: init(41, 49),
-  bgGreen: init(42, 49),
-  bgYellow: init(43, 49),
-  bgBlue: init(44, 49),
-  bgMagenta: init(45, 49),
-  bgCyan: init(46, 49),
-  bgWhite: init(47, 49),
-  blackBright: init(90, 39),
-  redBright: init(91, 39),
-  greenBright: init(92, 39),
-  yellowBright: init(93, 39),
-  blueBright: init(94, 39),
-  magentaBright: init(95, 39),
-  cyanBright: init(96, 39),
-  whiteBright: init(97, 39),
-  bgBlackBright: init(100, 49),
-  bgRedBright: init(101, 49),
-  bgGreenBright: init(102, 49),
-  bgYellowBright: init(103, 49),
-  bgBlueBright: init(104, 49),
-  bgMagentaBright: init(105, 49),
-  bgCyanBright: init(106, 49),
-  bgWhiteBright: init(107, 49),
-};
-
-const createColors = ({ useColor = isColorSupported } = {}) =>
-  useColor
-    ? colors
-    : Object.keys(colors).reduce(
-        (colors, key) => ({ ...colors, [key]: String }),
-        {}
-      );
-
-const {
-  reset,
-  bold,
-  dim,
-  italic,
-  underline,
-  inverse,
-  hidden,
-  strikethrough,
-  black,
-  red,
-  green,
-  yellow,
-  blue,
-  magenta,
-  cyan,
-  white,
-  gray,
-  bgBlack,
-  bgRed,
-  bgGreen,
-  bgYellow,
-  bgBlue,
-  bgMagenta,
-  bgCyan,
-  bgWhite,
-  blackBright,
-  redBright,
-  greenBright,
-  yellowBright,
-  blueBright,
-  magentaBright,
-  cyanBright,
-  whiteBright,
-  bgBlackBright,
-  bgRedBright,
-  bgGreenBright,
-  bgYellowBright,
-  bgBlueBright,
-  bgMagentaBright,
-  bgCyanBright,
-  bgWhiteBright,
-} = createColors();
-
 async function runMain(cmd, opts = {}) {
   const rawArgs = opts.rawArgs || process.argv.slice(2);
   try {
@@ -575,16 +427,12 @@ async function runMain(cmd, opts = {}) {
   } catch (error) {
     const isCLIError = error instanceof CLIError;
     if (!isCLIError) {
-      console.error(error, "\n");
+      consola.error(error, "\n");
     }
-    console.error(
-      `
-${bgRed(` ${error.code || error.name} `)} ${error.message}
-`
-    );
     if (isCLIError) {
       await showUsage(...await resolveSubCommand(cmd, rawArgs));
     }
+    consola.error(error.message);
     process.exit(1);
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "citty",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Elegant CLI Builder",
   "repository": "unjs/citty",
   "license": "MIT",
@@ -29,19 +29,21 @@
     "release": "pnpm test && changelogen --release --push && npm publish",
     "test": "pnpm lint && vitest run --coverage"
   },
+  "dependencies": {
+    "consola": "^3.2.3"
+  },
   "devDependencies": {
-    "@types/node": "^18.15.11",
-    "@vitest/coverage-c8": "^0.29.8",
-    "changelogen": "^0.5.2",
-    "colorette": "^2.0.19",
-    "eslint": "^8.37.0",
-    "eslint-config-unjs": "^0.1.0",
-    "jiti": "^1.18.2",
-    "prettier": "^2.8.7",
+    "@types/node": "^20.5.4",
+    "@vitest/coverage-v8": "^0.34.2",
+    "changelogen": "^0.5.5",
+    "eslint": "^8.47.0",
+    "eslint-config-unjs": "^0.2.1",
+    "jiti": "^1.19.3",
+    "prettier": "^3.0.2",
     "scule": "^1.0.0",
-    "typescript": "^5.0.3",
-    "unbuild": "^1.2.0",
-    "vitest": "^0.29.8"
+    "typescript": "^5.2.2",
+    "unbuild": "^2.0.0",
+    "vitest": "^0.34.2"
   },
-  "packageManager": "pnpm@8.1.0"
+  "packageManager": "pnpm@8.6.12"
 }