citty 0.1.4 → 0.1.6

package/README.md

@@ -88,7 +88,7 @@ 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

@@ -43,18 +43,18 @@ function isUppercase(char = "") {
   if (NUMBER_CHAR_RE.test(char)) {
     return void 0;
   }
-  return char.toUpperCase() === char;
+  return char !== char.toLowerCase();
 }
-function splitByCase(string_, separators) {
+function splitByCase(str, separators) {
   const splitters = separators ?? STR_SPLITTERS;
   const parts = [];
-  if (!string_ || typeof string_ !== "string") {
+  if (!str || typeof str !== "string") {
     return parts;
   }
   let buff = "";
   let previousUpper;
   let previousSplitter;
-  for (const char of string_) {
+  for (const char of str) {
     const isSplitter = splitters.includes(char);
     if (isSplitter === true) {
       parts.push(buff);
@@ -71,7 +71,7 @@ function splitByCase(string_, separators) {
         continue;
       }
       if (previousUpper === true && isUpper === false && buff.length > 1) {
-        const lastChar = buff[buff.length - 1];
+        const lastChar = buff.at(-1);
         parts.push(buff.slice(0, Math.max(0, buff.length - 1)));
         buff = lastChar + char;
         previousUpper = isUpper;
@@ -85,20 +85,20 @@ function splitByCase(string_, separators) {
   parts.push(buff);
   return parts;
 }
-function upperFirst(string_) {
-  return !string_ ? "" : string_[0].toUpperCase() + string_.slice(1);
+function upperFirst(str) {
+  return str ? str[0].toUpperCase() + str.slice(1) : "";
 }
-function lowerFirst(string_) {
-  return !string_ ? "" : string_[0].toLowerCase() + string_.slice(1);
+function lowerFirst(str) {
+  return str ? str[0].toLowerCase() + str.slice(1) : "";
 }
-function pascalCase(string_) {
-  return !string_ ? "" : (Array.isArray(string_) ? string_ : splitByCase(string_)).map((p) => upperFirst(p)).join("");
+function pascalCase(str, opts) {
+  return str ? (Array.isArray(str) ? str : splitByCase(str)).map((p) => upperFirst(opts?.normalize ? p.toLowerCase() : p)).join("") : "";
 }
-function camelCase(string_) {
-  return lowerFirst(pascalCase(string_));
+function camelCase(str, opts) {
+  return lowerFirst(pascalCase(str || "", opts));
 }
-function kebabCase(string_, joiner) {
-  return !string_ ? "" : (Array.isArray(string_) ? string_ : splitByCase(string_)).map((p) => p.toLowerCase()).join(joiner ?? "-");
+function kebabCase(str, joiner) {
+  return str ? (Array.isArray(str) ? str : splitByCase(str)).map((p) => p.toLowerCase()).join(joiner ?? "-") : "";
 }
 
 function toArr(any) {
@@ -293,6 +293,7 @@ async function runCommand(cmd, opts) {
   if (typeof cmd.setup === "function") {
     await cmd.setup(context);
   }
+  let result;
   try {
     const subCommands = await resolveValue(cmd.subCommands);
     if (subCommands && Object.keys(subCommands).length > 0) {
@@ -318,13 +319,14 @@ async function runCommand(cmd, opts) {
       }
     }
     if (typeof cmd.run === "function") {
-      await cmd.run(context);
+      result = await cmd.run(context);
     }
   } finally {
     if (typeof cmd.cleanup === "function") {
       await cmd.cleanup(context);
     }
   }
+  return { result };
 }
 async function resolveSubCommand(cmd, rawArgs, parent) {
   const subCommands = await resolveValue(cmd.subCommands);
@@ -363,8 +365,12 @@ async function renderUsage(cmd, parent) {
     if (arg.type === "positional") {
       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 || ""]);
+      const defaultHint = arg.default ? `="${arg.default}"` : "";
+      posLines.push([
+        "`" + name + defaultHint + "`",
+        arg.description || "",
+        arg.valueHint ? `<${arg.valueHint}>` : ""
+      ]);
       usageLine.push(isRequired ? `<${name}>` : `[${name}]`);
     } else {
       const isRequired = arg.required === true && arg.default === void 0;
@@ -430,9 +436,10 @@ 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;
@@ -449,7 +456,7 @@ 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);

package/dist/index.d.cts

@@ -61,17 +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, createMain, defineCommand, parseArgs, renderUsage, runCommand, runMain, showUsage };

package/dist/index.d.mts

@@ -61,17 +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, createMain, defineCommand, parseArgs, renderUsage, runCommand, runMain, showUsage };

package/dist/index.d.ts

@@ -61,17 +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, createMain, defineCommand, parseArgs, renderUsage, runCommand, runMain, showUsage };

package/dist/index.mjs

@@ -37,18 +37,18 @@ function isUppercase(char = "") {
   if (NUMBER_CHAR_RE.test(char)) {
     return void 0;
   }
-  return char.toUpperCase() === char;
+  return char !== char.toLowerCase();
 }
-function splitByCase(string_, separators) {
+function splitByCase(str, separators) {
   const splitters = separators ?? STR_SPLITTERS;
   const parts = [];
-  if (!string_ || typeof string_ !== "string") {
+  if (!str || typeof str !== "string") {
     return parts;
   }
   let buff = "";
   let previousUpper;
   let previousSplitter;
-  for (const char of string_) {
+  for (const char of str) {
     const isSplitter = splitters.includes(char);
     if (isSplitter === true) {
       parts.push(buff);
@@ -65,7 +65,7 @@ function splitByCase(string_, separators) {
         continue;
       }
       if (previousUpper === true && isUpper === false && buff.length > 1) {
-        const lastChar = buff[buff.length - 1];
+        const lastChar = buff.at(-1);
         parts.push(buff.slice(0, Math.max(0, buff.length - 1)));
         buff = lastChar + char;
         previousUpper = isUpper;
@@ -79,20 +79,20 @@ function splitByCase(string_, separators) {
   parts.push(buff);
   return parts;
 }
-function upperFirst(string_) {
-  return !string_ ? "" : string_[0].toUpperCase() + string_.slice(1);
+function upperFirst(str) {
+  return str ? str[0].toUpperCase() + str.slice(1) : "";
 }
-function lowerFirst(string_) {
-  return !string_ ? "" : string_[0].toLowerCase() + string_.slice(1);
+function lowerFirst(str) {
+  return str ? str[0].toLowerCase() + str.slice(1) : "";
 }
-function pascalCase(string_) {
-  return !string_ ? "" : (Array.isArray(string_) ? string_ : splitByCase(string_)).map((p) => upperFirst(p)).join("");
+function pascalCase(str, opts) {
+  return str ? (Array.isArray(str) ? str : splitByCase(str)).map((p) => upperFirst(opts?.normalize ? p.toLowerCase() : p)).join("") : "";
 }
-function camelCase(string_) {
-  return lowerFirst(pascalCase(string_));
+function camelCase(str, opts) {
+  return lowerFirst(pascalCase(str || "", opts));
 }
-function kebabCase(string_, joiner) {
-  return !string_ ? "" : (Array.isArray(string_) ? string_ : splitByCase(string_)).map((p) => p.toLowerCase()).join(joiner ?? "-");
+function kebabCase(str, joiner) {
+  return str ? (Array.isArray(str) ? str : splitByCase(str)).map((p) => p.toLowerCase()).join(joiner ?? "-") : "";
 }
 
 function toArr(any) {
@@ -287,6 +287,7 @@ async function runCommand(cmd, opts) {
   if (typeof cmd.setup === "function") {
     await cmd.setup(context);
   }
+  let result;
   try {
     const subCommands = await resolveValue(cmd.subCommands);
     if (subCommands && Object.keys(subCommands).length > 0) {
@@ -312,13 +313,14 @@ async function runCommand(cmd, opts) {
       }
     }
     if (typeof cmd.run === "function") {
-      await cmd.run(context);
+      result = await cmd.run(context);
     }
   } finally {
     if (typeof cmd.cleanup === "function") {
       await cmd.cleanup(context);
     }
   }
+  return { result };
 }
 async function resolveSubCommand(cmd, rawArgs, parent) {
   const subCommands = await resolveValue(cmd.subCommands);
@@ -357,8 +359,12 @@ async function renderUsage(cmd, parent) {
     if (arg.type === "positional") {
       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 || ""]);
+      const defaultHint = arg.default ? `="${arg.default}"` : "";
+      posLines.push([
+        "`" + name + defaultHint + "`",
+        arg.description || "",
+        arg.valueHint ? `<${arg.valueHint}>` : ""
+      ]);
       usageLine.push(isRequired ? `<${name}>` : `[${name}]`);
     } else {
       const isRequired = arg.required === true && arg.default === void 0;
@@ -424,9 +430,10 @@ 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;
@@ -443,7 +450,7 @@ 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);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "citty",
-  "version": "0.1.4",
+  "version": "0.1.6",
   "description": "Elegant CLI Builder",
   "repository": "unjs/citty",
   "license": "MIT",
@@ -33,17 +33,17 @@
     "consola": "^3.2.3"
   },
   "devDependencies": {
-    "@types/node": "^20.6.0",
-    "@vitest/coverage-v8": "^0.34.4",
+    "@types/node": "^20.11.17",
+    "@vitest/coverage-v8": "^1.2.2",
     "changelogen": "^0.5.5",
-    "eslint": "^8.49.0",
+    "eslint": "^8.56.0",
     "eslint-config-unjs": "^0.2.1",
-    "jiti": "^1.20.0",
-    "prettier": "^3.0.3",
-    "scule": "^1.0.0",
-    "typescript": "^5.2.2",
+    "jiti": "^1.21.0",
+    "prettier": "^3.2.5",
+    "scule": "^1.3.0",
+    "typescript": "^5.3.3",
     "unbuild": "^2.0.0",
-    "vitest": "^0.34.4"
+    "vitest": "^1.2.2"
   },
-  "packageManager": "pnpm@8.7.4"
+  "packageManager": "pnpm@8.15.1"
 }