mocha 6.1.0 → 6.1.4

package/lib/cli/cli.js

@@ -1,69 +1,69 @@
-'use strict';
-
-/**
- * This is where we finally parse and handle arguments passed to the `mocha` executable.
- * Option parsing is handled by {@link https://npm.im/yargs yargs}.
- * If executed via `node`, this module will run {@linkcode module:lib/cli/cli.main main()}.
- *
- * @private
- * @module
- */
-
-const debug = require('debug')('mocha:cli:cli');
-const symbols = require('log-symbols');
-const yargs = require('yargs');
-const path = require('path');
-const {loadOptions, YARGS_PARSER_CONFIG} = require('./options');
-const commands = require('./commands');
-const ansi = require('ansi-colors');
-const {repository, homepage, version, gitter} = require('../../package.json');
-
-/**
- * - Accepts an `Array` of arguments
- * - Modifies {@link https://nodejs.org/api/modules.html#modules_module_paths Node.js' search path} for easy loading of consumer modules
- * - Sets {@linkcode https://nodejs.org/api/errors.html#errors_error_stacktracelimit Error.stackTraceLimit} to `Infinity`
- * @summary Mocha's main entry point from the command-line.
- * @param {string[]} argv - Array of arguments to parse, or by default the lovely `process.argv.slice(2)`
- */
-exports.main = (argv = process.argv.slice(2)) => {
-  debug('entered main with raw args', argv);
-  // ensure we can require() from current working directory
-  module.paths.push(process.cwd(), path.resolve('node_modules'));
-
-  Error.stackTraceLimit = Infinity; // configurable via --stack-trace-limit?
-
-  yargs
-    .scriptName('mocha')
-    .command(commands.run)
-    .command(commands.init)
-    .updateStrings({
-      'Positionals:': 'Positional Arguments',
-      'Options:': 'Other Options',
-      'Commands:': 'Commands'
-    })
-    .fail((msg, err, yargs) => {
-      debug(err);
-      yargs.showHelp();
-      console.error(`\n${symbols.error} ${ansi.red('ERROR:')} ${msg}`);
-      process.exit(1);
-    })
-    .help('help', 'Show usage information & exit')
-    .alias('help', 'h')
-    .version('version', 'Show version number & exit', version)
-    .alias('version', 'V')
-    .wrap(process.stdout.columns ? Math.min(process.stdout.columns, 80) : 80)
-    .epilog(
-      `Mocha Resources
-    Chat: ${ansi.magenta(gitter)}
-  GitHub: ${ansi.blue(repository.url)}
-    Docs: ${ansi.yellow(homepage)}
-      `
-    )
-    .parserConfiguration(YARGS_PARSER_CONFIG)
-    .parse(argv, loadOptions(argv));
-};
-
-// allow direct execution
-if (require.main === module) {
-  exports.main();
-}
+'use strict';
+
+/**
+ * This is where we finally parse and handle arguments passed to the `mocha` executable.
+ * Option parsing is handled by {@link https://npm.im/yargs yargs}.
+ * If executed via `node`, this module will run {@linkcode module:lib/cli/cli.main main()}.
+ *
+ * @private
+ * @module
+ */
+
+const debug = require('debug')('mocha:cli:cli');
+const symbols = require('log-symbols');
+const yargs = require('yargs/yargs');
+const path = require('path');
+const {loadOptions, YARGS_PARSER_CONFIG} = require('./options');
+const commands = require('./commands');
+const ansi = require('ansi-colors');
+const {repository, homepage, version, gitter} = require('../../package.json');
+
+/**
+ * - Accepts an `Array` of arguments
+ * - Modifies {@link https://nodejs.org/api/modules.html#modules_module_paths Node.js' search path} for easy loading of consumer modules
+ * - Sets {@linkcode https://nodejs.org/api/errors.html#errors_error_stacktracelimit Error.stackTraceLimit} to `Infinity`
+ * @summary Mocha's main entry point from the command-line.
+ * @param {string[]} argv - Array of arguments to parse, or by default the lovely `process.argv.slice(2)`
+ */
+exports.main = (argv = process.argv.slice(2)) => {
+  debug('entered main with raw args', argv);
+  // ensure we can require() from current working directory
+  module.paths.push(process.cwd(), path.resolve('node_modules'));
+
+  Error.stackTraceLimit = Infinity; // configurable via --stack-trace-limit?
+
+  yargs()
+    .scriptName('mocha')
+    .command(commands.run)
+    .command(commands.init)
+    .updateStrings({
+      'Positionals:': 'Positional Arguments',
+      'Options:': 'Other Options',
+      'Commands:': 'Commands'
+    })
+    .fail((msg, err, yargs) => {
+      debug(err);
+      yargs.showHelp();
+      console.error(`\n${symbols.error} ${ansi.red('ERROR:')} ${msg}`);
+      process.exit(1);
+    })
+    .help('help', 'Show usage information & exit')
+    .alias('help', 'h')
+    .version('version', 'Show version number & exit', version)
+    .alias('version', 'V')
+    .wrap(process.stdout.columns ? Math.min(process.stdout.columns, 80) : 80)
+    .epilog(
+      `Mocha Resources
+    Chat: ${ansi.magenta(gitter)}
+  GitHub: ${ansi.blue(repository.url)}
+    Docs: ${ansi.yellow(homepage)}
+      `
+    )
+    .parserConfiguration(YARGS_PARSER_CONFIG)
+    .parse(argv, loadOptions(argv));
+};
+
+// allow direct execution
+if (require.main === module) {
+  exports.main();
+}

package/lib/cli/commands.js

@@ -1,13 +1,13 @@
-'use strict';
-
-/**
- * Exports Yargs commands
- * @see https://git.io/fpJ0G
- * @private
- * @module
- */
-
-exports.init = require('./init');
-
-// default command
-exports.run = require('./run');
+'use strict';
+
+/**
+ * Exports Yargs commands
+ * @see https://git.io/fpJ0G
+ * @private
+ * @module
+ */
+
+exports.init = require('./init');
+
+// default command
+exports.run = require('./run');

package/lib/cli/config.js

@@ -1,101 +1,101 @@
-'use strict';
-
-/**
- * Responsible for loading / finding Mocha's "rc" files.
- * This doesn't have anything to do with `mocha.opts`.
- *
- * @private
- * @module
- */
-
-const fs = require('fs');
-const path = require('path');
-const debug = require('debug')('mocha:cli:config');
-const findUp = require('find-up');
-
-/**
- * These are the valid config files, in order of precedence;
- * e.g., if `.mocharc.js` is present, then `.mocharc.yaml` and the rest
- * will be ignored.
- * The user should still be able to explicitly specify a file.
- * @private
- */
-exports.CONFIG_FILES = [
-  '.mocharc.js',
-  '.mocharc.yaml',
-  '.mocharc.yml',
-  '.mocharc.jsonc',
-  '.mocharc.json'
-];
-
-const isModuleNotFoundError = err =>
-  err.code !== 'MODULE_NOT_FOUND' ||
-  err.message.indexOf('Cannot find module') !== -1;
-
-/**
- * Parsers for various config filetypes. Each accepts a filepath and
- * returns an object (but could throw)
- */
-const parsers = (exports.parsers = {
-  yaml: filepath =>
-    require('js-yaml').safeLoad(fs.readFileSync(filepath, 'utf8')),
-  js: filepath => {
-    const cwdFilepath = path.resolve(filepath);
-    try {
-      debug(`parsers: load using cwd-relative path: "${cwdFilepath}"`);
-      return require(cwdFilepath);
-    } catch (err) {
-      if (isModuleNotFoundError(err)) {
-        debug(`parsers: retry load as module-relative path: "${filepath}"`);
-        return require(filepath);
-      } else {
-        throw err; // rethrow
-      }
-    }
-  },
-  json: filepath =>
-    JSON.parse(
-      require('strip-json-comments')(fs.readFileSync(filepath, 'utf8'))
-    )
-});
-
-/**
- * Loads and parses, based on file extension, a config file.
- * "JSON" files may have comments.
- *
- * @private
- * @param {string} filepath - Config file path to load
- * @returns {Object} Parsed config object
- */
-exports.loadConfig = filepath => {
-  let config = {};
-  debug(`loadConfig: "${filepath}"`);
-
-  const ext = path.extname(filepath);
-  try {
-    if (ext === '.yml' || ext === '.yaml') {
-      config = parsers.yaml(filepath);
-    } else if (ext === '.js') {
-      config = parsers.js(filepath);
-    } else {
-      config = parsers.json(filepath);
-    }
-  } catch (err) {
-    throw new Error(`failed to parse config "${filepath}": ${err}`);
-  }
-  return config;
-};
-
-/**
- * Find ("find up") config file starting at `cwd`
- *
- * @param {string} [cwd] - Current working directory
- * @returns {string|null} Filepath to config, if found
- */
-exports.findConfig = (cwd = process.cwd()) => {
-  const filepath = findUp.sync(exports.CONFIG_FILES, {cwd});
-  if (filepath) {
-    debug(`findConfig: found "${filepath}"`);
-  }
-  return filepath;
-};
+'use strict';
+
+/**
+ * Responsible for loading / finding Mocha's "rc" files.
+ * This doesn't have anything to do with `mocha.opts`.
+ *
+ * @private
+ * @module
+ */
+
+const fs = require('fs');
+const path = require('path');
+const debug = require('debug')('mocha:cli:config');
+const findUp = require('find-up');
+
+/**
+ * These are the valid config files, in order of precedence;
+ * e.g., if `.mocharc.js` is present, then `.mocharc.yaml` and the rest
+ * will be ignored.
+ * The user should still be able to explicitly specify a file.
+ * @private
+ */
+exports.CONFIG_FILES = [
+  '.mocharc.js',
+  '.mocharc.yaml',
+  '.mocharc.yml',
+  '.mocharc.jsonc',
+  '.mocharc.json'
+];
+
+const isModuleNotFoundError = err =>
+  err.code !== 'MODULE_NOT_FOUND' ||
+  err.message.indexOf('Cannot find module') !== -1;
+
+/**
+ * Parsers for various config filetypes. Each accepts a filepath and
+ * returns an object (but could throw)
+ */
+const parsers = (exports.parsers = {
+  yaml: filepath =>
+    require('js-yaml').safeLoad(fs.readFileSync(filepath, 'utf8')),
+  js: filepath => {
+    const cwdFilepath = path.resolve(filepath);
+    try {
+      debug(`parsers: load using cwd-relative path: "${cwdFilepath}"`);
+      return require(cwdFilepath);
+    } catch (err) {
+      if (isModuleNotFoundError(err)) {
+        debug(`parsers: retry load as module-relative path: "${filepath}"`);
+        return require(filepath);
+      } else {
+        throw err; // rethrow
+      }
+    }
+  },
+  json: filepath =>
+    JSON.parse(
+      require('strip-json-comments')(fs.readFileSync(filepath, 'utf8'))
+    )
+});
+
+/**
+ * Loads and parses, based on file extension, a config file.
+ * "JSON" files may have comments.
+ *
+ * @private
+ * @param {string} filepath - Config file path to load
+ * @returns {Object} Parsed config object
+ */
+exports.loadConfig = filepath => {
+  let config = {};
+  debug(`loadConfig: "${filepath}"`);
+
+  const ext = path.extname(filepath);
+  try {
+    if (ext === '.yml' || ext === '.yaml') {
+      config = parsers.yaml(filepath);
+    } else if (ext === '.js') {
+      config = parsers.js(filepath);
+    } else {
+      config = parsers.json(filepath);
+    }
+  } catch (err) {
+    throw new Error(`failed to parse config "${filepath}": ${err}`);
+  }
+  return config;
+};
+
+/**
+ * Find ("find up") config file starting at `cwd`
+ *
+ * @param {string} [cwd] - Current working directory
+ * @returns {string|null} Filepath to config, if found
+ */
+exports.findConfig = (cwd = process.cwd()) => {
+  const filepath = findUp.sync(exports.CONFIG_FILES, {cwd});
+  if (filepath) {
+    debug(`findConfig: found "${filepath}"`);
+  }
+  return filepath;
+};

package/lib/cli/index.js

@@ -1,9 +1,9 @@
-'use strict';
-
-/**
- * Just exports {@link module:lib/cli/cli} for convenience.
- * @private
- * @module lib/cli
- * @exports module:lib/cli/cli
- */
-module.exports = require('./cli');
+'use strict';
+
+/**
+ * Just exports {@link module:lib/cli/cli} for convenience.
+ * @private
+ * @module lib/cli
+ * @exports module:lib/cli/cli
+ */
+module.exports = require('./cli');

package/lib/cli/init.js

@@ -1,37 +1,37 @@
-'use strict';
-
-/**
- * Command module for "init" command
- *
- * @private
- * @module
- */
-
-const fs = require('fs');
-const path = require('path');
-const mkdirp = require('mkdirp');
-
-exports.command = 'init <path>';
-
-exports.description = 'create a client-side Mocha setup at <path>';
-
-exports.builder = yargs =>
-  yargs.positional('path', {
-    type: 'string',
-    normalize: true
-  });
-
-exports.handler = argv => {
-  const destdir = argv.path;
-  const srcdir = path.join(__dirname, '..', '..');
-  mkdirp.sync(destdir);
-  const css = fs.readFileSync(path.join(srcdir, 'mocha.css'));
-  const js = fs.readFileSync(path.join(srcdir, 'mocha.js'));
-  const tmpl = fs.readFileSync(
-    path.join(srcdir, 'lib', 'browser', 'template.html')
-  );
-  fs.writeFileSync(path.join(destdir, 'mocha.css'), css);
-  fs.writeFileSync(path.join(destdir, 'mocha.js'), js);
-  fs.writeFileSync(path.join(destdir, 'tests.spec.js'), '');
-  fs.writeFileSync(path.join(destdir, 'index.html'), tmpl);
-};
+'use strict';
+
+/**
+ * Command module for "init" command
+ *
+ * @private
+ * @module
+ */
+
+const fs = require('fs');
+const path = require('path');
+const mkdirp = require('mkdirp');
+
+exports.command = 'init <path>';
+
+exports.description = 'create a client-side Mocha setup at <path>';
+
+exports.builder = yargs =>
+  yargs.positional('path', {
+    type: 'string',
+    normalize: true
+  });
+
+exports.handler = argv => {
+  const destdir = argv.path;
+  const srcdir = path.join(__dirname, '..', '..');
+  mkdirp.sync(destdir);
+  const css = fs.readFileSync(path.join(srcdir, 'mocha.css'));
+  const js = fs.readFileSync(path.join(srcdir, 'mocha.js'));
+  const tmpl = fs.readFileSync(
+    path.join(srcdir, 'lib', 'browser', 'template.html')
+  );
+  fs.writeFileSync(path.join(destdir, 'mocha.css'), css);
+  fs.writeFileSync(path.join(destdir, 'mocha.js'), js);
+  fs.writeFileSync(path.join(destdir, 'tests.spec.js'), '');
+  fs.writeFileSync(path.join(destdir, 'index.html'), tmpl);
+};

package/lib/cli/node-flags.js

@@ -1,86 +1,86 @@
-'use strict';
-
-/**
- * Some settings and code related to Mocha's handling of Node.js/V8 flags.
- * @private
- * @module
- */
-
-const nodeFlags = require('node-environment-flags');
-const unparse = require('yargs-unparser');
-
-/**
- * These flags are considered "debug" flags.
- * @see {@link impliesNoTimeouts}
- * @private
- */
-const debugFlags = new Set(['debug', 'debug-brk', 'inspect', 'inspect-brk']);
-
-/**
- * Mocha has historical support for various `node` and V8 flags which might not
- * appear in `process.allowedNodeEnvironmentFlags`.
- * These include:
- *   - `--preserve-symlinks`
- *   - `--harmony-*`
- *   - `--gc-global`
- *   - `--trace-*`
- *   - `--es-staging`
- *   - `--use-strict`
- *   - `--v8-*` (but *not* `--v8-options`)
- * @summary Whether or not to pass a flag along to the `node` executable.
- * @param {string} flag - Flag to test
- * @param {boolean} [bareword=true] - If `false`, we expect `flag` to have one or two leading dashes.
- * @returns {boolean} If the flag is considered a "Node" flag.
- * @private
- */
-exports.isNodeFlag = (flag, bareword = true) => {
-  if (!bareword) {
-    // check if the flag begins with dashes; if not, not a node flag.
-    if (!/^--?/.test(flag)) {
-      return false;
-    }
-    // strip the leading dashes to match against subsequent checks
-    flag = flag.replace(/^--?/, '');
-  }
-  return (
-    // treat --require/-r as Mocha flag even though it's also a node flag
-    !(flag === 'require' || flag === 'r') &&
-    // check actual node flags from `process.allowedNodeEnvironmentFlags`,
-    // then historical support for various V8 and non-`NODE_OPTIONS` flags
-    // and also any V8 flags with `--v8-` prefix
-    (nodeFlags.has(flag) ||
-      debugFlags.has(flag) ||
-      /(?:preserve-symlinks(?:-main)?|harmony(?:[_-]|$)|(?:trace[_-].+$)|gc(?:[_-]global)?$|es[_-]staging$|use[_-]strict$|v8[_-](?!options).+?$)/.test(
-        flag
-      ))
-  );
-};
-
-/**
- * Returns `true` if the flag is a "debug-like" flag.  These require timeouts
- * to be suppressed, or pausing the debugger on breakpoints will cause test failures.
- * @param {string} flag - Flag to test
- * @returns {boolean}
- * @private
- */
-exports.impliesNoTimeouts = flag => debugFlags.has(flag);
-
-/**
- * All non-strictly-boolean arguments to node--those with values--must specify those values using `=`, e.g., `--inspect=0.0.0.0`.
- * Unparse these arguments using `yargs-unparser` (which would result in `--inspect 0.0.0.0`), then supply `=` where we have values.
- * There's probably an easier or more robust way to do this; fixes welcome
- * @param {Object} opts - Arguments object
- * @returns {string[]} Unparsed arguments using `=` to specify values
- * @private
- */
-exports.unparseNodeFlags = opts => {
-  var args = unparse(opts);
-  return args.length
-    ? args
-        .join(' ')
-        .split(/\b/)
-        .map(arg => (arg === ' ' ? '=' : arg))
-        .join('')
-        .split(' ')
-    : [];
-};
+'use strict';
+
+/**
+ * Some settings and code related to Mocha's handling of Node.js/V8 flags.
+ * @private
+ * @module
+ */
+
+const nodeFlags = require('node-environment-flags');
+const unparse = require('yargs-unparser');
+
+/**
+ * These flags are considered "debug" flags.
+ * @see {@link impliesNoTimeouts}
+ * @private
+ */
+const debugFlags = new Set(['debug', 'debug-brk', 'inspect', 'inspect-brk']);
+
+/**
+ * Mocha has historical support for various `node` and V8 flags which might not
+ * appear in `process.allowedNodeEnvironmentFlags`.
+ * These include:
+ *   - `--preserve-symlinks`
+ *   - `--harmony-*`
+ *   - `--gc-global`
+ *   - `--trace-*`
+ *   - `--es-staging`
+ *   - `--use-strict`
+ *   - `--v8-*` (but *not* `--v8-options`)
+ * @summary Whether or not to pass a flag along to the `node` executable.
+ * @param {string} flag - Flag to test
+ * @param {boolean} [bareword=true] - If `false`, we expect `flag` to have one or two leading dashes.
+ * @returns {boolean} If the flag is considered a "Node" flag.
+ * @private
+ */
+exports.isNodeFlag = (flag, bareword = true) => {
+  if (!bareword) {
+    // check if the flag begins with dashes; if not, not a node flag.
+    if (!/^--?/.test(flag)) {
+      return false;
+    }
+    // strip the leading dashes to match against subsequent checks
+    flag = flag.replace(/^--?/, '');
+  }
+  return (
+    // treat --require/-r as Mocha flag even though it's also a node flag
+    !(flag === 'require' || flag === 'r') &&
+    // check actual node flags from `process.allowedNodeEnvironmentFlags`,
+    // then historical support for various V8 and non-`NODE_OPTIONS` flags
+    // and also any V8 flags with `--v8-` prefix
+    (nodeFlags.has(flag) ||
+      debugFlags.has(flag) ||
+      /(?:preserve-symlinks(?:-main)?|harmony(?:[_-]|$)|(?:trace[_-].+$)|gc(?:[_-]global)?$|es[_-]staging$|use[_-]strict$|v8[_-](?!options).+?$)/.test(
+        flag
+      ))
+  );
+};
+
+/**
+ * Returns `true` if the flag is a "debug-like" flag.  These require timeouts
+ * to be suppressed, or pausing the debugger on breakpoints will cause test failures.
+ * @param {string} flag - Flag to test
+ * @returns {boolean}
+ * @private
+ */
+exports.impliesNoTimeouts = flag => debugFlags.has(flag);
+
+/**
+ * All non-strictly-boolean arguments to node--those with values--must specify those values using `=`, e.g., `--inspect=0.0.0.0`.
+ * Unparse these arguments using `yargs-unparser` (which would result in `--inspect 0.0.0.0`), then supply `=` where we have values.
+ * There's probably an easier or more robust way to do this; fixes welcome
+ * @param {Object} opts - Arguments object
+ * @returns {string[]} Unparsed arguments using `=` to specify values
+ * @private
+ */
+exports.unparseNodeFlags = opts => {
+  var args = unparse(opts);
+  return args.length
+    ? args
+        .join(' ')
+        .split(/\b/)
+        .map(arg => (arg === ' ' ? '=' : arg))
+        .join('')
+        .split(' ')
+    : [];
+};