citty 0.0.1 → 0.1.0

package/dist/index.cjs

@@ -1,19 +1,7 @@
 'use strict';
 
-const tty = require('tty');
-
-function _interopNamespaceDefault(e) {
-  const n = Object.create(null);
-  if (e) {
-    for (const k in e) {
-      n[k] = e[k];
-    }
-  }
-  n.default = e;
-  return n;
-}
-
-const tty__namespace = /*#__PURE__*/_interopNamespaceDefault(tty);
+const scule = require('scule');
+const colorette = require('colorette');
 
 function toArray(val) {
   if (Array.isArray(val)) {
@@ -180,23 +168,30 @@ function parseArgs(rawArgs, argsDef) {
     }
   }
   const parsed = parseRawArgs(rawArgs, parseOptions);
-  for (const [i, arg] of args.entries()) {
+  const [, ...positionalArguments] = parsed._;
+  const parsedArgsProxy = new Proxy(parsed, {
+    get(target, prop) {
+      return target[prop] ?? target[scule.camelCase(prop)] ?? target[scule.kebabCase(prop)];
+    }
+  });
+  for (const [, arg] of args.entries()) {
     if (arg.type === "positional") {
-      if (parsed._[i] !== void 0) {
-        parsed[arg.name] = parsed._[i];
+      const nextPositionalArgument = positionalArguments.shift();
+      if (nextPositionalArgument !== void 0) {
+        parsedArgsProxy[arg.name] = nextPositionalArgument;
       } else if (arg.default !== void 0) {
-        parsed[arg.name] = arg.default;
+        parsedArgsProxy[arg.name] = arg.default;
       } else {
         throw new CLIError(
           `Missing required positional argument: ${arg.name.toUpperCase()}`,
           "EARG"
         );
       }
-    } else if (arg.required && parsed[arg.name] === void 0) {
+    } else if (arg.required && parsedArgsProxy[arg.name] === void 0) {
       throw new CLIError(`Missing required argument: --${arg.name}`, "EARG");
     }
   }
-  return parsed;
+  return parsedArgsProxy;
 }
 function resolveArgs(argsDef) {
   const args = [];
@@ -214,17 +209,18 @@ function defineCommand(def) {
   return def;
 }
 async function runCommand(cmd, opts) {
-  if (typeof cmd.run === "function") {
-    const cmdArgs = await resolveValue(cmd.args || {});
-    const parsedArgs = parseArgs(opts.rawArgs, cmdArgs);
-    await cmd.run({
-      rawArgs: opts.rawArgs,
-      args: parsedArgs,
-      cmd
-    });
+  const cmdArgs = await resolveValue(cmd.args || {});
+  const parsedArgs = parseArgs(opts.rawArgs, cmdArgs);
+  const context = {
+    rawArgs: opts.rawArgs,
+    args: parsedArgs,
+    cmd
+  };
+  if (typeof cmd.setup === "function") {
+    await cmd.setup(context);
   }
   const subCommands = await resolveValue(cmd.subCommands);
-  if (subCommands && Object.keys(subCommands.length > 0)) {
+  if (subCommands && Object.keys(subCommands).length > 0) {
     const subCommandArgIndex = opts.rawArgs.findIndex(
       (arg) => !arg.startsWith("-")
     );
@@ -248,10 +244,13 @@ async function runCommand(cmd, opts) {
       });
     }
   }
+  if (typeof cmd.run === "function") {
+    await cmd.run(context);
+  }
 }
 async function resolveSubCommand(cmd, rawArgs, parent) {
   const subCommands = await resolveValue(cmd.subCommands);
-  if (subCommands && Object.keys(subCommands.length > 0)) {
+  if (subCommands && Object.keys(subCommands).length > 0) {
     const subCommandArgIndex = rawArgs.findIndex((arg) => !arg.startsWith("-"));
     const subCommandName = rawArgs[subCommandArgIndex];
     const subCommand = await resolveValue(subCommands[subCommandName]);
@@ -349,155 +348,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 {
@@ -514,7 +364,7 @@ async function runMain(cmd, opts = {}) {
     }
     console.error(
       `
-${bgRed(` ${error.code || error.name} `)} ${error.message}
+${colorette.bgRed(` ${error.code || error.name} `)} ${error.message}
 `
     );
     if (isCLIError) {

package/dist/index.d.ts

@@ -16,31 +16,45 @@ type Arg = ArgDef & {
     name: string;
     alias: string[];
 };
-type ParsedArgs = Record<string, string | boolean> & {
+type ParsedArgs<T extends ArgsDef = ArgsDef> = {
     _: string[];
-};
+} & Record<{
+    [K in keyof T]: T[K] extends {
+        type: "positional";
+    } ? K : never;
+}[keyof T], string | boolean> & 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>;
 interface CommandMeta {
     name?: string;
     version?: string;
     description?: string;
 }
-type SubCommandsDef = Record<string, Resolvable<CommandDef>>;
-type CommandDef = {
+type SubCommandsDef = Record<string, Resolvable<CommandDef<any>>>;
+type CommandDef<T extends ArgsDef = ArgsDef> = {
     meta?: Resolvable<CommandMeta>;
-    args?: Resolvable<ArgsDef>;
+    args?: Resolvable<T>;
     subCommands?: Resolvable<SubCommandsDef>;
-    run?: CommandRun;
+    setup?: (context: CommandContext<T>) => any | Promise<any>;
+    cleanup?: (context: CommandContext<T>) => any | Promise<any>;
+    run?: (context: CommandContext<T>) => any | Promise<any>;
 };
-type CommandRun = (context: CommandContext) => any | Promise<any>;
-interface CommandContext {
+type CommandContext<T extends ArgsDef = ArgsDef> = {
     rawArgs: string[];
-    args: ParsedArgs;
+    args: ParsedArgs<T>;
     cmd: CommandDef;
-}
+    subCommand?: CommandDef<T>;
+};
 type Awaitable<T> = () => T | Promise<T>;
 type Resolvable<T> = T | Promise<T> | (() => T) | (() => Promise<T>);
 
-declare function defineCommand(def: CommandDef): CommandDef;
+declare function defineCommand<T extends ArgsDef = ArgsDef>(def: CommandDef<T>): CommandDef<T>;
 interface RunCommandOptions {
     rawArgs: string[];
     showUsage?: boolean;
@@ -57,4 +71,4 @@ declare function parseArgs(rawArgs: string[], argsDef: ArgsDef): ParsedArgs;
 declare function showUsage(cmd: CommandDef, parent?: CommandDef): Promise<void>;
 declare function renderUsage(cmd: CommandDef, parent?: CommandDef): Promise<string>;
 
-export { Arg, ArgDef, ArgType, ArgsDef, Awaitable, BooleanArgDef, CommandContext, CommandDef, CommandMeta, CommandRun, ParsedArgs, PositionalArgDef, Resolvable, RunCommandOptions, RunMainOptions, StringArgDef, SubCommandsDef, _ArgDef, defineCommand, parseArgs, renderUsage, runCommand, runMain, showUsage };
+export { Arg, ArgDef, ArgType, ArgsDef, Awaitable, BooleanArgDef, CommandContext, CommandDef, CommandMeta, ParsedArgs, PositionalArgDef, Resolvable, RunCommandOptions, RunMainOptions, StringArgDef, SubCommandsDef, _ArgDef, defineCommand, parseArgs, renderUsage, runCommand, runMain, showUsage };

package/dist/index.mjs

@@ -1,4 +1,5 @@
-import * as tty from 'tty';
+import { camelCase, kebabCase } from 'scule';
+import { bgRed } from 'colorette';
 
 function toArray(val) {
   if (Array.isArray(val)) {
@@ -165,23 +166,30 @@ function parseArgs(rawArgs, argsDef) {
     }
   }
   const parsed = parseRawArgs(rawArgs, parseOptions);
-  for (const [i, arg] of args.entries()) {
+  const [, ...positionalArguments] = parsed._;
+  const parsedArgsProxy = new Proxy(parsed, {
+    get(target, prop) {
+      return target[prop] ?? target[camelCase(prop)] ?? target[kebabCase(prop)];
+    }
+  });
+  for (const [, arg] of args.entries()) {
     if (arg.type === "positional") {
-      if (parsed._[i] !== void 0) {
-        parsed[arg.name] = parsed._[i];
+      const nextPositionalArgument = positionalArguments.shift();
+      if (nextPositionalArgument !== void 0) {
+        parsedArgsProxy[arg.name] = nextPositionalArgument;
       } else if (arg.default !== void 0) {
-        parsed[arg.name] = arg.default;
+        parsedArgsProxy[arg.name] = arg.default;
       } else {
         throw new CLIError(
           `Missing required positional argument: ${arg.name.toUpperCase()}`,
           "EARG"
         );
       }
-    } else if (arg.required && parsed[arg.name] === void 0) {
+    } else if (arg.required && parsedArgsProxy[arg.name] === void 0) {
       throw new CLIError(`Missing required argument: --${arg.name}`, "EARG");
     }
   }
-  return parsed;
+  return parsedArgsProxy;
 }
 function resolveArgs(argsDef) {
   const args = [];
@@ -199,17 +207,18 @@ function defineCommand(def) {
   return def;
 }
 async function runCommand(cmd, opts) {
-  if (typeof cmd.run === "function") {
-    const cmdArgs = await resolveValue(cmd.args || {});
-    const parsedArgs = parseArgs(opts.rawArgs, cmdArgs);
-    await cmd.run({
-      rawArgs: opts.rawArgs,
-      args: parsedArgs,
-      cmd
-    });
+  const cmdArgs = await resolveValue(cmd.args || {});
+  const parsedArgs = parseArgs(opts.rawArgs, cmdArgs);
+  const context = {
+    rawArgs: opts.rawArgs,
+    args: parsedArgs,
+    cmd
+  };
+  if (typeof cmd.setup === "function") {
+    await cmd.setup(context);
   }
   const subCommands = await resolveValue(cmd.subCommands);
-  if (subCommands && Object.keys(subCommands.length > 0)) {
+  if (subCommands && Object.keys(subCommands).length > 0) {
     const subCommandArgIndex = opts.rawArgs.findIndex(
       (arg) => !arg.startsWith("-")
     );
@@ -233,10 +242,13 @@ async function runCommand(cmd, opts) {
       });
     }
   }
+  if (typeof cmd.run === "function") {
+    await cmd.run(context);
+  }
 }
 async function resolveSubCommand(cmd, rawArgs, parent) {
   const subCommands = await resolveValue(cmd.subCommands);
-  if (subCommands && Object.keys(subCommands.length > 0)) {
+  if (subCommands && Object.keys(subCommands).length > 0) {
     const subCommandArgIndex = rawArgs.findIndex((arg) => !arg.startsWith("-"));
     const subCommandName = rawArgs[subCommandArgIndex];
     const subCommand = await resolveValue(subCommands[subCommandName]);
@@ -334,155 +346,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 {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "citty",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Elegant CLI Builder",
   "repository": "unjs/citty",
   "license": "MIT",
@@ -29,18 +29,19 @@
     "release": "pnpm test && changelogen --release --push && npm publish",
     "test": "pnpm lint && vitest run --coverage"
   },
-  "devDependencies": {
-    "@types/node": "^18.15.3",
-    "@vitest/coverage-c8": "^0.29.2",
-    "changelogen": "^0.5.1",
+  "dependencies": {
+    "@types/node": "^18.15.11",
+    "@vitest/coverage-c8": "^0.29.8",
+    "changelogen": "^0.5.2",
     "colorette": "^2.0.19",
-    "eslint": "^8.36.0",
+    "eslint": "^8.37.0",
     "eslint-config-unjs": "^0.1.0",
-    "jiti": "^1.17.2",
-    "prettier": "^2.8.4",
-    "typescript": "^4.9.5",
+    "jiti": "^1.18.2",
+    "prettier": "^2.8.7",
+    "scule": "^1.0.0",
+    "typescript": "^5.0.3",
     "unbuild": "^1.1.2",
-    "vitest": "^0.29.2"
+    "vitest": "^0.29.8"
   },
-  "packageManager": "pnpm@7.25.1"
-}
+  "packageManager": "pnpm@8.1.0"
+}