@xmorse/cac 6.0.0 → 6.0.2

package/deno/CAC.ts

@@ -170,7 +170,7 @@ class CAC extends EventEmitter {
     // Search sub-commands
     for (const command of sortedCommands) {
       const parsed = this.mri(argv.slice(2), command);
-      const result = command.isMatched((parsed.args as string[]));
+      const result = command.isMatched(parsed.args as string[]);
       if (result.matched) {
         shouldParse = false;
         const matchedCommandName = parsed.args.slice(0, result.consumedArgs).join(' ');

package/deno/Command.ts

@@ -144,13 +144,23 @@ class Command {
       title: 'Usage',
       body: `  $ ${name} ${this.usageText || this.rawName}`
     });
+
+    // Show full description for specific commands (not global/default)
+    if (!this.isGlobalCommand && !this.isDefaultCommand && this.description) {
+      sections.push({
+        title: 'Description',
+        body: this.description.split('\n').map(line => `  ${line}`).join('\n')
+      });
+    }
     const showCommands = (this.isGlobalCommand || this.isDefaultCommand) && commands.length > 0;
     if (showCommands) {
       const longestCommandName = findLongest(commands.map(command => command.rawName));
       sections.push({
         title: 'Commands',
         body: commands.map(command => {
-          return `  ${padRight(command.rawName, longestCommandName.length)}  ${command.description}`;
+          // Only show first line of description in commands listing
+          const firstLine = command.description.split('\n')[0].trim();
+          return `  ${padRight(command.rawName, longestCommandName.length)}  ${firstLine}`;
         }).join('\n')
       });
       sections.push({

package/dist/index.js

@@ -352,13 +352,20 @@ class Command {
       title: "Usage",
       body: `  $ ${name} ${this.usageText || this.rawName}`
     });
+    if (!this.isGlobalCommand && !this.isDefaultCommand && this.description) {
+      sections.push({
+        title: "Description",
+        body: this.description.split("\n").map((line) => `  ${line}`).join("\n")
+      });
+    }
     const showCommands = (this.isGlobalCommand || this.isDefaultCommand) && commands.length > 0;
     if (showCommands) {
       const longestCommandName = findLongest(commands.map((command) => command.rawName));
       sections.push({
         title: "Commands",
         body: commands.map((command) => {
-          return `  ${padRight(command.rawName, longestCommandName.length)}  ${command.description}`;
+          const firstLine = command.description.split("\n")[0].trim();
+          return `  ${padRight(command.rawName, longestCommandName.length)}  ${firstLine}`;
         }).join("\n")
       });
       sections.push({

package/dist/index.mjs

@@ -1,127 +1,140 @@
-import { EventEmitter } from 'events';
-
-function toArr(any) {
-	return any == null ? [] : Array.isArray(any) ? any : [any];
-}
-
-function toVal(out, key, val, opts) {
-	var x, old=out[key], nxt=(
-		!!~opts.string.indexOf(key) ? (val == null || val === true ? '' : String(val))
-		: typeof val === 'boolean' ? val
-		: !!~opts.boolean.indexOf(key) ? (val === 'false' ? false : val === 'true' || (out._.push((x = +val,x * 0 === 0) ? x : val),!!val))
-		: (x = +val,x * 0 === 0) ? x : val
-	);
-	out[key] = old == null ? nxt : (Array.isArray(old) ? old.concat(nxt) : [old, nxt]);
-}
-
-function mri (args, opts) {
-	args = args || [];
-	opts = opts || {};
-
-	var k, arr, arg, name, val, out={ _:[] };
-	var i=0, j=0, idx=0, len=args.length;
-
-	const alibi = opts.alias !== void 0;
-	const strict = opts.unknown !== void 0;
-	const defaults = opts.default !== void 0;
-
-	opts.alias = opts.alias || {};
-	opts.string = toArr(opts.string);
-	opts.boolean = toArr(opts.boolean);
-
-	if (alibi) {
-		for (k in opts.alias) {
-			arr = opts.alias[k] = toArr(opts.alias[k]);
-			for (i=0; i < arr.length; i++) {
-				(opts.alias[arr[i]] = arr.concat(k)).splice(i, 1);
-			}
-		}
-	}
-
-	for (i=opts.boolean.length; i-- > 0;) {
-		arr = opts.alias[opts.boolean[i]] || [];
-		for (j=arr.length; j-- > 0;) opts.boolean.push(arr[j]);
-	}
-
-	for (i=opts.string.length; i-- > 0;) {
-		arr = opts.alias[opts.string[i]] || [];
-		for (j=arr.length; j-- > 0;) opts.string.push(arr[j]);
-	}
-
-	if (defaults) {
-		for (k in opts.default) {
-			name = typeof opts.default[k];
-			arr = opts.alias[k] = opts.alias[k] || [];
-			if (opts[name] !== void 0) {
-				opts[name].push(k);
-				for (i=0; i < arr.length; i++) {
-					opts[name].push(arr[i]);
-				}
-			}
-		}
-	}
-
-	const keys = strict ? Object.keys(opts.alias) : [];
-
-	for (i=0; i < len; i++) {
-		arg = args[i];
-
-		if (arg === '--') {
-			out._ = out._.concat(args.slice(++i));
-			break;
-		}
-
-		for (j=0; j < arg.length; j++) {
-			if (arg.charCodeAt(j) !== 45) break; // "-"
-		}
-
-		if (j === 0) {
-			out._.push(arg);
-		} else if (arg.substring(j, j + 3) === 'no-') {
-			name = arg.substring(j + 3);
-			if (strict && !~keys.indexOf(name)) {
-				return opts.unknown(arg);
-			}
-			out[name] = false;
-		} else {
-			for (idx=j+1; idx < arg.length; idx++) {
-				if (arg.charCodeAt(idx) === 61) break; // "="
-			}
-
-			name = arg.substring(j, idx);
-			val = arg.substring(++idx) || (i+1 === len || (''+args[i+1]).charCodeAt(0) === 45 || args[++i]);
-			arr = (j === 2 ? [name] : name);
-
-			for (idx=0; idx < arr.length; idx++) {
-				name = arr[idx];
-				if (strict && !~keys.indexOf(name)) return opts.unknown('-'.repeat(j) + name);
-				toVal(out, name, (idx + 1 < arr.length) || val, opts);
-			}
-		}
-	}
-
-	if (defaults) {
-		for (k in opts.default) {
-			if (out[k] === void 0) {
-				out[k] = opts.default[k];
-			}
-		}
-	}
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __markAsModule = (target) => __defProp(target, "__esModule", {value: true});
+var __commonJS = (callback, module) => () => {
+  if (!module) {
+    module = {exports: {}};
+    callback(module.exports, module);
+  }
+  return module.exports;
+};
+var __exportStar = (target, module, desc) => {
+  if (module && typeof module === "object" || typeof module === "function") {
+    for (let key of __getOwnPropNames(module))
+      if (!__hasOwnProp.call(target, key) && key !== "default")
+        __defProp(target, key, {get: () => module[key], enumerable: !(desc = __getOwnPropDesc(module, key)) || desc.enumerable});
+  }
+  return target;
+};
+var __toModule = (module) => {
+  return __exportStar(__markAsModule(__defProp(module != null ? __create(__getProtoOf(module)) : {}, "default", module && module.__esModule && "default" in module ? {get: () => module.default, enumerable: true} : {value: module, enumerable: true})), module);
+};
 
-	if (alibi) {
-		for (k in out) {
-			arr = opts.alias[k] || [];
-			while (arr.length > 0) {
-				out[arr.shift()] = out[k];
-			}
-		}
-	}
+// node_modules/mri/lib/index.js
+var require_lib = __commonJS((exports, module) => {
+  function toArr(any) {
+    return any == null ? [] : Array.isArray(any) ? any : [any];
+  }
+  function toVal(out, key, val, opts) {
+    var x, old = out[key], nxt = !!~opts.string.indexOf(key) ? val == null || val === true ? "" : String(val) : typeof val === "boolean" ? val : !!~opts.boolean.indexOf(key) ? val === "false" ? false : val === "true" || (out._.push((x = +val, x * 0 === 0) ? x : val), !!val) : (x = +val, x * 0 === 0) ? x : val;
+    out[key] = old == null ? nxt : Array.isArray(old) ? old.concat(nxt) : [old, nxt];
+  }
+  module.exports = function(args, opts) {
+    args = args || [];
+    opts = opts || {};
+    var k, arr, arg, name, val, out = {_: []};
+    var i = 0, j = 0, idx = 0, len = args.length;
+    const alibi = opts.alias !== void 0;
+    const strict = opts.unknown !== void 0;
+    const defaults = opts.default !== void 0;
+    opts.alias = opts.alias || {};
+    opts.string = toArr(opts.string);
+    opts.boolean = toArr(opts.boolean);
+    if (alibi) {
+      for (k in opts.alias) {
+        arr = opts.alias[k] = toArr(opts.alias[k]);
+        for (i = 0; i < arr.length; i++) {
+          (opts.alias[arr[i]] = arr.concat(k)).splice(i, 1);
+        }
+      }
+    }
+    for (i = opts.boolean.length; i-- > 0; ) {
+      arr = opts.alias[opts.boolean[i]] || [];
+      for (j = arr.length; j-- > 0; )
+        opts.boolean.push(arr[j]);
+    }
+    for (i = opts.string.length; i-- > 0; ) {
+      arr = opts.alias[opts.string[i]] || [];
+      for (j = arr.length; j-- > 0; )
+        opts.string.push(arr[j]);
+    }
+    if (defaults) {
+      for (k in opts.default) {
+        name = typeof opts.default[k];
+        arr = opts.alias[k] = opts.alias[k] || [];
+        if (opts[name] !== void 0) {
+          opts[name].push(k);
+          for (i = 0; i < arr.length; i++) {
+            opts[name].push(arr[i]);
+          }
+        }
+      }
+    }
+    const keys = strict ? Object.keys(opts.alias) : [];
+    for (i = 0; i < len; i++) {
+      arg = args[i];
+      if (arg === "--") {
+        out._ = out._.concat(args.slice(++i));
+        break;
+      }
+      for (j = 0; j < arg.length; j++) {
+        if (arg.charCodeAt(j) !== 45)
+          break;
+      }
+      if (j === 0) {
+        out._.push(arg);
+      } else if (arg.substring(j, j + 3) === "no-") {
+        name = arg.substring(j + 3);
+        if (strict && !~keys.indexOf(name)) {
+          return opts.unknown(arg);
+        }
+        out[name] = false;
+      } else {
+        for (idx = j + 1; idx < arg.length; idx++) {
+          if (arg.charCodeAt(idx) === 61)
+            break;
+        }
+        name = arg.substring(j, idx);
+        val = arg.substring(++idx) || (i + 1 === len || ("" + args[i + 1]).charCodeAt(0) === 45 || args[++i]);
+        arr = j === 2 ? [name] : name;
+        for (idx = 0; idx < arr.length; idx++) {
+          name = arr[idx];
+          if (strict && !~keys.indexOf(name))
+            return opts.unknown("-".repeat(j) + name);
+          toVal(out, name, idx + 1 < arr.length || val, opts);
+        }
+      }
+    }
+    if (defaults) {
+      for (k in opts.default) {
+        if (out[k] === void 0) {
+          out[k] = opts.default[k];
+        }
+      }
+    }
+    if (alibi) {
+      for (k in out) {
+        arr = opts.alias[k] || [];
+        while (arr.length > 0) {
+          out[arr.shift()] = out[k];
+        }
+      }
+    }
+    return out;
+  };
+});
 
-	return out;
-}
+// src/CAC.ts
+var import_mri = __toModule(require_lib());
+import {EventEmitter} from "events";
 
-const removeBrackets = (v) => v.replace(/[<[].+/, "").trim();
-const findAllBrackets = (v) => {
+// src/utils.ts
+var removeBrackets = (v) => v.replace(/[<[].+/, "").trim();
+var findAllBrackets = (v) => {
   const ANGLED_BRACKET_RE_GLOBAL = /<([^>]+)>/g;
   const SQUARE_BRACKET_RE_GLOBAL = /\[([^\]]+)\]/g;
   const res = [];
@@ -148,7 +161,7 @@ const findAllBrackets = (v) => {
   }
   return res;
 };
-const getMriOptions = (options) => {
+var getMriOptions = (options) => {
   const result = {alias: {}, boolean: []};
   for (const [index, option] of options.entries()) {
     if (option.names.length > 1) {
@@ -169,20 +182,20 @@ const getMriOptions = (options) => {
   }
   return result;
 };
-const findLongest = (arr) => {
+var findLongest = (arr) => {
   return arr.sort((a, b) => {
     return a.length > b.length ? -1 : 1;
   })[0];
 };
-const padRight = (str, length) => {
+var padRight = (str, length) => {
   return str.length >= length ? str : `${str}${" ".repeat(length - str.length)}`;
 };
-const camelcase = (input) => {
+var camelcase = (input) => {
   return input.replace(/([a-z])-([a-z])/g, (_, p1, p2) => {
     return p1 + p2.toUpperCase();
   });
 };
-const setDotProp = (obj, keys, val) => {
+var setDotProp = (obj, keys, val) => {
   let i = 0;
   let length = keys.length;
   let t = obj;
@@ -192,7 +205,7 @@ const setDotProp = (obj, keys, val) => {
     t = t[keys[i]] = i === length - 1 ? val : x != null ? x : !!~keys[i + 1].indexOf(".") || !(+keys[i + 1] > -1) ? {} : [];
   }
 };
-const setByType = (obj, transforms) => {
+var setByType = (obj, transforms) => {
   for (const key of Object.keys(transforms)) {
     const transform = transforms[key];
     if (transform.shouldTransform) {
@@ -203,16 +216,16 @@ const setByType = (obj, transforms) => {
     }
   }
 };
-const getFileName = (input) => {
+var getFileName = (input) => {
   const m = /([^\\\/]+)$/.exec(input);
   return m ? m[1] : "";
 };
-const camelcaseOptionName = (name) => {
+var camelcaseOptionName = (name) => {
   return name.split(".").map((v, i) => {
     return i === 0 ? camelcase(v) : v;
   }).join(".");
 };
-class CACError extends Error {
+var CACError = class extends Error {
   constructor(message) {
     super(message);
     this.name = this.constructor.name;
@@ -222,9 +235,10 @@ class CACError extends Error {
       this.stack = new Error(message).stack;
     }
   }
-}
+};
 
-class Option {
+// src/Option.ts
+var Option = class {
   constructor(rawName, description, config) {
     this.rawName = rawName;
     this.description = description;
@@ -251,12 +265,15 @@ class Option {
       this.isBoolean = true;
     }
   }
-}
+};
+var Option_default = Option;
 
-const processArgs = process.argv;
-const platformInfo = `${process.platform}-${process.arch} node-${process.version}`;
+// src/node.ts
+var processArgs = process.argv;
+var platformInfo = `${process.platform}-${process.arch} node-${process.version}`;
 
-class Command {
+// src/Command.ts
+var Command = class {
   constructor(rawName, description, config = {}, cli) {
     this.rawName = rawName;
     this.description = description;
@@ -290,7 +307,7 @@ class Command {
     return this;
   }
   option(rawName, description, config) {
-    const option = new Option(rawName, description, config);
+    const option = new Option_default(rawName, description, config);
     this.options.push(option);
     return this;
   }
@@ -348,13 +365,20 @@ class Command {
       title: "Usage",
       body: `  $ ${name} ${this.usageText || this.rawName}`
     });
+    if (!this.isGlobalCommand && !this.isDefaultCommand && this.description) {
+      sections.push({
+        title: "Description",
+        body: this.description.split("\n").map((line) => `  ${line}`).join("\n")
+      });
+    }
     const showCommands = (this.isGlobalCommand || this.isDefaultCommand) && commands.length > 0;
     if (showCommands) {
       const longestCommandName = findLongest(commands.map((command) => command.rawName));
       sections.push({
         title: "Commands",
         body: commands.map((command) => {
-          return `  ${padRight(command.rawName, longestCommandName.length)}  ${command.description}`;
+          const firstLine = command.description.split("\n")[0].trim();
+          return `  ${padRight(command.rawName, longestCommandName.length)}  ${firstLine}`;
         }).join("\n")
       });
       sections.push({
@@ -430,15 +454,16 @@ ${section.body}` : section.body;
       }
     }
   }
-}
-class GlobalCommand extends Command {
+};
+var GlobalCommand = class extends Command {
   constructor(cli) {
     super("@@global@@", "", {}, cli);
   }
-}
+};
+var Command_default = Command;
 
-var __assign = Object.assign;
-class CAC extends EventEmitter {
+// src/CAC.ts
+var CAC = class extends EventEmitter {
   constructor(name = "") {
     super();
     this.name = name;
@@ -454,7 +479,7 @@ class CAC extends EventEmitter {
     return this;
   }
   command(rawName, description, config) {
-    const command = new Command(rawName, description || "", config, this);
+    const command = new Command_default(rawName, description || "", config, this);
     command.globalCommand = this.globalCommand;
     this.commands.push(command);
     return command;
@@ -522,9 +547,10 @@ class CAC extends EventEmitter {
       if (result.matched) {
         shouldParse = false;
         const matchedCommandName = parsed.args.slice(0, result.consumedArgs).join(" ");
-        const parsedInfo = __assign(__assign({}, parsed), {
+        const parsedInfo = {
+          ...parsed,
           args: parsed.args.slice(result.consumedArgs)
-        });
+        };
         this.setParsedInfo(parsedInfo, command, matchedCommandName);
         this.emit(`command:${matchedCommandName}`, command);
         break;
@@ -575,11 +601,12 @@ class CAC extends EventEmitter {
       argsAfterDoubleDashes = argv.slice(doubleDashesIndex + 1);
       argv = argv.slice(0, doubleDashesIndex);
     }
-    let parsed = mri(argv, mriOptions);
+    let parsed = (0, import_mri.default)(argv, mriOptions);
     parsed = Object.keys(parsed).reduce((res, name) => {
-      return __assign(__assign({}, res), {
+      return {
+        ...res,
         [camelcaseOptionName(name)]: parsed[name]
-      });
+      };
     }, {_: []});
     const args = parsed._;
     const options = {
@@ -631,8 +658,15 @@ class CAC extends EventEmitter {
     actionArgs.push(options);
     return command.commandAction.apply(this, actionArgs);
   }
-}
-
-const cac = (name = "") => new CAC(name);
+};
+var CAC_default = CAC;
 
-export { CAC, Command, cac, cac as default };
+// src/index.ts
+var cac = (name = "") => new CAC_default(name);
+var src_default = cac;
+export {
+  CAC_default as CAC,
+  Command_default as Command,
+  cac,
+  src_default as default
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xmorse/cac",
-  "version": "6.0.0",
+  "version": "6.0.2",
   "description": "Simple yet powerful framework for building command-line apps.",
   "repository": {
     "url": "egoist/cac",
@@ -26,6 +26,16 @@
     "/deno",
     "/index-compat.js"
   ],
+  "scripts": {
+    "test": "jest",
+    "test:cov": "jest --coverage",
+    "build:deno": "node -r sucrase/register scripts/build-deno.ts",
+    "build:node": "rollup -c",
+    "build": "npm run build:deno && npm run build:node",
+    "toc": "markdown-toc -i README.md",
+    "prepublishOnly": "npm run build && cp mod.js mod.mjs",
+    "docs:api": "typedoc --out api-doc --readme none --exclude \"**/__test__/**\" --theme minimal"
+  },
   "author": "egoist <0x142857@gmail.com>",
   "license": "MIT",
   "devDependencies": {
@@ -90,14 +100,5 @@
     "hooks": {
       "pre-commit": "npm t && lint-staged"
     }
-  },
-  "scripts": {
-    "test": "jest",
-    "test:cov": "jest --coverage",
-    "build:deno": "node -r sucrase/register scripts/build-deno.ts",
-    "build:node": "rollup -c",
-    "build": "yarn build:deno && yarn build:node",
-    "toc": "markdown-toc -i README.md",
-    "docs:api": "typedoc --out api-doc --readme none --exclude \"**/__test__/**\" --theme minimal"
   }
-}
+}