yargs 16.1.1 → 16.2.2-candidate.0

package/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [16.2.0](https://www.github.com/yargs/yargs/compare/v16.1.1...v16.2.0) (2020-12-05)
+
+
+### Features
+
+* command() now accepts an array of modules ([f415388](https://www.github.com/yargs/yargs/commit/f415388cc454d02786c65c50dd6c7a0cf9d8b842))
+
+
+### Bug Fixes
+
+* add package.json to module exports ([#1818](https://www.github.com/yargs/yargs/issues/1818)) ([d783a49](https://www.github.com/yargs/yargs/commit/d783a49a7f21c9bbd4eec2990268f3244c4d5662)), closes [#1817](https://www.github.com/yargs/yargs/issues/1817)
+
 ### [16.1.1](https://www.github.com/yargs/yargs/compare/v16.1.0...v16.1.1) (2020-11-15)
 
 
@@ -74,4 +86,3 @@ All notable changes to this project will be documented in this file. See [standa
 * **yargs:** add missing command(module) signature ([#1707](https://www.github.com/yargs/yargs/issues/1707)) ([0f81024](https://www.github.com/yargs/yargs/commit/0f810245494ccf13a35b7786d021b30fc95ecad5)), closes [#1704](https://www.github.com/yargs/yargs/issues/1704)
 
 [Older CHANGELOG Entries](https://github.com/yargs/yargs/blob/master/docs/CHANGELOG-historical.md)
- 

package/build/index.cjs

@@ -287,8 +287,14 @@ function command(yargs, usage, validation, globalMiddleware = [], shim) {
         const middlewares = commandMiddlewareFactory(commandMiddleware);
         handler = handler || (() => { });
         if (Array.isArray(cmd)) {
-            aliases = cmd.slice(1);
-            cmd = cmd[0];
+            if (isCommandAndAliases(cmd)) {
+                [cmd, ...aliases] = cmd;
+            }
+            else {
+                for (const command of cmd) {
+                    self.addHandler(command);
+                }
+            }
         }
         else if (isCommandHandlerDefinition(cmd)) {
             let command = Array.isArray(cmd.command) || typeof cmd.command === 'string'
@@ -299,45 +305,47 @@ function command(yargs, usage, validation, globalMiddleware = [], shim) {
             self.addHandler(command, extractDesc(cmd), cmd.builder, cmd.handler, cmd.middlewares, cmd.deprecated);
             return;
         }
-        if (isCommandBuilderDefinition(builder)) {
+        else if (isCommandBuilderDefinition(builder)) {
             self.addHandler([cmd].concat(aliases), description, builder.builder, builder.handler, builder.middlewares, builder.deprecated);
             return;
         }
-        const parsedCommand = parseCommand(cmd);
-        aliases = aliases.map(alias => parseCommand(alias).cmd);
-        let isDefault = false;
-        const parsedAliases = [parsedCommand.cmd].concat(aliases).filter(c => {
-            if (DEFAULT_MARKER.test(c)) {
-                isDefault = true;
-                return false;
-            }
-            return true;
-        });
-        if (parsedAliases.length === 0 && isDefault)
-            parsedAliases.push('$0');
-        if (isDefault) {
-            parsedCommand.cmd = parsedAliases[0];
-            aliases = parsedAliases.slice(1);
-            cmd = cmd.replace(DEFAULT_MARKER, parsedCommand.cmd);
+        if (typeof cmd === 'string') {
+            const parsedCommand = parseCommand(cmd);
+            aliases = aliases.map(alias => parseCommand(alias).cmd);
+            let isDefault = false;
+            const parsedAliases = [parsedCommand.cmd].concat(aliases).filter(c => {
+                if (DEFAULT_MARKER.test(c)) {
+                    isDefault = true;
+                    return false;
+                }
+                return true;
+            });
+            if (parsedAliases.length === 0 && isDefault)
+                parsedAliases.push('$0');
+            if (isDefault) {
+                parsedCommand.cmd = parsedAliases[0];
+                aliases = parsedAliases.slice(1);
+                cmd = cmd.replace(DEFAULT_MARKER, parsedCommand.cmd);
+            }
+            aliases.forEach(alias => {
+                aliasMap[alias] = parsedCommand.cmd;
+            });
+            if (description !== false) {
+                usage.command(cmd, description, isDefault, aliases, deprecated);
+            }
+            handlers[parsedCommand.cmd] = {
+                original: cmd,
+                description,
+                handler,
+                builder: builder || {},
+                middlewares,
+                deprecated,
+                demanded: parsedCommand.demanded,
+                optional: parsedCommand.optional,
+            };
+            if (isDefault)
+                defaultCommand = handlers[parsedCommand.cmd];
         }
-        aliases.forEach(alias => {
-            aliasMap[alias] = parsedCommand.cmd;
-        });
-        if (description !== false) {
-            usage.command(cmd, description, isDefault, aliases, deprecated);
-        }
-        handlers[parsedCommand.cmd] = {
-            original: cmd,
-            description,
-            handler,
-            builder: builder || {},
-            middlewares,
-            deprecated,
-            demanded: parsedCommand.demanded,
-            optional: parsedCommand.optional,
-        };
-        if (isDefault)
-            defaultCommand = handlers[parsedCommand.cmd];
     };
     self.addDirectory = function addDirectory(dir, context, req, callerFile, opts) {
         opts = opts || {};
@@ -498,7 +506,7 @@ function command(yargs, usage, validation, globalMiddleware = [], shim) {
         if (isCommandBuilderCallback(builder)) {
             builder(yargs);
         }
-        else {
+        else if (!isCommandBuilderDefinition(builder)) {
             Object.keys(builder).forEach(key => {
                 yargs.option(key, builder[key]);
             });
@@ -622,20 +630,28 @@ function command(yargs, usage, validation, globalMiddleware = [], shim) {
     };
     return self;
 }
-function isCommandHandlerDefinition(cmd) {
-    return typeof cmd === 'object';
-}
 function isCommandBuilderDefinition(builder) {
     return (typeof builder === 'object' &&
         !!builder.builder &&
         typeof builder.handler === 'function');
 }
+function isCommandAndAliases(cmd) {
+    if (cmd.every(c => typeof c === 'string')) {
+        return true;
+    }
+    else {
+        return false;
+    }
+}
 function isCommandBuilderCallback(builder) {
     return typeof builder === 'function';
 }
 function isCommandBuilderOptionDefinitions(builder) {
     return typeof builder === 'object';
 }
+function isCommandHandlerDefinition(cmd) {
+    return typeof cmd === 'object' && !Array.isArray(cmd);
+}
 
 function setBlocking(blocking) {
     if (typeof process === 'undefined')

package/build/lib/command.js

@@ -15,8 +15,14 @@ export function command(yargs, usage, validation, globalMiddleware = [], shim) {
         const middlewares = commandMiddlewareFactory(commandMiddleware);
         handler = handler || (() => { });
         if (Array.isArray(cmd)) {
-            aliases = cmd.slice(1);
-            cmd = cmd[0];
+            if (isCommandAndAliases(cmd)) {
+                [cmd, ...aliases] = cmd;
+            }
+            else {
+                for (const command of cmd) {
+                    self.addHandler(command);
+                }
+            }
         }
         else if (isCommandHandlerDefinition(cmd)) {
             let command = Array.isArray(cmd.command) || typeof cmd.command === 'string'
@@ -27,45 +33,47 @@ export function command(yargs, usage, validation, globalMiddleware = [], shim) {
             self.addHandler(command, extractDesc(cmd), cmd.builder, cmd.handler, cmd.middlewares, cmd.deprecated);
             return;
         }
-        if (isCommandBuilderDefinition(builder)) {
+        else if (isCommandBuilderDefinition(builder)) {
             self.addHandler([cmd].concat(aliases), description, builder.builder, builder.handler, builder.middlewares, builder.deprecated);
             return;
         }
-        const parsedCommand = parseCommand(cmd);
-        aliases = aliases.map(alias => parseCommand(alias).cmd);
-        let isDefault = false;
-        const parsedAliases = [parsedCommand.cmd].concat(aliases).filter(c => {
-            if (DEFAULT_MARKER.test(c)) {
-                isDefault = true;
-                return false;
+        if (typeof cmd === 'string') {
+            const parsedCommand = parseCommand(cmd);
+            aliases = aliases.map(alias => parseCommand(alias).cmd);
+            let isDefault = false;
+            const parsedAliases = [parsedCommand.cmd].concat(aliases).filter(c => {
+                if (DEFAULT_MARKER.test(c)) {
+                    isDefault = true;
+                    return false;
+                }
+                return true;
+            });
+            if (parsedAliases.length === 0 && isDefault)
+                parsedAliases.push('$0');
+            if (isDefault) {
+                parsedCommand.cmd = parsedAliases[0];
+                aliases = parsedAliases.slice(1);
+                cmd = cmd.replace(DEFAULT_MARKER, parsedCommand.cmd);
             }
-            return true;
-        });
-        if (parsedAliases.length === 0 && isDefault)
-            parsedAliases.push('$0');
-        if (isDefault) {
-            parsedCommand.cmd = parsedAliases[0];
-            aliases = parsedAliases.slice(1);
-            cmd = cmd.replace(DEFAULT_MARKER, parsedCommand.cmd);
-        }
-        aliases.forEach(alias => {
-            aliasMap[alias] = parsedCommand.cmd;
-        });
-        if (description !== false) {
-            usage.command(cmd, description, isDefault, aliases, deprecated);
+            aliases.forEach(alias => {
+                aliasMap[alias] = parsedCommand.cmd;
+            });
+            if (description !== false) {
+                usage.command(cmd, description, isDefault, aliases, deprecated);
+            }
+            handlers[parsedCommand.cmd] = {
+                original: cmd,
+                description,
+                handler,
+                builder: builder || {},
+                middlewares,
+                deprecated,
+                demanded: parsedCommand.demanded,
+                optional: parsedCommand.optional,
+            };
+            if (isDefault)
+                defaultCommand = handlers[parsedCommand.cmd];
         }
-        handlers[parsedCommand.cmd] = {
-            original: cmd,
-            description,
-            handler,
-            builder: builder || {},
-            middlewares,
-            deprecated,
-            demanded: parsedCommand.demanded,
-            optional: parsedCommand.optional,
-        };
-        if (isDefault)
-            defaultCommand = handlers[parsedCommand.cmd];
     };
     self.addDirectory = function addDirectory(dir, context, req, callerFile, opts) {
         opts = opts || {};
@@ -226,7 +234,7 @@ export function command(yargs, usage, validation, globalMiddleware = [], shim) {
         if (isCommandBuilderCallback(builder)) {
             builder(yargs);
         }
-        else {
+        else if (!isCommandBuilderDefinition(builder)) {
             Object.keys(builder).forEach(key => {
                 yargs.option(key, builder[key]);
             });
@@ -350,17 +358,25 @@ export function command(yargs, usage, validation, globalMiddleware = [], shim) {
     };
     return self;
 }
-export function isCommandHandlerDefinition(cmd) {
-    return typeof cmd === 'object';
-}
 export function isCommandBuilderDefinition(builder) {
     return (typeof builder === 'object' &&
         !!builder.builder &&
         typeof builder.handler === 'function');
 }
+function isCommandAndAliases(cmd) {
+    if (cmd.every(c => typeof c === 'string')) {
+        return true;
+    }
+    else {
+        return false;
+    }
+}
 export function isCommandBuilderCallback(builder) {
     return typeof builder === 'function';
 }
 function isCommandBuilderOptionDefinitions(builder) {
     return typeof builder === 'object';
 }
+export function isCommandHandlerDefinition(cmd) {
+    return typeof cmd === 'object' && !Array.isArray(cmd);
+}

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "yargs",
-  "version": "16.1.1",
+  "version": "16.2.2-candidate.0",
   "description": "yargs the modern, pirate-themed, successor to optimist.",
   "main": "./index.cjs",
   "exports": {
+    "./package.json": "./package.json",
     ".": [
       {
         "import": "./index.mjs",
@@ -17,9 +18,9 @@
     },
     "./yargs": [
       {
-        "require": "./yargs"
+        "require": "./yargs.cjs"
       },
-      "./yargs"
+      "./yargs.cjs"
     ]
   },
   "type": "module",
@@ -37,6 +38,7 @@
     "helpers/*",
     "index.mjs",
     "yargs",
+    "yargs.cjs",
     "build",
     "locales",
     "LICENSE",
@@ -53,34 +55,35 @@
     "yargs-parser": "^20.2.2"
   },
   "devDependencies": {
-    "@types/chai": "^4.2.11",
-    "@types/mocha": "^8.0.0",
-    "@types/node": "^14.11.2",
-    "@wessberg/rollup-plugin-ts": "^1.3.2",
-    "c8": "^7.0.0",
-    "chai": "^4.2.0",
-    "chalk": "^4.0.0",
-    "coveralls": "^3.0.9",
-    "cpr": "^3.0.1",
-    "cross-env": "^7.0.2",
-    "cross-spawn": "^7.0.0",
-    "gts": "^3.0.0",
+    "@types/babel__traverse": "7.0.16",
+    "@types/chai": "4.2.14",
+    "@types/mocha": "8.0.4",
+    "@types/node": "14.14.0",
+    "@wessberg/rollup-plugin-ts": "1.3.8",
+    "chai": "4.2.0",
+    "chalk": "4.1.0",
+    "coveralls": "3.1.0",
+    "cpr": "3.0.1",
+    "cross-env": "7.0.2",
+    "cross-spawn": "7.0.3",
+    "gts": "3.0.3",
     "hashish": "0.0.4",
-    "mocha": "^8.0.0",
-    "rimraf": "^3.0.2",
-    "rollup": "^2.23.0",
-    "rollup-plugin-cleanup": "^3.1.1",
+    "mocha": "8.2.1",
+    "rimraf": "3.0.2",
+    "prettier": "2.2.1",
+    "rollup": "2.34.1",
+    "rollup-plugin-cleanup": "3.2.1",
     "standardx": "^5.0.0",
-    "typescript": "^4.0.2",
-    "which": "^2.0.0",
-    "yargs-test-extends": "^1.0.1"
+    "typescript": "4.1.2",
+    "which": "2.0.2",
+    "yargs-test-extends": "1.0.1"
   },
   "scripts": {
     "fix": "gts fix && npm run fix:js",
     "fix:js": "standardx --fix '**/*.mjs' && standardx --fix '**/*.cjs' && standardx --fix './*.mjs' && standardx --fix './*.cjs'",
     "posttest": "npm run check",
-    "test": "c8 mocha ./test/*.cjs --require ./test/before.cjs --timeout=12000 --check-leaks",
-    "test:esm": "c8 mocha ./test/esm/*.mjs --check-leaks",
+    "test": "mocha ./test/*.cjs --require ./test/before.cjs --timeout=12000 --check-leaks",
+    "test:esm": "mocha ./test/esm/*.mjs --check-leaks",
     "coverage": "c8 report --check-coverage",
     "prepare": "npm run compile",
     "pretest": "npm run compile -- -p tsconfig.test.json && cross-env NODE_ENV=test npm run build:cjs",
@@ -88,8 +91,7 @@
     "postcompile": "npm run build:cjs",
     "build:cjs": "rollup -c rollup.config.cjs",
     "postbuild:cjs": "rimraf ./build/index.cjs.d.ts",
-    "check": "gts lint && npm run check:js",
-    "check:js": "standardx '**/*.mjs' && standardx '**/*.cjs' && standardx './*.mjs' && standardx './*.cjs'",
+    "check": "gts lint",
     "clean": "gts clean"
   },
   "repository": {

package/yargs

@@ -1,9 +1,5 @@
-// TODO: consolidate on using a helpers file at some point in the future, which
-// is the approach currently used to export Parser and applyExtends for ESM:
-const {applyExtends, cjsPlatformShim, Parser, Yargs, processArgv} = require('./build/index.cjs')
-Yargs.applyExtends = (config, cwd, mergeExtends) => {
-  return applyExtends(config, cwd, mergeExtends, cjsPlatformShim)
-}
-Yargs.hideBin = processArgv.hideBin
-Yargs.Parser = Parser
-module.exports = Yargs
+// This file gets hit in node versions below node 12.17.0
+// when require('yargs/yargs') from CommonJS
+// because conditional exports not fully supported and treats as filename.
+
+module.exports = require('./yargs.cjs');

package/yargs.cjs

@@ -0,0 +1,15 @@
+// TODO: consolidate on using a helpers file at some point in the future, which
+// is the approach currently used to export Parser and applyExtends for ESM:
+const {
+  applyExtends,
+  cjsPlatformShim,
+  Parser,
+  Yargs,
+  processArgv,
+} = require('./build/index.cjs');
+Yargs.applyExtends = (config, cwd, mergeExtends) => {
+  return applyExtends(config, cwd, mergeExtends, cjsPlatformShim);
+};
+Yargs.hideBin = processArgv.hideBin;
+Yargs.Parser = Parser;
+module.exports = Yargs;