mocha 11.0.1 → 11.1.0

package/lib/cli/cli.js

@@ -12,7 +12,7 @@
 
 const debug = require('debug')('mocha:cli:cli');
 const symbols = require('log-symbols');
-const yargs = require('yargs/yargs');
+const yargs = require('yargs');
 const path = require('path');
 const {
   loadRc,
@@ -42,7 +42,11 @@ exports.main = (argv = process.argv.slice(2), mochaArgs) => {
     module.paths.push(cwd(), path.resolve('node_modules'));
   }
 
-  Error.stackTraceLimit = Infinity; // configurable via --stack-trace-limit?
+  try {
+    Error.stackTraceLimit = Infinity; // configurable via --stack-trace-limit?
+  } catch (err) {
+    debug('unable to set Error.stackTraceLimit = Infinity', err);
+  }
 
   var args = mochaArgs || loadOptions(argv);
 
@@ -59,7 +63,7 @@ exports.main = (argv = process.argv.slice(2), mochaArgs) => {
       debug('caught error sometime before command handler: %O', err);
       yargs.showHelp();
       console.error(`\n${symbols.error} ${ansi.red('ERROR:')} ${msg}`);
-      process.exitCode = 1;
+      process.exit(1);
     })
     .help('help', 'Show usage information & exit')
     .alias('help', 'h')
@@ -67,7 +71,7 @@ exports.main = (argv = process.argv.slice(2), mochaArgs) => {
     .alias('version', 'V')
     .wrap(process.stdout.columns ? Math.min(process.stdout.columns, 80) : 80)
     .epilog(
-      `Mocha Resources
+      `${ansi.reset("Mocha Resources")}
     Chat: ${ansi.magenta(discord)}
   GitHub: ${ansi.blue(repository.url)}
     Docs: ${ansi.yellow(homepage)}

package/lib/cli/options.js

@@ -10,7 +10,12 @@
 const fs = require('fs');
 const ansi = require('ansi-colors');
 const yargsParser = require('yargs-parser');
-const {types, aliases} = require('./run-option-metadata');
+const {
+  types,
+  aliases,
+  isMochaFlag,
+  expectedTypeForFlag
+} = require('./run-option-metadata');
 const {ONE_AND_DONE_ARGS} = require('./one-and-dones');
 const mocharc = require('../mocharc.json');
 const {list} = require('./run-helpers');
@@ -18,7 +23,12 @@ const {loadConfig, findConfig} = require('./config');
 const findUp = require('find-up');
 const debug = require('debug')('mocha:cli:options');
 const {isNodeFlag} = require('./node-flags');
-const {createUnparsableFileError} = require('../errors');
+const {
+  createUnparsableFileError,
+  createInvalidArgumentTypeError,
+  createUnsupportedError
+} = require('../errors');
+const {isNumeric} = require('../utils');
 
 /**
  * The `yargs-parser` namespace
@@ -93,6 +103,44 @@ const nargOpts = types.array
   .concat(types.string, types.number)
   .reduce((acc, arg) => Object.assign(acc, {[arg]: 1}), {});
 
+/**
+ * Throws either "UNSUPPORTED" error or "INVALID_ARG_TYPE" error for numeric positional arguments.
+ * @param {string[]} allArgs - Stringified args passed to mocha cli
+ * @param {number} numericArg - Numeric positional arg for which error must be thrown
+ * @param {Object} parsedResult - Result from `yargs-parser`
+ * @private
+ * @ignore
+ */
+const createErrorForNumericPositionalArg = (
+  numericArg,
+  allArgs,
+  parsedResult
+) => {
+  // A flag for `numericArg` exists if:
+  // 1. A mocha flag immediately preceeded the numericArg in `allArgs` array and
+  // 2. `numericArg` value could not be assigned to this flag by `yargs-parser` because of incompatible datatype.
+  const flag = allArgs.find((arg, index) => {
+    const normalizedArg = arg.replace(/^--?/, '');
+    return (
+      isMochaFlag(arg) &&
+      allArgs[index + 1] === String(numericArg) &&
+      parsedResult[normalizedArg] !== String(numericArg)
+    );
+  });
+
+  if (flag) {
+    throw createInvalidArgumentTypeError(
+      `Mocha flag '${flag}' given invalid option: '${numericArg}'`,
+      numericArg,
+      expectedTypeForFlag(flag)
+    );
+  } else {
+    throw createUnsupportedError(
+      `Option ${numericArg} is unsupported by the mocha cli`
+    );
+  }
+};
+
 /**
  * Wrapper around `yargs-parser` which applies our settings
  * @param {string|string[]} args - Arguments to parse
@@ -104,24 +152,20 @@ const nargOpts = types.array
 const parse = (args = [], defaultValues = {}, ...configObjects) => {
   // save node-specific args for special handling.
   // 1. when these args have a "=" they should be considered to have values
-  // 2. if they don't, they just boolean flags
+  // 2. if they don't, they are just boolean flags
   // 3. to avoid explicitly defining the set of them, we tell yargs-parser they
   //    are ALL boolean flags.
   // 4. we can then reapply the values after yargs-parser is done.
-  const nodeArgs = (Array.isArray(args) ? args : args.split(' ')).reduce(
-    (acc, arg) => {
-      const pair = arg.split('=');
-      let flag = pair[0];
-      if (isNodeFlag(flag, false)) {
-        flag = flag.replace(/^--?/, '');
-        return arg.includes('=')
-          ? acc.concat([[flag, pair[1]]])
-          : acc.concat([[flag, true]]);
-      }
-      return acc;
-    },
-    []
-  );
+  const allArgs = Array.isArray(args) ? args : args.split(' ');
+  const nodeArgs = allArgs.reduce((acc, arg) => {
+    const pair = arg.split('=');
+    let flag = pair[0];
+    if (isNodeFlag(flag, false)) {
+      flag = flag.replace(/^--?/, '');
+      return acc.concat([[flag, arg.includes('=') ? pair[1] : true]]);
+    }
+    return acc;
+  }, []);
 
   const result = yargsParser.detailed(args, {
     configuration,
@@ -140,6 +184,15 @@ const parse = (args = [], defaultValues = {}, ...configObjects) => {
     process.exit(1);
   }
 
+  const numericPositionalArg = result.argv._.find(arg => isNumeric(arg));
+  if (numericPositionalArg) {
+    createErrorForNumericPositionalArg(
+      numericPositionalArg,
+      allArgs,
+      result.argv
+    );
+  }
+
   // reapply "=" arg values from above
   nodeArgs.forEach(([key, value]) => {
     result.argv[key] = value;

package/lib/cli/run-option-metadata.js

@@ -114,3 +114,24 @@ const ALL_MOCHA_FLAGS = Object.keys(TYPES).reduce((acc, key) => {
 exports.isMochaFlag = flag => {
   return ALL_MOCHA_FLAGS.has(flag.replace(/^--?/, ''));
 };
+
+/**
+ * Returns expected yarg option type for a given mocha flag.
+ * @param {string} flag - Flag to check (can be with or without leading dashes "--"")
+ * @returns {string | undefined} - If flag is a valid mocha flag, the expected type of argument for this flag is returned, otherwise undefined is returned.
+ * @private
+ */
+exports.expectedTypeForFlag = flag => {
+  const normalizedName = flag.replace(/^--?/, '');
+
+  // If flag is an alias, get it's full name.
+  const aliases = exports.aliases;
+  const fullFlagName =
+    Object.keys(aliases).find(flagName =>
+      aliases[flagName].includes(normalizedName)
+    ) || normalizedName;
+
+  return Object.keys(TYPES).find(flagType =>
+    TYPES[flagType].includes(fullFlagName)
+  );
+};

package/lib/cli/run.js

@@ -169,11 +169,11 @@ exports.builder = yargs =>
         group: GROUPS.RULES
       },
       'list-interfaces': {
-        conflicts: Array.from(ONE_AND_DONE_ARGS),
+        conflicts: Array.from(ONE_AND_DONE_ARGS).filter(arg => arg !== "list-interfaces"),
         description: 'List built-in user interfaces & exit'
       },
       'list-reporters': {
-        conflicts: Array.from(ONE_AND_DONE_ARGS),
+        conflicts: Array.from(ONE_AND_DONE_ARGS).filter(arg => arg !== "list-reporters"),
         description: 'List built-in reporters & exit'
       },
       'no-colors': {

package/lib/mocha.js

@@ -194,7 +194,9 @@ function Mocha(options = {}) {
     .ui(options.ui)
     .reporter(
       options.reporter,
-      options.reporterOption || options.reporterOptions // for backwards compatibility
+      options['reporter-option'] ||
+        options.reporterOption ||
+        options.reporterOptions // for backwards compatibility
     )
     .slow(options.slow)
     .global(options.global);

package/lib/utils.js

@@ -689,3 +689,10 @@ exports.breakCircularDeps = inputObj => {
 
   return _breakCircularDeps(inputObj);
 };
+
+/**
+ * Checks if provided input can be parsed as a JavaScript Number.
+ */
+exports.isNumeric = input => {
+  return !isNaN(parseFloat(input));
+};

package/mocha.js

@@ -1,4 +1,4 @@
-// mocha@11.0.1 in javascript ES2018
+// mocha@11.1.0 in javascript ES2018
 (function (global, factory) {
   typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
   typeof define === 'function' && define.amd ? define(factory) :
@@ -11652,6 +11652,13 @@
 
     return _breakCircularDeps(inputObj);
   };
+
+  /**
+   * Checks if provided input can be parsed as a JavaScript Number.
+   */
+  exports.isNumeric = input => {
+    return !isNaN(parseFloat(input));
+  };
   }(utils$3));
 
   var _nodeResolve_empty = {};
@@ -19201,7 +19208,7 @@
   };
 
   var name = "mocha";
-  var version = "11.0.1";
+  var version = "11.1.0";
   var homepage = "https://mochajs.org/";
   var notifyLogo = "https://ibin.co/4QuRuGjXvl36.png";
   var require$$17 = {
@@ -19407,7 +19414,9 @@
       .ui(options.ui)
       .reporter(
         options.reporter,
-        options.reporterOption || options.reporterOptions // for backwards compatibility
+        options['reporter-option'] ||
+          options.reporterOption ||
+          options.reporterOptions // for backwards compatibility
       )
       .slow(options.slow)
       .global(options.global);