mocha 8.0.1 → 8.1.0

package/CHANGELOG.md

@@ -1,10 +1,49 @@
+# 8.1.0 / 2020-07-30
+
+In this release, Mocha now builds its browser bundle with Rollup and Babel, which will provide the project's codebase more flexibility and consistency.
+
+While we've been diligent about backwards compatibility, it's _possible_ consumers of the browser bundle will encounter differences (other than an increase in the bundle size). If you _do_ encounter an issue with the build, please [report it here](https://github.com/mochajs/mocha/issues/new?labels=unconfirmed-bug&template=bug_report.md&title=).
+
+This release **does not** drop support for IE11.
+
+Other community contributions came from [**@Devjeel**](https://github.com/Devjeel), [**@Harsha509**](https://github.com/Harsha509) and [**@sharath2106**](https://github.com/sharath2106). _Thank you_ to everyone who contributed to this release!
+
+> Do you read Korean? See [this guide to running parallel tests in Mocha](https://blog.outsider.ne.kr/1489), translated by our maintainer, [**@outsideris**](https://github.com/outsideris).
+
+## :tada: Enhancements
+
+- [#4287](https://github.com/mochajs/mocha/issues/4287): Use background colors with inline diffs for better visual distinction ([**@michael-brade**](https://github.com/michael-brade))
+
+## :bug: Fixes
+
+- [#4328](https://github.com/mochajs/mocha/issues/4328): Fix "watch" mode when Mocha run in parallel ([**@boneskull**](https://github.com/boneskull))
+- [#4382](https://github.com/mochajs/mocha/issues/4382): Fix root hook execution in "watch" mode ([**@indieisaconcept**](https://github.com/indieisaconcept))
+- [#4383](https://github.com/mochajs/mocha/issues/4383): Consistent auto-generated hook titles ([**@cspotcode**](https://github.com/cspotcode))
+- [#4359](https://github.com/mochajs/mocha/issues/4359): Better errors when running `mocha init` ([**@boneskull**](https://github.com/boneskull))
+- [#4341](https://github.com/mochajs/mocha/issues/4341): Fix weirdness when using `delay` option in browser ([**@craigtaub**](https://github.com/craigtaub))
+
+## :lock: Security Fixes
+
+- [#4378](https://github.com/mochajs/mocha/issues/4378), [#4333](https://github.com/mochajs/mocha/issues/4333): Update [javascript-serialize](https://npm.im/javascript-serialize) ([**@martinoppitz**](https://github.com/martinoppitz), [**@wnghdcjfe**](https://github.com/wnghdcjfe))
+- [#4354](https://github.com/mochajs/mocha/issues/4354): Update [yargs-unparser](https://npm.im/yargs-unparser) ([**@martinoppitz**](https://github.com/martinoppitz))
+
+## :book: Documentation & Website
+
+- [#4173](https://github.com/mochajs/mocha/issues/4173): Document how to use `--enable-source-maps` with Mocha ([**@bcoe**](https://github.com/bcoe))
+- [#4343](https://github.com/mochajs/mocha/issues/4343): Clean up some API docs ([**@craigtaub**](https://github.com/craigtaub))
+- [#4318](https://github.com/mochajs/mocha/issues/4318): Sponsor images are now self-hosted ([**@Munter**](https://github.com/Munter))
+
+## :nut_and_bolt: Other
+
+- [#4293](https://github.com/mochajs/mocha/issues/4293): Use Rollup and Babel in build pipeline; add source map to published files ([**@Munter**](https://github.com/Munter))
+
 # 8.0.1 / 2020-06-10
 
 The obligatory patch after a major.
 
 ## :bug: Fixes
 
-- [#4328]: Fix `--parallel` when combined with `--watch` ([**@boneskull**](https://github.com/boneskull))
+- [#4328](https://github.com/mochajs/mocha/issues/4328): Fix `--parallel` when combined with `--watch` ([**@boneskull**](https://github.com/boneskull))
 
 # 8.0.0 / 2020-06-10
 
@@ -14,7 +53,7 @@ Let's welcome [**@giltayar**](https://github.com/giltayar) and [**@nicojs**](htt
 
 ## :boom: Breaking Changes
 
-- [#4164](https://github.com/mochajs/mocha/issues/4164): **Mocha v8.0.0 now requires Node.js v10.0.0 or newer.** Mocha no longer supports the Node.js v8.x line ("Carbon"), which entered End-of-Life at the end of 2019 ([**@UlisesGascon**](https://github.com/UlisesGascon))
+- [#4164](https://github.com/mochajs/mocha/issues/4164): **Mocha v8.0.0 now requires Node.js v10.12.0 or newer.** Mocha no longer supports the Node.js v8.x line ("Carbon"), which entered End-of-Life at the end of 2019 ([**@UlisesGascon**](https://github.com/UlisesGascon))
 
 - [#4175](https://github.com/mochajs/mocha/issues/4175): Having been deprecated with a warning since v7.0.0, **`mocha.opts` is no longer supported** ([**@juergba**](https://github.com/juergba))
 
@@ -35,6 +74,7 @@ Let's welcome [**@giltayar**](https://github.com/giltayar) and [**@nicojs**](htt
 - [#4223](https://github.com/mochajs/mocha/issues/4223): The context object's `skip()` (`this.skip()`) in a "before all" (`before()`) hook will no longer execute subsequent sibling hooks, in addition to hooks in child suites ([**@juergba**](https://github.com/juergba))
 
 - [#4178](https://github.com/mochajs/mocha/issues/4178): Remove previously soft-deprecated APIs ([**@wnghdcjfe**](https://github.com/wnghdcjfe)):
+
   - `Mocha.prototype.ignoreLeaks()`
   - `Mocha.prototype.useColors()`
   - `Mocha.prototype.useInlineDiffs()`
@@ -54,6 +94,10 @@ Let's welcome [**@giltayar**](https://github.com/giltayar) and [**@nicojs**](htt
 
 - [#4246](https://github.com/mochajs/mocha/issues/4246): Add documentation for parallel mode and Root Hook plugins ([**@boneskull**](https://github.com/boneskull))
 
+## :nut_and_bolt: Other
+
+- [#4200](https://github.com/mochajs/mocha/issues/4200): Drop mkdirp and replace it with fs.mkdirSync ([**@HyunSangHan**](https://github.com/HyunSangHan))
+
 ## :bug: Fixes
 
 (All bug fixes in Mocha v8.0.0 are also breaking changes, and are listed above)

package/browser-entry.js

@@ -9,6 +9,8 @@
 
 process.stdout = require('browser-stdout')({label: false});
 
+var parseQuery = require('./lib/browser/parse-query');
+var highlightTags = require('./lib/browser/highlight-tags');
 var Mocha = require('./lib/mocha');
 
 /**
@@ -77,6 +79,13 @@ process.on = function(e, fn) {
   }
 };
 
+process.listeners = function(e) {
+  if (e === 'uncaughtException') {
+    return uncaughtExceptionHandlers;
+  }
+  return [];
+};
+
 // The BDD UI is registered by default, but no UI will be functional in the
 // browser without an explicit call to the overridden `mocha.ui` (see below).
 // Ensure that this default UI does not expose its methods to the global scope.
@@ -139,11 +148,19 @@ mocha.setup = function(opts) {
   if (typeof opts === 'string') {
     opts = {ui: opts};
   }
-  for (var opt in opts) {
-    if (Object.prototype.hasOwnProperty.call(opts, opt)) {
-      this[opt](opts[opt]);
-    }
+  if (opts.delay === true) {
+    this.delay();
   }
+  var self = this;
+  Object.keys(opts)
+    .filter(function(opt) {
+      return opt !== 'delay';
+    })
+    .forEach(function(opt) {
+      if (Object.prototype.hasOwnProperty.call(opts, opt)) {
+        self[opt](opts[opt]);
+      }
+    });
   return this;
 };
 
@@ -155,7 +172,7 @@ mocha.run = function(fn) {
   var options = mocha.options;
   mocha.globals('location');
 
-  var query = Mocha.utils.parseQuery(global.location.search || '');
+  var query = parseQuery(global.location.search || '');
   if (query.grep) {
     mocha.grep(query.grep);
   }
@@ -174,7 +191,7 @@ mocha.run = function(fn) {
       document.getElementById('mocha') &&
       options.noHighlighting !== true
     ) {
-      Mocha.utils.highlightTags('code');
+      highlightTags('code');
     }
     if (fn) {
       fn(err);
@@ -193,10 +210,10 @@ Mocha.process = process;
  * Expose mocha.
  */
 
-global.Mocha = Mocha;
-global.mocha = mocha;
+mocha.Mocha = Mocha;
+mocha.mocha = mocha;
 
 // this allows test/acceptance/required-tokens.js to pass; thus,
 // you can now do `const describe = require('mocha').describe` in a
 // browser context (assuming browserification).  should fix #880
-module.exports = global;
+module.exports = Object.assign(mocha, global);

package/lib/browser/highlight-tags.js

@@ -0,0 +1,39 @@
+'use strict';
+
+/**
+ * Highlight the given string of `js`.
+ *
+ * @private
+ * @param {string} js
+ * @return {string}
+ */
+function highlight(js) {
+  return js
+    .replace(/</g, '&lt;')
+    .replace(/>/g, '&gt;')
+    .replace(/\/\/(.*)/gm, '<span class="comment">//$1</span>')
+    .replace(/('.*?')/gm, '<span class="string">$1</span>')
+    .replace(/(\d+\.\d+)/gm, '<span class="number">$1</span>')
+    .replace(/(\d+)/gm, '<span class="number">$1</span>')
+    .replace(
+      /\bnew[ \t]+(\w+)/gm,
+      '<span class="keyword">new</span> <span class="init">$1</span>'
+    )
+    .replace(
+      /\b(function|new|throw|return|var|if|else)\b/gm,
+      '<span class="keyword">$1</span>'
+    );
+}
+
+/**
+ * Highlight the contents of tag `name`.
+ *
+ * @private
+ * @param {string} name
+ */
+module.exports = function highlightTags(name) {
+  var code = document.getElementById('mocha').getElementsByTagName(name);
+  for (var i = 0, len = code.length; i < len; ++i) {
+    code[i].innerHTML = highlight(code[i].innerHTML);
+  }
+};

package/lib/browser/parse-query.js

@@ -0,0 +1,24 @@
+'use strict';
+
+/**
+ * Parse the given `qs`.
+ *
+ * @private
+ * @param {string} qs
+ * @return {Object<string, string>}
+ */
+module.exports = function parseQuery(qs) {
+  return qs
+    .replace('?', '')
+    .split('&')
+    .reduce(function(obj, pair) {
+      var i = pair.indexOf('=');
+      var key = pair.slice(0, i);
+      var val = pair.slice(++i);
+
+      // Due to how the URLSearchParams API treats spaces
+      obj[key] = decodeURIComponent(val.replace(/\+/g, '%20'));
+
+      return obj;
+    }, {});
+};

package/lib/browser/progress.js

@@ -1,5 +1,9 @@
 'use strict';
 
+/**
+ @module browser/Progress
+*/
+
 /**
  * Expose `Progress`.
  */

package/lib/browser/template.html

@@ -1,16 +1,18 @@
 <!DOCTYPE html>
 <html lang="en">
   <head>
-    <meta charset="utf-8">
+    <meta charset="utf-8" />
     <title>Mocha</title>
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <link rel="stylesheet" href="mocha.css">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <link rel="stylesheet" href="mocha.css" />
   </head>
   <body>
     <div id="mocha"></div>
     <script src="mocha.js"></script>
-    <script>mocha.setup('bdd');</script>
-    <script src="tests.js"></script>
+    <script>
+      mocha.setup('bdd');
+    </script>
+    <script src="tests.spec.js"></script>
     <script>
       mocha.run();
     </script>

package/lib/cli/cli.js

@@ -52,7 +52,7 @@ exports.main = (argv = process.argv.slice(2)) => {
       debug('caught error sometime before command handler: %O', err);
       yargs.showHelp();
       console.error(`\n${symbols.error} ${ansi.red('ERROR:')} ${msg}`);
-      yargs.exit(1);
+      process.exitCode = 1;
     })
     .help('help', 'Show usage information & exit')
     .alias('help', 'h')

package/lib/cli/collect-files.js

@@ -4,8 +4,8 @@ const path = require('path');
 const ansi = require('ansi-colors');
 const debug = require('debug')('mocha:cli:run:helpers');
 const minimatch = require('minimatch');
-const utils = require('../utils');
 const {NO_FILES_MATCH_PATTERN} = require('../errors').constants;
+const lookupFiles = require('./lookup-files');
 
 /**
  * Exports a function that collects test files from CLI parameters.
@@ -27,7 +27,7 @@ module.exports = ({ignore, extension, file, recursive, sort, spec} = {}) => {
   spec.forEach(arg => {
     let newFiles;
     try {
-      newFiles = utils.lookupFiles(arg, extension, recursive);
+      newFiles = lookupFiles(arg, extension, recursive);
     } catch (err) {
       if (err.code === NO_FILES_MATCH_PATTERN) {
         unmatched.push({message: err.message, pattern: err.pattern});
@@ -81,6 +81,7 @@ module.exports = ({ignore, extension, file, recursive, sort, spec} = {}) => {
 
 /**
  * An object to configure how Mocha gathers test files
+ * @private
  * @typedef {Object} FileCollectionOptions
  * @property {string[]} extension - File extensions to use
  * @property {string[]} spec - Files, dirs, globs to run

package/lib/cli/lookup-files.js

@@ -0,0 +1,145 @@
+'use strict';
+
+var fs = require('fs');
+var path = require('path');
+var glob = require('glob');
+var {format} = require('util');
+var errors = require('../errors');
+var createNoFilesMatchPatternError = errors.createNoFilesMatchPatternError;
+var createMissingArgumentError = errors.createMissingArgumentError;
+var {sQuote, dQuote} = require('../utils');
+
+/**
+ * Determines if pathname would be a "hidden" file (or directory) on UN*X.
+ *
+ * @description
+ * On UN*X, pathnames beginning with a full stop (aka dot) are hidden during
+ * typical usage. Dotfiles, plain-text configuration files, are prime examples.
+ *
+ * @see {@link http://xahlee.info/UnixResource_dir/writ/unix_origin_of_dot_filename.html|Origin of Dot File Names}
+ *
+ * @private
+ * @param {string} pathname - Pathname to check for match.
+ * @return {boolean} whether pathname would be considered a hidden file.
+ * @example
+ * isHiddenOnUnix('.profile'); // => true
+ */
+function isHiddenOnUnix(pathname) {
+  return path.basename(pathname)[0] === '.';
+}
+
+/**
+ * Determines if pathname has a matching file extension.
+ *
+ * @private
+ * @param {string} pathname - Pathname to check for match.
+ * @param {string[]} exts - List of file extensions (sans period).
+ * @return {boolean} whether file extension matches.
+ * @example
+ * hasMatchingExtname('foo.html', ['js', 'css']); // => false
+ */
+function hasMatchingExtname(pathname, exts) {
+  var suffix = path.extname(pathname).slice(1);
+  return exts.some(function(element) {
+    return suffix === element;
+  });
+}
+
+/**
+ * Lookup file names at the given `path`.
+ *
+ * @description
+ * Filenames are returned in _traversal_ order by the OS/filesystem.
+ * **Make no assumption that the names will be sorted in any fashion.**
+ *
+ * @public
+ * @memberof Mocha.utils
+ * @param {string} filepath - Base path to start searching from.
+ * @param {string[]} [extensions=[]] - File extensions to look for.
+ * @param {boolean} [recursive=false] - Whether to recurse into subdirectories.
+ * @return {string[]} An array of paths.
+ * @throws {Error} if no files match pattern.
+ * @throws {TypeError} if `filepath` is directory and `extensions` not provided.
+ */
+module.exports = function lookupFiles(filepath, extensions, recursive) {
+  extensions = extensions || [];
+  recursive = recursive || false;
+  var files = [];
+  var stat;
+
+  if (!fs.existsSync(filepath)) {
+    var pattern;
+    if (glob.hasMagic(filepath)) {
+      // Handle glob as is without extensions
+      pattern = filepath;
+    } else {
+      // glob pattern e.g. 'filepath+(.js|.ts)'
+      var strExtensions = extensions
+        .map(function(v) {
+          return '.' + v;
+        })
+        .join('|');
+      pattern = filepath + '+(' + strExtensions + ')';
+    }
+    files = glob.sync(pattern, {nodir: true});
+    if (!files.length) {
+      throw createNoFilesMatchPatternError(
+        'Cannot find any files matching pattern ' + dQuote(filepath),
+        filepath
+      );
+    }
+    return files;
+  }
+
+  // Handle file
+  try {
+    stat = fs.statSync(filepath);
+    if (stat.isFile()) {
+      return filepath;
+    }
+  } catch (err) {
+    // ignore error
+    return;
+  }
+
+  // Handle directory
+  fs.readdirSync(filepath).forEach(function(dirent) {
+    var pathname = path.join(filepath, dirent);
+    var stat;
+
+    try {
+      stat = fs.statSync(pathname);
+      if (stat.isDirectory()) {
+        if (recursive) {
+          files = files.concat(lookupFiles(pathname, extensions, recursive));
+        }
+        return;
+      }
+    } catch (err) {
+      // ignore error
+      return;
+    }
+    if (!extensions.length) {
+      throw createMissingArgumentError(
+        format(
+          'Argument %s required when argument %s is a directory',
+          sQuote('extensions'),
+          sQuote('filepath')
+        ),
+        'extensions',
+        'array'
+      );
+    }
+
+    if (
+      !stat.isFile() ||
+      !hasMatchingExtname(pathname, extensions) ||
+      isHiddenOnUnix(pathname)
+    ) {
+      return;
+    }
+    files.push(pathname);
+  });
+
+  return files;
+};

package/lib/cli/watch-run.js

@@ -19,7 +19,7 @@ const collectFiles = require('./collect-files');
  * @param {Object} opts - Options
  * @param {string[]} [opts.watchFiles] - List of paths and patterns to
  *   watch. If not provided all files with an extension included in
- *   `fileColletionParams.extension` are watched. See first argument of
+ *   `fileCollectionParams.extension` are watched. See first argument of
  *   `chokidar.watch`.
  * @param {string[]} opts.watchIgnore - List of paths and patterns to
  *   exclude from watching. See `ignored` option of `chokidar`.
@@ -59,6 +59,10 @@ exports.watchParallelRun = (
       // in `createRerunner`), we need to call `mocha.ui()` again to set up the context/globals.
       newMocha.ui(newMocha.options.ui);
 
+      // we need to call `newMocha.rootHooks` to set up rootHooks for the new
+      // suite
+      newMocha.rootHooks(newMocha.options.rootHooks);
+
       // in parallel mode, the main Mocha process doesn't actually load the
       // files. this flag prevents `mocha.run()` from autoloading.
       newMocha.lazyLoadFiles(true);
@@ -77,7 +81,7 @@ exports.watchParallelRun = (
  * @param {Object} opts - Options
  * @param {string[]} [opts.watchFiles] - List of paths and patterns to
  *   watch. If not provided all files with an extension included in
- *   `fileColletionParams.extension` are watched. See first argument of
+ *   `fileCollectionParams.extension` are watched. See first argument of
  *   `chokidar.watch`.
  * @param {string[]} opts.watchIgnore - List of paths and patterns to
  *   exclude from watching. See `ignored` option of `chokidar`.
@@ -118,6 +122,10 @@ exports.watchRun = (mocha, {watchFiles, watchIgnore}, fileCollectParams) => {
       // in `createRerunner`), we need to call `mocha.ui()` again to set up the context/globals.
       newMocha.ui(newMocha.options.ui);
 
+      // we need to call `newMocha.rootHooks` to set up rootHooks for the new
+      // suite
+      newMocha.rootHooks(newMocha.options.rootHooks);
+
       return newMocha;
     },
     afterRun({watcher}) {
@@ -136,7 +144,7 @@ exports.watchRun = (mocha, {watchFiles, watchIgnore}, fileCollectParams) => {
  * @param {AfterWatchRun} [opts.afterRun] - Function to call after `mocha.run()`
  * @param {string[]} [opts.watchFiles] - List of paths and patterns to watch. If
  *   not provided all files with an extension included in
- *   `fileColletionParams.extension` are watched. See first argument of
+ *   `fileCollectionParams.extension` are watched. See first argument of
  *   `chokidar.watch`.
  * @param {string[]} [opts.watchIgnore] - List of paths and patterns to exclude
  *   from watching. See `ignored` option of `chokidar`.

package/lib/errors.js

@@ -59,12 +59,12 @@ var constants = {
   UNSUPPORTED: 'ERR_MOCHA_UNSUPPORTED',
 
   /**
-   * Invalid state transition occuring in `Mocha` instance
+   * Invalid state transition occurring in `Mocha` instance
    */
   INSTANCE_ALREADY_RUNNING: 'ERR_MOCHA_INSTANCE_ALREADY_RUNNING',
 
   /**
-   * Invalid state transition occuring in `Mocha` instance
+   * Invalid state transition occurring in `Mocha` instance
    */
   INSTANCE_ALREADY_DISPOSED: 'ERR_MOCHA_INSTANCE_ALREADY_DISPOSED',
 

package/lib/interfaces/common.js

@@ -1,5 +1,9 @@
 'use strict';
 
+/**
+ @module interfaces/common
+*/
+
 var Suite = require('../suite');
 var errors = require('../errors');
 var createMissingArgumentError = errors.createMissingArgumentError;
@@ -9,6 +13,7 @@ var createForbiddenExclusivityError = errors.createForbiddenExclusivityError;
 /**
  * Functions common to more than one interface.
  *
+ * @private
  * @param {Suite[]} suites
  * @param {Context} context
  * @param {Mocha} mocha

package/lib/mocha.js

@@ -35,23 +35,28 @@ exports = module.exports = Mocha;
 /**
  * A Mocha instance is a finite state machine.
  * These are the states it can be in.
+ * @private
  */
 var mochaStates = utils.defineConstants({
   /**
    * Initial state of the mocha instance
+   * @private
    */
   INIT: 'init',
   /**
    * Mocha instance is running tests
+   * @private
    */
   RUNNING: 'running',
   /**
    * Mocha instance is done running tests and references to test functions and hooks are cleaned.
    * You can reset this state by unloading the test files.
+   * @private
    */
   REFERENCES_CLEANED: 'referencesCleaned',
   /**
    * Mocha instance is disposed and can no longer be used.
+   * @private
    */
   DISPOSED: 'disposed'
 });
@@ -67,6 +72,7 @@ if (!utils.isBrowser() && typeof module.paths !== 'undefined') {
 
 /**
  * Expose internals.
+ * @private
  */
 
 exports.utils = utils;
@@ -246,7 +252,7 @@ Mocha.prototype.addFile = function(file) {
  * @public
  * @see [CLI option](../#-reporter-name-r-name)
  * @see [Reporters](../#reporters)
- * @param {String|Function} reporter - Reporter name or constructor.
+ * @param {String|Function} reporterName - Reporter name or constructor.
  * @param {Object} [reporterOptions] - Options used to configure the reporter.
  * @returns {Mocha} this
  * @chainable
@@ -769,8 +775,8 @@ Mocha.prototype.timeout = function(msecs) {
  * // Allow any failed test to retry one more time
  * mocha.retries(1);
  */
-Mocha.prototype.retries = function(n) {
-  this.suite.retries(n);
+Mocha.prototype.retries = function(retry) {
+  this.suite.retries(retry);
   return this;
 };
 
@@ -921,6 +927,7 @@ Object.defineProperty(Mocha.prototype, 'version', {
 /**
  * Callback to be invoked when test execution is complete.
  *
+ * @private
  * @callback DoneCB
  * @param {number} failures - Number of failures that occurred.
  */
@@ -1091,6 +1098,7 @@ Mocha.prototype.lazyLoadFiles = function lazyLoadFiles(enable) {
 
 /**
  * An alternative way to define root hooks that works with parallel runs.
+ * @private
  * @typedef {Object} MochaRootHookObject
  * @property {Function|Function[]} [beforeAll] - "Before all" hook(s)
  * @property {Function|Function[]} [beforeEach] - "Before each" hook(s)
@@ -1100,6 +1108,7 @@ Mocha.prototype.lazyLoadFiles = function lazyLoadFiles(enable) {
 
 /**
  * An function that returns a {@link MochaRootHookObject}, either sync or async.
+ * @private
  * @callback MochaRootHookFunction
  * @returns {MochaRootHookObject|Promise<MochaRootHookObject>}
  */

package/lib/nodejs/parallel-buffered-runner.js

@@ -281,12 +281,14 @@ module.exports = ParallelBufferedRunner;
 
 /**
  * Listener function intended to be bound to `Process.SIGINT` event
+ * @private
  * @callback SigIntListener
  * @returns {Promise<void>}
  */
 
 /**
  * A function accepting a test file path and returning the results of a test run
+ * @private
  * @callback FileRunner
  * @param {string} filename - File to run
  * @returns {Promise<SerializedWorkerResult>}

package/lib/nodejs/serializer.js

@@ -387,6 +387,7 @@ exports.SerializableWorkerResult = SerializableWorkerResult;
 /**
  * The result of calling `SerializableEvent.serialize`, as received
  * by the deserializer.
+ * @private
  * @typedef {Object} SerializedEvent
  * @property {object?} data - Optional serialized data
  * @property {object?} error - Optional serialized `Error`
@@ -395,6 +396,7 @@ exports.SerializableWorkerResult = SerializableWorkerResult;
 /**
  * The result of calling `SerializableWorkerResult.serialize` as received
  * by the deserializer.
+ * @private
  * @typedef {Object} SerializedWorkerResult
  * @property {number} failureCount - Number of failures
  * @property {SerializedEvent[]} events - Serialized events

package/lib/pending.js

@@ -1,5 +1,9 @@
 'use strict';
 
+/**
+ @module Pending
+*/
+
 module.exports = Pending;
 
 /**