cypress 5.3.0 → 5.4.0

package/lib/cli.js

@@ -123,8 +123,10 @@ var descriptions = {
   browserOpenMode: 'path to a custom browser to be added to the list of available browsers in Cypress',
   browserRunMode: 'runs Cypress in the browser with the given name. if a filesystem path is supplied, Cypress will attempt to use the browser at that path.',
   cacheClear: 'delete all cached binaries',
+  cachePrune: 'deletes all cached binaries except for the version currently in use',
   cacheList: 'list cached binary versions',
   cachePath: 'print the path to the binary cache',
+  cacheSize: 'Used with the list command to show the sizes of the cached folders',
   ciBuildId: 'the unique identifier for a run on your CI provider. typically a "BUILD_ID" env var. this value is automatically detected for most CI providers',
   config: 'sets configuration values. separate multiple values with a comma. overrides any value in cypress.json.',
   configFile: 'path to JSON file where configuration values are set. defaults to "cypress.json". pass "false" to disable.',
@@ -299,7 +301,7 @@ module.exports = {
 
       require('./tasks/verify').start(options)["catch"](util.logErrorExit1);
     });
-    program.command('cache').usage('[command]').description('Manages the Cypress binary cache').option('list', text('cacheList')).option('path', text('cachePath')).option('clear', text('cacheClear')).action(function (opts, args) {
+    program.command('cache').usage('[command]').description('Manages the Cypress binary cache').option('list', text('cacheList')).option('path', text('cachePath')).option('clear', text('cacheClear')).option('prune', text('cachePrune')).option('--size', text('cacheSize')).action(function (opts, args) {
       if (!args || !args.length) {
         this.outputHelp();
         util.exit(1);
@@ -308,10 +310,15 @@ module.exports = {
       var _args = _slicedToArray(args, 1),
           command = _args[0];
 
-      if (!_.includes(['list', 'path', 'clear'], command)) {
+      if (!_.includes(['list', 'path', 'clear', 'prune'], command)) {
         unknownOption.call(this, "cache ".concat(command), 'command');
       }
 
+      if (command === 'list') {
+        cache.list(opts.size);
+        return;
+      }
+
       cache[command]();
     });
     program.command('info').usage('[command]').description('Prints Cypress and system information').option('--dev', text('dev'), coerceFalse).action(function (opts) {

package/lib/tasks/cache.js

@@ -1,5 +1,11 @@
 "use strict";
 
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
 var state = require('./state');
 
 var logger = require('../logger');
@@ -17,13 +23,18 @@ var moment = require('moment');
 
 var chalk = require('chalk');
 
-var _ = require('lodash'); // output colors for the table
+var _ = require('lodash');
+
+var getFolderSize = require('./get-folder-size');
+
+var Bluebird = require('bluebird'); // output colors for the table
 
 
 var colors = {
   titles: chalk.white,
   dates: chalk.cyan,
-  values: chalk.green
+  values: chalk.green,
+  size: chalk.gray
 };
 
 var logCachePath = function logCachePath() {
@@ -34,27 +45,69 @@ var logCachePath = function logCachePath() {
 var clear = function clear() {
   return fs.removeAsync(state.getCacheDir());
 };
+
+var prune = function prune() {
+  var cacheDir = state.getCacheDir();
+  var currentVersion = util.pkgVersion();
+  var deletedBinary = false;
+  return fs.readdirAsync(cacheDir).then(function (versions) {
+    return Bluebird.all(versions.map(function (version) {
+      if (version !== currentVersion) {
+        deletedBinary = true;
+        var versionDir = join(cacheDir, version);
+        return fs.removeAsync(versionDir);
+      }
+    }));
+  }).then(function () {
+    if (deletedBinary) {
+      logger.always("Deleted all binary caches except for the ".concat(currentVersion, " binary cache."));
+    } else {
+      logger.always("No binary caches found to prune.");
+    }
+  })["catch"]({
+    code: 'ENOENT'
+  }, function () {
+    logger.always("No Cypress cache was found at ".concat(cacheDir, ". Nothing to prune."));
+  });
+};
+
+var fileSizeInMB = function fileSizeInMB(size) {
+  return "".concat((size / 1024 / 1024).toFixed(1), "MB");
+};
 /**
  * Collects all cached versions, finds when each was used
  * and prints a table with results to the terminal
  */
 
 
-var list = function list() {
-  return getCachedVersions().then(function (binaries) {
+var list = function list(showSize) {
+  return getCachedVersions(showSize).then(function (binaries) {
+    var head = [colors.titles('version'), colors.titles('last used')];
+
+    if (showSize) {
+      head.push(colors.titles('size'));
+    }
+
     var table = new Table({
-      head: [colors.titles('version'), colors.titles('last used')]
+      head: head
     });
     binaries.forEach(function (binary) {
       var versionString = colors.values(binary.version);
       var lastUsed = binary.accessed ? colors.dates(binary.accessed) : 'unknown';
-      return table.push([versionString, lastUsed]);
+      var row = [versionString, lastUsed];
+
+      if (showSize) {
+        var size = colors.size(fileSizeInMB(binary.size));
+        row.push(size);
+      }
+
+      return table.push(row);
     });
     logger.always(table.toString());
   });
 };
 
-var getCachedVersions = function getCachedVersions() {
+var getCachedVersions = function getCachedVersions(showSize) {
   var cacheDir = state.getCacheDir();
   return fs.readdirAsync(cacheDir).filter(util.isSemver).map(function (version) {
     return {
@@ -82,12 +135,24 @@ var getCachedVersions = function getCachedVersions() {
       // could not find the binary or gets its stats
       return binary;
     });
+  }).mapSeries(function (binary) {
+    if (showSize) {
+      var binaryDir = state.getBinaryDir(binary.version);
+      return getFolderSize(binaryDir).then(function (size) {
+        return _objectSpread(_objectSpread({}, binary), {}, {
+          size: size
+        });
+      });
+    }
+
+    return binary;
   });
 };
 
 module.exports = {
   path: logCachePath,
   clear: clear,
+  prune: prune,
   list: list,
   getCachedVersions: getCachedVersions
 };

package/lib/tasks/get-folder-size.js

@@ -0,0 +1,107 @@
+"use strict";
+
+function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } }
+
+function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; }
+
+var fs = require('../fs');
+
+var _require = require('path'),
+    join = _require.join;
+
+var Bluebird = require('bluebird');
+/**
+ * Get the size of a folder or a file.
+ *
+ * This function returns the actual file size of the folder (size), not the allocated space on disk (size on disk).
+ * For more details between the difference, check this link:
+ * https://www.howtogeek.com/180369/why-is-there-a-big-difference-between-size-and-size-on-disk/
+ *
+ * @param {string} path path to the file or the folder.
+ */
+
+
+function getSize(_x) {
+  return _getSize.apply(this, arguments);
+}
+
+function _getSize() {
+  _getSize = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee2(path) {
+    var stat, list;
+    return regeneratorRuntime.wrap(function _callee2$(_context2) {
+      while (1) {
+        switch (_context2.prev = _context2.next) {
+          case 0:
+            _context2.next = 2;
+            return fs.lstat(path);
+
+          case 2:
+            stat = _context2.sent;
+
+            if (!stat.isDirectory()) {
+              _context2.next = 8;
+              break;
+            }
+
+            _context2.next = 6;
+            return fs.readdir(path);
+
+          case 6:
+            list = _context2.sent;
+            return _context2.abrupt("return", Bluebird.resolve(list).reduce( /*#__PURE__*/function () {
+              var _ref = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee(prev, curr) {
+                var currPath, s;
+                return regeneratorRuntime.wrap(function _callee$(_context) {
+                  while (1) {
+                    switch (_context.prev = _context.next) {
+                      case 0:
+                        currPath = join(path, curr);
+                        _context.next = 3;
+                        return fs.lstat(currPath);
+
+                      case 3:
+                        s = _context.sent;
+
+                        if (!s.isDirectory()) {
+                          _context.next = 10;
+                          break;
+                        }
+
+                        _context.t0 = prev;
+                        _context.next = 8;
+                        return getSize(currPath);
+
+                      case 8:
+                        _context.t1 = _context.sent;
+                        return _context.abrupt("return", _context.t0 + _context.t1);
+
+                      case 10:
+                        return _context.abrupt("return", prev + s.size);
+
+                      case 11:
+                      case "end":
+                        return _context.stop();
+                    }
+                  }
+                }, _callee);
+              }));
+
+              return function (_x2, _x3) {
+                return _ref.apply(this, arguments);
+              };
+            }(), 0));
+
+          case 8:
+            return _context2.abrupt("return", stat.size);
+
+          case 9:
+          case "end":
+            return _context2.stop();
+        }
+      }
+    }, _callee2);
+  }));
+  return _getSize.apply(this, arguments);
+}
+
+module.exports = getSize;

package/lib/util.js

@@ -239,7 +239,7 @@ var dequote = function dequote(str) {
 };
 
 var parseOpts = function parseOpts(opts) {
-  opts = _.pick(opts, 'browser', 'cachePath', 'cacheList', 'cacheClear', 'ciBuildId', 'config', 'configFile', 'cypressVersion', 'destination', 'detached', 'dev', 'exit', 'env', 'force', 'global', 'group', 'headed', 'headless', 'key', 'path', 'parallel', 'port', 'project', 'quiet', 'reporter', 'reporterOptions', 'record', 'spec', 'tag');
+  opts = _.pick(opts, 'browser', 'cachePath', 'cacheList', 'cacheClear', 'cachePrune', 'ciBuildId', 'config', 'configFile', 'cypressVersion', 'destination', 'detached', 'dev', 'exit', 'env', 'force', 'global', 'group', 'headed', 'headless', 'key', 'path', 'parallel', 'port', 'project', 'quiet', 'reporter', 'reporterOptions', 'record', 'spec', 'tag');
 
   if (opts.exit) {
     opts = _.omit(opts, 'exit');
@@ -307,7 +307,7 @@ var util = {
     } // https://github.com/cypress-io/cypress/issues/5431
 
 
-    var NODE_OPTIONS = "--max-http-header-size=".concat(Math.pow(1024, 2), " --http-parser=legacy");
+    var NODE_OPTIONS = "--max-http-header-size=".concat(Math.pow(1024, 2));
 
     if (_.isString(process.env.NODE_OPTIONS)) {
       return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cypress",
-  "version": "5.3.0",
+  "version": "5.4.0",
   "main": "index.js",
   "scripts": {
     "postinstall": "node index.js --exec install",

package/types/cypress-npm-api.d.ts

@@ -8,6 +8,7 @@
 
 declare namespace CypressCommandLine {
   type HookName = 'before' | 'beforeEach' | 'afterEach' | 'after'
+
   interface TestError {
     name: string
     message: string
@@ -225,7 +226,7 @@ declare namespace CypressCommandLine {
       startedAt: dateTimeISO
       endedAt: dateTimeISO
       duration: ms
-    },
+    }
     /**
      * Reporter name like "spec"
      */
@@ -255,7 +256,7 @@ declare namespace CypressCommandLine {
        * resolved filename of the spec
        */
       absolute: string
-    },
+    }
     shouldUploadVideo: boolean
   }
 
@@ -358,7 +359,7 @@ declare module 'cypress' {
      })
      ```
      */
-    run(options?: Partial<CypressCommandLine.CypressRunOptions>): Promise<CypressCommandLine.CypressRunResult | CypressCommandLine.CypressFailedRunResult>,
+    run(options?: Partial<CypressCommandLine.CypressRunOptions>): Promise<CypressCommandLine.CypressRunResult | CypressCommandLine.CypressFailedRunResult>
     /**
      * Opens Cypress GUI. Resolves with void when the
      * GUI is closed.

package/types/cypress.d.ts

@@ -5295,7 +5295,7 @@ declare namespace Cypress {
 
   type Encodings = 'ascii' | 'base64' | 'binary' | 'hex' | 'latin1' | 'utf8' | 'utf-8' | 'ucs2' | 'ucs-2' | 'utf16le' | 'utf-16le'
   type PositionType = 'topLeft' | 'top' | 'topRight' | 'left' | 'center' | 'right' | 'bottomLeft' | 'bottom' | 'bottomRight'
-  type ViewportPreset = 'macbook-15' | 'macbook-13' | 'macbook-11' | 'ipad-2' | 'ipad-mini' | 'iphone-xr' | 'iphone-x' | 'iphone-6+' | 'iphone-6' | 'iphone-5' | 'iphone-4' | 'iphone-3' | 'samsung-s10' | 'samsung-note9'
+  type ViewportPreset = 'macbook-15' | 'macbook-13' | 'macbook-11' | 'ipad-2' | 'ipad-mini' | 'iphone-xr' | 'iphone-x' | 'iphone-6+' | 'iphone-se2' | 'iphone-8' | 'iphone-7' | 'iphone-6' | 'iphone-5' | 'iphone-4' | 'iphone-3' | 'samsung-s10' | 'samsung-note9'
   interface Offset {
     top: number
     left: number

package/types/mocha/index.d.ts

@@ -1,8 +1,7 @@
-// Type definitions for mocha 5.2
+// Type definitions for mocha 8.0
 // Project: https://mochajs.org
 // Definitions by: Kazi Manzur Rashid <https://github.com/kazimanzurrashid>
 //                 otiai10 <https://github.com/otiai10>
-//                 jt000 <https://github.com/jt000>
 //                 Vadim Macagon <https://github.com/enlight>
 //                 Andrew Bradley <https://github.com/cspotcode>
 //                 Dmitrii Sorin <https://github.com/1999>
@@ -90,13 +89,6 @@ declare class Mocha {
      */
     invert(): this;
 
-    /**
-     * Ignore global leaks.
-     *
-     * @see https://mochajs.org/api/mocha#ignoreLeaks
-     */
-    ignoreLeaks(ignore: boolean): this;
-
     /**
      * Enable global leak checking.
      *
@@ -125,27 +117,6 @@ declare class Mocha {
      */
     globals(globals: string | ReadonlyArray<string>): this;
 
-    /**
-     * Emit color output.
-     *
-     * @see https://mochajs.org/api/mocha#useColors
-     */
-    useColors(colors: boolean): this;
-
-    /**
-     * Use inline diffs rather than +/-.
-     *
-     * @see https://mochajs.org/api/mocha#useInlineDiffs
-     */
-    useInlineDiffs(inlineDiffs: boolean): this;
-
-    /**
-     * Do not show diffs at all.
-     *
-     * @see https://mochajs.org/api/mocha#hideDiff
-     */
-    hideDiff(hideDiff: boolean): this;
-
     /**
      * Set the timeout in milliseconds.
      *
@@ -167,13 +138,6 @@ declare class Mocha {
      */
     slow(slow: string | number): this;
 
-    /**
-     * Enable timeouts.
-     *
-     * @see https://mochajs.org/api/mocha#enableTimeouts
-     */
-    enableTimeouts(enabled?: boolean): this;
-
     /**
      * Makes all tests async (accepting a callback)
      *
@@ -231,12 +195,45 @@ declare class Mocha {
      */
     run(fn?: (failures: number) => void): Mocha.Runner;
 
+    /**
+     * Loads ESM (and CJS) test files asynchronously.
+     *
+     * @see https://mochajs.org/api/mocha#loadFilesAsync
+     */
+    loadFilesAsync(): Promise<void>;
+
     /**
      * Load registered files.
      *
      * @see https://mochajs.org/api/mocha#loadFiles
      */
     protected loadFiles(fn?: () => void): void;
+
+    /**
+     * Unloads `files` from Node's `require` cache.
+     *
+     * This allows required files to be "freshly" reloaded, providing the ability
+     * to reuse a Mocha instance programmatically.
+     * Note: does not clear ESM module files from the cache
+     */
+    unloadFiles(): this;
+
+    /**
+     * Toggles parallel mode.
+     *
+     * Must be run before calling `run`. Changes the `Runner` class to
+     * use; also enables lazy file loading if not already done so.
+     *
+     * @see https://mochajs.org/api/mocha#parallelMode
+     */
+    parallelMode(enabled?: boolean): this;
+
+    /**
+     * Assigns hooks to the root suite.
+     *
+     * @see https://mochajs.org/api/mocha#rootHooks
+     */
+    rootHooks(hooks: Mocha.RootHookObject): this;
 }
 
 declare namespace Mocha {
@@ -684,8 +681,6 @@ declare namespace Mocha {
          */
         class Base {
             constructor(runner: Runner, options?: MochaOptions);
-            /** @deprecated Use the overload that accepts `Mocha.Runner` instead. */
-            constructor(runner: IRunner, options?: MochaOptions);
 
             /**
              * Test run statistics
@@ -974,8 +969,6 @@ declare namespace Mocha {
          */
         class XUnit extends Base {
             constructor(runner: Runner, options?: XUnit.MochaOptions);
-            /** @deprecated Use the overload that accepts `Mocha.Runner` instead. */
-            constructor(runner: IRunner, options?: XUnit.MochaOptions);
 
             /**
              * Override done to close the stream (if it's a file).
@@ -1025,8 +1018,6 @@ declare namespace Mocha {
          */
         class Progress extends Base {
             constructor(runner: Runner, options?: Progress.MochaOptions);
-            /** @deprecated Use the overload that accepts `Mocha.Runner` instead. */
-            constructor(runner: IRunner, options?: Progress.MochaOptions);
         }
 
         namespace Progress {
@@ -1084,7 +1075,6 @@ declare namespace Mocha {
      */
     class Runnable {
         private _slow;
-        private _enableTimeouts;
         private _retries;
         private _currentRetry;
         private _timeout;
@@ -1136,20 +1126,6 @@ declare namespace Mocha {
          */
         slow(ms: string | number): this;
 
-        /**
-         * Get whether timeouts are enabled.
-         *
-         * @see https://mochajs.org/api/Runnable.html#enableTimeouts
-         */
-        enableTimeouts(): boolean;
-
-        /**
-         * Set whether timeouts are enabled.
-         *
-         * @see https://mochajs.org/api/Runnable.html#enableTimeouts
-         */
-        enableTimeouts(enabled: boolean): this;
-
         /**
          * Halt and mark as pending.
          */
@@ -1296,8 +1272,6 @@ declare namespace Mocha {
          * Set the context `Runnable`.
          */
         runnable(runnable: Runnable): this;
-        /** @deprecated Use the overload that accepts `Mocha.Runnable` instead. */
-        runnable(runnable: IRunnable): this;
 
         /**
          * Get test timeout.
@@ -1309,16 +1283,6 @@ declare namespace Mocha {
          */
         timeout(ms: string | number): this;
 
-        /**
-         * Get whether timeouts are enabled.
-         */
-        enableTimeouts(): boolean;
-
-        /**
-         * Set whether timeouts are enabled.
-         */
-        enableTimeouts(enabled: boolean): this;
-
         /**
          * Get test slowness threshold.
          */
@@ -1347,6 +1311,23 @@ declare namespace Mocha {
         [key: string]: any;
     }
 
+    interface RunnerConstants {
+        readonly EVENT_HOOK_BEGIN: 'hook';
+        readonly EVENT_HOOK_END: 'hook end';
+        readonly EVENT_RUN_BEGIN: 'start';
+        readonly EVENT_DELAY_BEGIN: 'waiting';
+        readonly EVENT_DELAY_END: 'ready';
+        readonly EVENT_RUN_END: 'end';
+        readonly EVENT_SUITE_BEGIN: 'suite';
+        readonly EVENT_SUITE_END: 'suite end';
+        readonly EVENT_TEST_BEGIN: 'test';
+        readonly EVENT_TEST_END: 'test end';
+        readonly EVENT_TEST_FAIL: 'fail';
+        readonly EVENT_TEST_PASS: 'pass';
+        readonly EVENT_TEST_PENDING: 'pending';
+        readonly EVENT_TEST_RETRY: 'retry';
+    }
+
     /**
      * Initialize a `Runner` for the given `suite`.
      *
@@ -1362,10 +1343,9 @@ declare namespace Mocha {
         private prevGlobalsLength;
         private nextSuite;
 
-        constructor(suite: Suite, delay: boolean);
+        static readonly constants: RunnerConstants;
 
-        /** @deprecated Use the overload that accepts `Mocha.Suite` instead. */
-        constructor(suite: ISuite, delay: boolean);
+        constructor(suite: Suite, delay: boolean);
 
         suite: Suite;
         started: boolean;
@@ -1376,7 +1356,7 @@ declare namespace Mocha {
         fullStackTrace?: boolean;
         forbidOnly?: boolean;
         forbidPending?: boolean;
-        ignoreLeaks?: boolean;
+        checkLeaks?: boolean;
         test?: Test;
         currentRunnable?: Runnable;
         stats?: Stats; // added by reporters
@@ -1397,9 +1377,6 @@ declare namespace Mocha {
          */
         grepTotal(suite: Suite): number;
 
-        /** @deprecated Use the overload that accepts `Mocha.Suite` instead. */
-        grepTotal(suite: ISuite): number;
-
         /**
          * Gets the allowed globals.
          *
@@ -1683,6 +1660,25 @@ declare namespace Mocha {
     }
     // #endregion Runner untyped events
 
+    interface SuiteConstants {
+        readonly EVENT_FILE_POST_REQUIRE: 'post-require';
+        readonly EVENT_FILE_PRE_REQUIRE: 'pre-require';
+        readonly EVENT_FILE_REQUIRE: 'require';
+        readonly EVENT_ROOT_SUITE_RUN: 'run';
+
+        readonly HOOK_TYPE_AFTER_ALL: 'afterAll';
+        readonly HOOK_TYPE_AFTER_EACH: 'afterEach';
+        readonly HOOK_TYPE_BEFORE_ALL: 'beforeAll';
+        readonly HOOK_TYPE_BEFORE_EACH: 'beforeEach';
+
+        readonly EVENT_SUITE_ADD_HOOK_AFTER_ALL: 'afterAll';
+        readonly EVENT_SUITE_ADD_HOOK_AFTER_EACH: 'afterEach';
+        readonly EVENT_SUITE_ADD_HOOK_BEFORE_ALL: 'beforeAll';
+        readonly EVENT_SUITE_ADD_HOOK_BEFORE_EACH: 'beforeEach';
+        readonly EVENT_SUITE_ADD_SUITE: 'suite';
+        readonly EVENT_SUITE_ADD_TEST: 'test';
+    }
+
     /**
      * Initialize a new `Suite` with the given `title` and `ctx`.
      *
@@ -1694,16 +1690,15 @@ declare namespace Mocha {
         private _afterEach;
         private _afterAll;
         private _timeout;
-        private _enableTimeouts;
         private _slow;
         private _bail;
         private _retries;
         private _onlyTests;
         private _onlySuites;
 
+        static readonly constants: SuiteConstants;
+
         constructor(title: string, parentContext?: Context);
-        /** @deprecated Use the overload that accepts `Mocha.Context` instead. */
-        constructor(title: string, parentContext?: IContext);
 
         ctx: Context;
         suites: Suite[];
@@ -1723,8 +1718,6 @@ declare namespace Mocha {
          * @see https://mochajs.org/api/mocha#.exports.create
          */
         static create(parent: Suite, title: string): Suite;
-        /** @deprecated Use the overload that accepts `Mocha.Suite` instead. */
-        static create(parent: ISuite, title: string): Suite;
 
         /**
          * Return a clone of this `Suite`.
@@ -1761,20 +1754,6 @@ declare namespace Mocha {
          */
         retries(n: string | number): this;
 
-        /**
-         * Get whether timeouts are enabled.
-         *
-         * @see https://mochajs.org/api/Mocha.Suite.html#enableTimeouts
-         */
-        enableTimeouts(): boolean;
-
-        /**
-         * Set whether timeouts are `enabled`.
-         *
-         * @see https://mochajs.org/api/Mocha.Suite.html#enableTimeouts
-         */
-        enableTimeouts(enabled: boolean): this;
-
         /**
          * Get slow `ms`.
          *
@@ -1928,8 +1907,6 @@ declare namespace Mocha {
          * @see https://mochajs.org/api/Mocha.Suite.html#addSuite
          */
         addSuite(suite: Suite): this;
-        /** @deprecated Use the overload that accepts `Mocha.ISuite` instead. */
-        addSuite(suite: ISuite): this;
 
         /**
          * Add a `test` to this suite.
@@ -1937,8 +1914,6 @@ declare namespace Mocha {
          * @see https://mochajs.org/api/Mocha.Suite.html#addTest
          */
         addTest(test: Test): this;
-        /** @deprecated Use the overload that accepts `Mocha.ITest` instead. */
-        addTest(test: ITest): this;
 
         /**
          * Return the full title generated by recursively concatenating the parent's
@@ -2132,6 +2107,37 @@ declare namespace Mocha {
         error(err: any): void;
     }
 
+    /**
+     * An alternative way to define root hooks that works with parallel runs.
+     *
+     * Root hooks work with any interface, but the property names do not change.
+     * In other words, if you are using the tdd interface, suiteSetup maps to beforeAll, and setup maps to beforeEach.
+     *
+     * As with other hooks, `this` refers to to the current context object.
+     *
+     * @see https://mochajs.org/#root-hook-plugins
+     */
+    interface RootHookObject {
+      /**
+       * In serial mode, run after all tests end, once only.
+       * In parallel mode, run after all tests end, for each file.
+       */
+      afterAll?: Func | AsyncFunc | Func[] | AsyncFunc[];
+      /**
+       * In serial mode (Mocha's default), before all tests begin, once only.
+       * In parallel mode, run before all tests begin, for each file.
+       */
+      beforeAll?: Func | AsyncFunc | Func[] | AsyncFunc[];
+      /**
+       * In both modes, run after every test.
+       */
+      afterEach?: Func | AsyncFunc | Func[] | AsyncFunc[];
+      /**
+       * In both modes, run before each test.
+       */
+      beforeEach?: Func | AsyncFunc | Func[] | AsyncFunc[];
+    }
+
     /**
      * Initialize a new `Test` with the given `title` and callback `fn`.
      *
@@ -2195,10 +2201,8 @@ declare namespace Mocha {
         /** Array of accepted globals. */
         globals?: string[];
 
-        /** timeout in milliseconds. */
-        timeout?: number;
-
-        enableTimeouts?: boolean;
+        /** timeout in milliseconds or time string like '1s'. */
+        timeout?: number | string;
 
         /** number of times to retry failed tests. */
         retries?: number;
@@ -2209,8 +2213,8 @@ declare namespace Mocha {
         /** milliseconds to wait before considering a test slow. */
         slow?: number;
 
-        /** ignore global leaks. */
-        ignoreLeaks?: boolean;
+        /** check for global variable leaks. */
+        checkLeaks?: boolean;
 
         /** display the full stack trace on failure. */
         fullStackTrace?: boolean;
@@ -2221,8 +2225,8 @@ declare namespace Mocha {
         /** Enable growl support. */
         growl?: boolean;
 
-        /** Emit color output. */
-        useColors?: boolean;
+        /** Color TTY output from reporter */
+        color?: boolean;
 
         /** Use inline diffs rather than +/-. */
         inlineDiffs?: boolean;
@@ -2230,12 +2234,22 @@ declare namespace Mocha {
         /** Do not show diffs at all. */
         hideDiff?: boolean;
 
+        /** Run job in parallel */
+        parallel?: boolean;
+
+        /** Max number of worker processes for parallel runs */
+        jobs?: number;
+
+        /** Assigns hooks to the root suite */
+        rootHooks?: RootHookObject;
+
         asyncOnly?: boolean;
         delay?: boolean;
         forbidOnly?: boolean;
         forbidPending?: boolean;
         noHighlighting?: boolean;
         allowUncaught?: boolean;
+        fullTrace?: boolean;
     }
 
     interface MochaInstanceOptions extends MochaOptions {
@@ -2440,186 +2454,6 @@ declare namespace Mocha {
     }
 
     type Interface = keyof InterfaceContributions;
-
-    // #region Deprecations
-
-    /** @deprecated use `Mocha.Context` instead. */
-    interface IContext {
-        test?: IRunnable;
-        runnable(): IRunnable | undefined;
-        /** @deprecated `.runnable()` returns `this` in `Mocha.Context`. */
-        runnable(runnable: IRunnable): IContext;
-        timeout(): number;
-        /** @deprecated `.timeout()` returns `this` in `Mocha.Context`. */
-        timeout(timeout: number): IContext;
-        /** @deprecated `.enableTimeouts()` has additional overloads in `Mocha.Context`. */
-        /** @deprecated `.enableTimeouts()` returns `this` in `Mocha.Context`. */
-        enableTimeouts(enableTimeouts: boolean): IContext;
-        /** @deprecated `.slow()` has additional overloads in `Mocha.Context`. */
-        /** @deprecated `.slow()` returns `this` in `Mocha.Context`. */
-        slow(slow: number): IContext;
-        /** @deprecated `.skip()` returns `never` in `Mocha.Context`. */
-        skip(): IContext;
-        retries(): number;
-        /** @deprecated `.retries()` returns `this` in `Mocha.Context`. */
-        retries(retries: number): IContext;
-    }
-
-    /** @deprecated use `Mocha.Suite` instead. */
-    interface ISuiteCallbackContext {
-        /** @deprecated `.timeout()` has additional overloads in `Mocha.Suite`. */
-        timeout(ms: number | string): this;
-        /** @deprecated `.retries()` has additional overloads in `Mocha.Suite`. */
-        retries(n: number): this;
-        /** @deprecated `.slow()` has additional overloads in `Mocha.Suite`. */
-        slow(ms: number): this;
-    }
-
-    /** @deprecated use `Mocha.Context` instead. */
-    interface IHookCallbackContext {
-        /** @deprecated `.skip()` returns `never` in `Mocha.Context`. */
-        skip(): this;
-        /** @deprecated `.timeout()` has additional overloads in `Mocha.Context`. */
-        timeout(ms: number | string): this;
-        [index: string]: any;
-    }
-
-    /** @deprecated use `Mocha.Context` instead. */
-    interface ITestCallbackContext {
-        /** @deprecated `.skip()` returns `never` in `Mocha.Context`. */
-        skip(): this;
-        /** @deprecated `.timeout()` has additional overloads in `Mocha.Context`. */
-        timeout(ms: number | string): this;
-        /** @deprecated `.retries()` has additional overloads in `Mocha.Context`. */
-        retries(n: number): this;
-        /** @deprecated `.slow()` has additional overloads in `Mocha.Context`. */
-        slow(ms: number): this;
-        [index: string]: any;
-    }
-
-    /** Partial interface for Mocha's `Runnable` class. */
-    /** @deprecated use `Mocha.Runnable` instead. */
-    interface IRunnable extends NodeJS.EventEmitter {
-        title: string;
-        /** @deprecated `.fn` has type `Func | AsyncFunc` in `Mocha.Runnable`. */
-        fn: Function | undefined;
-        async: boolean;
-        sync: boolean;
-        timedOut: boolean;
-        /** @deprecated `.timeout()` has additional overloads in `Mocha.Runnable`. */
-        timeout(n: number | string): this;
-        duration?: number;
-    }
-
-    /** Partial interface for Mocha's `Suite` class. */
-    /** @deprecated use `Mocha.Suite` instead. */
-    interface ISuite {
-        /** @deprecated `.ctx` has type `Mocha.Context` in `Mocha.Suite`. */
-        ctx: IContext;
-        /** @deprecated `.parent` has type `Mocha.Suite | undefined` in `Mocha.Suite`. */
-        parent: ISuite | undefined;
-        root: boolean;
-        title: string;
-        /** @deprecated `.suites` has type `Mocha.Suite[]` in `Mocha.Suite`. */
-        suites: ISuite[];
-        /** @deprecated `.tests` has type `Mocha.Test[]` in `Mocha.Suite`. */
-        tests: ITest[];
-
-        bail(): boolean;
-        /** @deprecated `.bail()` returns `this` in `Mocha.Suite`. */
-        bail(bail: boolean): ISuite;
-        fullTitle(): string;
-        retries(): number;
-        /** @deprecated `.retries()` returns `this` in `Mocha.Suite`. */
-        retries(retries: number): ISuite;
-        slow(): number;
-        /** @deprecated `.slow()` returns `this` in `Mocha.Suite`. */
-        slow(slow: number): ISuite;
-        timeout(): number;
-        /** @deprecated `.timeout()` returns `this` in `Mocha.Suite`. */
-        timeout(timeout: number): ISuite;
-    }
-
-    /** Partial interface for Mocha's `Test` class. */
-    /** @deprecated use `Mocha.Test` instead. */
-    interface ITest extends IRunnable {
-        body?: string;
-        file?: string;
-        /** @deprecated `.parent` has type `Mocha.Suite | undefined` in `Mocha.Test`. */
-        parent?: ISuite;
-        pending: boolean;
-        state?: 'failed' | 'passed';
-        type: 'test';
-        fullTitle(): string;
-    }
-
-    /** @deprecated use `Mocha.Hook` instead. */
-    interface IHook extends IRunnable {
-        /** @deprecated `.ctx` has type `Mocha.Context` in `Mocha.Runnable`. */
-        ctx?: IContext;
-        /** @deprecated `.parent` has type `Mocha.Suite` in `Mocha.Runnable`. */
-        parent?: ISuite;
-        type: 'hook';
-        /** @deprecated `.error()` has additional overloads in `Mocha.Hook`. */
-        error(err: Error): void;
-    }
-
-    /** @deprecated use `Mocha.Context` instead. */
-    interface IBeforeAndAfterContext extends IHookCallbackContext {
-        /** @deprecated `.currentTest` has type `Mocha.Test` in `Mocha.Context`. */
-        currentTest?: ITest;
-    }
-
-    /** @deprecated use `Mocha.Stats` instead. */
-    type IStats = Stats;
-
-    /** Partial interface for Mocha's `Runner` class. */
-    /** @deprecated use `Mocha.Runner` instead. */
-    interface IRunner extends NodeJS.EventEmitter {
-        asyncOnly?: boolean;
-        stats?: IStats;
-        started: boolean;
-        /** @deprecated `.suite` has type `Mocha.Suite` in `Mocha.Runner`. */
-        suite: ISuite;
-        total: number;
-        failures: number;
-        forbidOnly?: boolean;
-        forbidPending?: boolean;
-        fullStackTrace?: boolean;
-        ignoreLeaks?: boolean;
-        grep(re: RegExp, invert: boolean): this;
-        /** @deprecated Parameter `suite` has type `Mocha.Suite` in `Mocha.Runner`. */
-        grepTotal(suite: ISuite): number;
-        /** @deprecated `.globals()` has different overloads in `Mocha.Runner`. */
-        globals(arr: ReadonlyArray<string>): this | string[];
-        abort(): this;
-        run(fn?: (failures: number) => void): this;
-    }
-
-    /** @deprecated use `Mocha.SuiteFunction` instead. */
-    interface IContextDefinition {
-        /** @deprecated use `Mocha.SuiteFunction` instead. */
-        (description: string, callback: (this: ISuiteCallbackContext) => void): ISuite;
-        /** @deprecated use `Mocha.SuiteFunction` instead. */
-        only(description: string, callback: (this: ISuiteCallbackContext) => void): ISuite;
-        /** @deprecated use `Mocha.SuiteFunction` instead. */
-        skip(description: string, callback: (this: ISuiteCallbackContext) => void): void;
-    }
-
-    /** @deprecated use `Mocha.TestFunction` instead. */
-    interface ITestDefinition {
-        /** @deprecated use `Mocha.TestFunction` instead. */
-        /** @deprecated `Mocha.TestFunction` does not allow mixing `done` with a return type of `PromiseLike<any>`. */
-        (expectation: string, callback?: (this: ITestCallbackContext, done: MochaDone) => PromiseLike<any> | void): ITest;
-        /** @deprecated use `Mocha.TestFunction` instead. */
-        /** @deprecated `Mocha.TestFunction#only` does not allow mixing `done` with a return type of `PromiseLike<any>`. */
-        only(expectation: string, callback?: (this: ITestCallbackContext, done: MochaDone) => PromiseLike<any> | void): ITest;
-        /** @deprecated use `Mocha.TestFunction` instead. */
-        /** @deprecated `Mocha.TestFunction#skip` does not allow mixing `done` with a return type of `PromiseLike<any>`. */
-        skip(expectation: string, callback?: (this: ITestCallbackContext, done: MochaDone) => PromiseLike<any> | void): void;
-    }
-
-    // #endregion
 }
 
 // #region Test interface augmentations
@@ -2828,30 +2662,11 @@ interface BrowserMocha extends Mocha {
      *
      * - _Only supported in the browser._
      */
-    setup(opts?: Mocha.Interface | MochaSetupOptions): this;
-}
-
-/**
- * Options to pass to `mocha.setup` in the browser.
- */
-interface MochaSetupOptions extends Mocha.MochaOptions {
-    /** @deprecated This is not used by Mocha. Use `files` instead. */
-    require?: string[];
-    fullTrace?: boolean;
+    setup(opts?: Mocha.Interface | Mocha.MochaOptions): this;
 }
 
 // #endregion Browser augmentations
 
-// #region Deprecations
-
-/** @deprecated use `Mocha.Done` instead. */
-type MochaDone = Mocha.Done;
-
-/** @deprecated use `Mocha.ReporterConstructor` instead. */
-type ReporterConstructor = Mocha.ReporterConstructor;
-
-// #endregion Deprecations
-
 declare module "mocha" {
     export = Mocha;
 }

package/types/net-stubbing.ts

@@ -3,7 +3,6 @@
  */
 export namespace CyHttpMessages {
   interface BaseMessage {
-    // as much stuff from `incomingmessage` as makes sense to serialize and send
     body?: any
     headers: { [key: string]: string }
     url: string
@@ -47,11 +46,31 @@ export namespace CyHttpMessages {
   }
 
   export interface IncomingHttpRequest extends IncomingRequest {
+    /**
+     * Destroy the request and respond with a network error.
+     */
     destroy(): void
+    /**
+     * Control the response to this request.
+     * If a function is passed, the request will be sent outgoing, and the function will be called
+     * with the response from the upstream server.
+     * If a `StaticResponse` is passed, it will be used as the response, and no request will be made
+     * to the upstream server.
+     */
     reply(interceptor?: StaticResponse | HttpResponseInterceptor): void
+    /**
+     * Shortcut to reply to the request with a body and optional headers.
+     */
     reply(body: string | object, headers?: { [key: string]: string }): void
+    /**
+     * Shortcut to reply to the request with an HTTP status code and optional body and headers.
+     */
     reply(status: number, body?: string | object, headers?: { [key: string]: string }): void
-    redirect(location: string, statusCode: number): void
+    /**
+     * Respond to this request with a redirect to a new `location`.
+     * @param statusCode HTTP status code to redirect with. Default: 302
+     */
+    redirect(location: string, statusCode?: number): void
   }
 }
 
@@ -64,9 +83,19 @@ export interface DictMatcher<T> {
  */
 export type GlobPattern = string
 
+/**
+ * Interceptor for an HTTP request. If a Promise is returned, it will be awaited before passing the
+ * request to the next handler (if there is one), otherwise the request will be passed to the next
+ * handler synchronously.
+ */
 export type HttpRequestInterceptor = (req: CyHttpMessages.IncomingHttpRequest) => void | Promise<void>
 
-export type HttpResponseInterceptor = (res: CyHttpMessages.IncomingHttpResponse, send?: () => void) => void | Promise<void>
+/**
+ * Interceptor for an HTTP response. If a Promise is returned, it will be awaited before passing the
+ * request to the next handler (if there is one), otherwise the request will be passed to the next
+ * handler synchronously.
+ */
+export type HttpResponseInterceptor = (res: CyHttpMessages.IncomingHttpResponse) => void | Promise<void>
 
 /**
  * Matches a single number or any of an array of acceptable numbers.
@@ -130,22 +159,24 @@ export type RouteMatcherOptions = RouteMatcherOptionsGeneric<StringMatcher>
 
 export interface RouteMatcherOptionsGeneric<S> extends RouteMatcherCompatOptions {
   /**
-   * Match HTTP basic authentication.
+   * Match against the username and password used in HTTP Basic authentication.
    */
   auth?: { username: S, password: S }
   /**
-   * Match client request headers.
+   * Match against HTTP headers on the request.
    */
   headers?: DictMatcher<S>
   /**
-   * Match based on requested hostname.
+   * Match against the requested HTTP hostname.
    */
   hostname?: S
   /**
-   * Match requests served via HTTPS only.
+   * If 'true', only HTTPS requests will be matched.
+   * If 'false', only HTTP requests will be matched.
    */
   https?: boolean
   /**
+   * Match against the request's HTTP method.
    * @default 'GET'
    */
   method?: S
@@ -158,7 +189,8 @@ export interface RouteMatcherOptionsGeneric<S> extends RouteMatcherCompatOptions
    */
   pathname?: S
   /**
-   * Match based on requested port.
+   * Match based on requested port, or pass an array of ports
+   * to match against any in that array.
    */
   port?: NumberMatcher
   /**
@@ -166,7 +198,9 @@ export interface RouteMatcherOptionsGeneric<S> extends RouteMatcherCompatOptions
    */
   query?: DictMatcher<S>
   /**
-   * Match based on full request URL.
+   * Match against the full request URL.
+   * If a string is passed, it will be used as a substring match,
+   * not an equality match.
    */
   url?: S
 }
@@ -180,34 +214,38 @@ export type RouteHandler = string | StaticResponse | RouteHandlerController | ob
  */
 export type StaticResponse = GenericStaticResponse<string, string | object> & {
   /**
-  * If set, `delayMs` will pass before the response is sent.
-  */
+   * Milliseconds to delay before the response is sent.
+   */
  delayMs?: number
 }
 
 export interface GenericStaticResponse<Fixture, Body> {
   /**
-   * If set, serve a fixture as the response body.
+   * Serve a fixture as the response body.
    */
   fixture?: Fixture
   /**
-   * If set, serve a static string/JSON object as the response body.
+   * Serve a static string/JSON object as the response body.
    */
   body?: Body
   /**
+   * HTTP headers to accompany the response.
    * @default {}
    */
   headers?: { [key: string]: string }
   /**
+   * The HTTP status code to send.
    * @default 200
    */
   statusCode?: number
   /**
-   * If `forceNetworkError` is truthy, Cypress will destroy the connection to the browser and send no response. Useful for simulating a server that is not reachable. Must not be set in combination with other options.
+   * If 'forceNetworkError' is truthy, Cypress will destroy the browser connection
+   * and send no response. Useful for simulating a server that is not reachable.
+   * Must not be set in combination with other options.
    */
   forceNetworkError?: boolean
   /**
-   * If set, the `body` will be sent at `throttleKbps` kbps.
+   * Kilobits per second to send 'body'.
    */
   throttleKbps?: number
 }