mocha 7.0.0-esm1 → 7.0.0

package/CHANGELOG.md

@@ -1,24 +1,3 @@
-# 7.0.0-esm1 / 2020-01-12
-
-**This is an experimental release** based on v7.0.0: `npm i mocha@7.0.0-esm1`
-
-## :tada: Enhancements
-
-[#4038](https://github.com/mochajs/mocha/issues/4038): Add Node.js native ESM support ([**@giltayar**](https://github.com/giltayar))
-
-Enables Mocha to load ECMAScript Modules test files, also valid for `--file` option.
-
-Limitations:
-
-- Node.js only v12.11.0 and above
-- Node.js below v13.2.0, you must set `--experimental-modules` option
-- ESM not (yet) supported for:
-  - `--watch` mode
-  - `--require` option
-  - `--reporter` custom reporters
-  - `--ui` custom interfaces
-  - `mocharc` configuration file
-
 # 7.0.0 / 2020-01-05
 
 ## :boom: Breaking Changes

package/lib/cli/config.js

@@ -21,7 +21,6 @@ const findUp = require('find-up');
  * @private
  */
 exports.CONFIG_FILES = [
-  '.mocharc.cjs',
   '.mocharc.js',
   '.mocharc.yaml',
   '.mocharc.yml',
@@ -76,7 +75,7 @@ exports.loadConfig = filepath => {
   try {
     if (ext === '.yml' || ext === '.yaml') {
       config = parsers.yaml(filepath);
-    } else if (ext === '.js' || ext === '.cjs') {
+    } else if (ext === '.js') {
       config = parsers.js(filepath);
     } else {
       config = parsers.json(filepath);

package/lib/cli/options.js

@@ -265,7 +265,7 @@ module.exports.loadPkgRc = loadPkgRc;
  * Priority list:
  *
  * 1. Command-line args
- * 2. RC file (`.mocharc.c?js`, `.mocharc.ya?ml`, `mocharc.json`)
+ * 2. RC file (`.mocharc.js`, `.mocharc.ya?ml`, `mocharc.json`)
  * 3. `mocha` prop of `package.json`
  * 4. `mocha.opts`
  * 5. default configuration (`lib/mocharc.json`)

package/lib/cli/run-helpers.js

@@ -98,21 +98,14 @@ exports.handleRequires = (requires = []) => {
  * @param {boolean} [opts.exit] - Whether or not to force-exit after tests are complete
  * @param {Object} fileCollectParams - Parameters that control test
  *   file collection. See `lib/cli/collect-files.js`.
- * @returns {Promise<Runner>}
+ * @returns {Runner}
  * @private
  */
 exports.singleRun = (mocha, {exit}, fileCollectParams) => {
   const files = collectFiles(fileCollectParams);
   debug('running tests with files', files);
   mocha.files = files;
-
-  return mocha.runAsync().then(exitCode => {
-    if (exit) {
-      exitMocha(exitCode);
-    } else {
-      exitMochaLater(exitCode);
-    }
-  });
+  return mocha.run(exit ? exitMocha : exitMochaLater);
 };
 
 /**
@@ -120,7 +113,6 @@ exports.singleRun = (mocha, {exit}, fileCollectParams) => {
  * @param {Mocha} mocha - Mocha instance
  * @param {Object} opts - Command line options
  * @private
- * @returns {Promise}
  */
 exports.runMocha = (mocha, options) => {
   const {
@@ -148,7 +140,7 @@ exports.runMocha = (mocha, options) => {
   if (watch) {
     watchRun(mocha, {watchFiles, watchIgnore}, fileCollectParams);
   } else {
-    return exports.singleRun(mocha, {exit}, fileCollectParams);
+    exports.singleRun(mocha, {exit}, fileCollectParams);
   }
 };
 

package/lib/cli/run.js

@@ -299,14 +299,8 @@ exports.builder = yargs =>
     .number(types.number)
     .alias(aliases);
 
-exports.handler = async function(argv) {
+exports.handler = argv => {
   debug('post-yargs config', argv);
   const mocha = new Mocha(argv);
-
-  try {
-    await runMocha(mocha, argv);
-  } catch (err) {
-    console.error(err.stack || `Error: ${err.message || err}`);
-    process.exit(1);
-  }
+  runMocha(mocha, argv);
 };

package/lib/mocha.js

@@ -14,7 +14,6 @@ var utils = require('./utils');
 var mocharc = require('./mocharc.json');
 var errors = require('./errors');
 var Suite = require('./suite');
-var esmUtils = utils.supportsEsModules() ? require('./esm-utils') : undefined;
 var createStatsCollector = require('./stats-collector');
 var createInvalidReporterError = errors.createInvalidReporterError;
 var createInvalidInterfaceError = errors.createInvalidInterfaceError;
@@ -288,18 +287,16 @@ Mocha.prototype.ui = function(ui) {
 };
 
 /**
- * Loads `files` prior to execution. Does not support ES Modules.
+ * Loads `files` prior to execution.
  *
  * @description
  * The implementation relies on Node's `require` to execute
  * the test interface functions and will be subject to its cache.
- * Supports only CommonJS modules. To load ES modules, use Mocha#loadFilesAsync.
  *
  * @private
  * @see {@link Mocha#addFile}
  * @see {@link Mocha#run}
  * @see {@link Mocha#unloadFiles}
- * @see {@link Mocha#loadFilesAsync}
  * @param {Function} [fn] - Callback invoked upon completion.
  */
 Mocha.prototype.loadFiles = function(fn) {
@@ -314,43 +311,6 @@ Mocha.prototype.loadFiles = function(fn) {
   fn && fn();
 };
 
-/**
- * Loads `files` prior to execution. Supports Node ES Modules.
- *
- * @description
- * The implementation relies on Node's `require` and `import` to execute
- * the test interface functions and will be subject to its cache.
- * Supports both CJS and ESM modules.
- *
- * @private
- * @see {@link Mocha#addFile}
- * @see {@link Mocha#run}
- * @see {@link Mocha#unloadFiles}
- *
- * @returns {Promise}
- */
-Mocha.prototype.loadFilesAsync = function() {
-  var self = this;
-  var suite = this.suite;
-
-  if (!esmUtils) {
-    return new Promise(function(resolve) {
-      self.loadFiles(resolve);
-    });
-  }
-
-  return esmUtils.loadFilesAsync(
-    this.files,
-    function(file) {
-      suite.emit(EVENT_FILE_PRE_REQUIRE, global, file, self);
-    },
-    function(file, resultModule) {
-      suite.emit(EVENT_FILE_REQUIRE, resultModule, file, self);
-      suite.emit(EVENT_FILE_POST_REQUIRE, global, file, self);
-    }
-  );
-};
-
 /**
  * Removes a previously loaded file from Node's `require` cache.
  *
@@ -875,11 +835,7 @@ Object.defineProperty(Mocha.prototype, 'version', {
  * already in the `require` cache), make sure to clear them from
  * the cache first!
  *
- * This method supports only CommonJS test files, and not ES modules ones.
- * To use ES module (and CommonJS) test files, call Mocha#runAsync instead.
- *
  * @public
- * @see {@link Mocha#runAsync}
  * @see {@link Mocha#unloadFiles}
  * @see {@link Runner#run}
  * @param {DoneCB} [fn] - Callback invoked when test execution completed.
@@ -889,17 +845,12 @@ Mocha.prototype.run = function(fn) {
   if (this.files.length) {
     this.loadFiles();
   }
-  return this._startRunning(fn);
-};
-
-Mocha.prototype._startRunning = function(fn) {
-  var self = this;
-  var suite = self.suite;
-  var options = self.options;
-  options.files = self.files;
+  var suite = this.suite;
+  var options = this.options;
+  options.files = this.files;
   var runner = new exports.Runner(suite, options.delay);
   createStatsCollector(runner);
-  var reporter = new self._reporter(runner, options);
+  var reporter = new this._reporter(runner, options);
   runner.checkLeaks = options.checkLeaks === true;
   runner.fullStackTrace = options.fullTrace;
   runner.asyncOnly = options.asyncOnly;
@@ -913,7 +864,7 @@ Mocha.prototype._startRunning = function(fn) {
     runner.globals(options.global);
   }
   if (options.growl) {
-    self._growl(runner);
+    this._growl(runner);
   }
   if (options.color !== undefined) {
     exports.reporters.Base.useColors = options.color;
@@ -932,33 +883,3 @@ Mocha.prototype._startRunning = function(fn) {
 
   return runner.run(done);
 };
-
-/**
- * Runs root suite and invokes `fn()` when complete. Supports ES Modules.
- *
- * @description
- * To run tests multiple times (or to run tests in files that are
- * already in the `require` cache), make sure to clear them from
- * the cache first!
- *
- * This method supports both ES Modules and CommonJS test files.
- *
- * @public
- * @see {@link Mocha#unloadFiles}
- * @see {@link Runner#run}
- * @return {Promise<Runner>} runner instance
- */
-Mocha.prototype.runAsync = function() {
-  var loadResult = this.files.length
-    ? this.loadFilesAsync()
-    : Promise.resolve();
-
-  var self = this;
-  return loadResult.then(function() {
-    return new Promise(function(resolve) {
-      self._startRunning(function(result) {
-        resolve(result);
-      });
-    });
-  });
-};

package/lib/mocharc.json

@@ -1,6 +1,6 @@
 {
   "diff": true,
-  "extension": ["js", "cjs", "mjs"],
+  "extension": ["js"],
   "opts": "./test/mocha.opts",
   "package": "./package.json",
   "reporter": "spec",

package/lib/utils.js

@@ -831,46 +831,3 @@ exports.defineConstants = function(obj) {
   }
   return Object.freeze(exports.createMap(obj));
 };
-
-/**
- * Whether current version of Node support ES modules
- *
- * @description
- * Versions prior to 10 did not support ES Modules, and version 10 has an old incompatibile version of ESM.
- * This function returns whether Node.JS has ES Module supports that is compatible with Mocha's needs,
- * which is version 12 and older
- *
- * @param {Boolean} unflagged whether the support is unflagged (`true`) or only using the `--experimental-modules` flag (`false`)
- * @returns {Boolean} whether the current version of Node.JS supports ES Modules in a way that is compatbile with Mocha
- */
-exports.supportsEsModules = function(unflagged) {
-  if (typeof document !== 'undefined') {
-    return false;
-  }
-  if (
-    typeof process !== 'object' ||
-    !process.versions ||
-    !process.versions.node
-  ) {
-    return false;
-  }
-  var versionFields = process.versions.node.split('.');
-  var major = +versionFields[0];
-  var minor = +versionFields[1];
-
-  if (major >= 13) {
-    if (unflagged) {
-      return minor >= 2;
-    }
-    return true;
-  }
-  if (unflagged) {
-    return false;
-  }
-  if (major < 12) {
-    return false;
-  }
-  // major === 12
-
-  return minor >= 11;
-};

package/mocha.js

@@ -1408,7 +1408,6 @@ var utils = require('./utils');
 var mocharc = require('./mocharc.json');
 var errors = require('./errors');
 var Suite = require('./suite');
-var esmUtils = utils.supportsEsModules() ? require('./esm-utils') : undefined;
 var createStatsCollector = require('./stats-collector');
 var createInvalidReporterError = errors.createInvalidReporterError;
 var createInvalidInterfaceError = errors.createInvalidInterfaceError;
@@ -1682,18 +1681,16 @@ Mocha.prototype.ui = function(ui) {
 };
 
 /**
- * Loads `files` prior to execution. Does not support ES Modules.
+ * Loads `files` prior to execution.
  *
  * @description
  * The implementation relies on Node's `require` to execute
  * the test interface functions and will be subject to its cache.
- * Supports only CommonJS modules. To load ES modules, use Mocha#loadFilesAsync.
  *
  * @private
  * @see {@link Mocha#addFile}
  * @see {@link Mocha#run}
  * @see {@link Mocha#unloadFiles}
- * @see {@link Mocha#loadFilesAsync}
  * @param {Function} [fn] - Callback invoked upon completion.
  */
 Mocha.prototype.loadFiles = function(fn) {
@@ -1708,43 +1705,6 @@ Mocha.prototype.loadFiles = function(fn) {
   fn && fn();
 };
 
-/**
- * Loads `files` prior to execution. Supports Node ES Modules.
- *
- * @description
- * The implementation relies on Node's `require` and `import` to execute
- * the test interface functions and will be subject to its cache.
- * Supports both CJS and ESM modules.
- *
- * @private
- * @see {@link Mocha#addFile}
- * @see {@link Mocha#run}
- * @see {@link Mocha#unloadFiles}
- *
- * @returns {Promise}
- */
-Mocha.prototype.loadFilesAsync = function() {
-  var self = this;
-  var suite = this.suite;
-
-  if (!esmUtils) {
-    return new Promise(function(resolve) {
-      self.loadFiles(resolve);
-    });
-  }
-
-  return esmUtils.loadFilesAsync(
-    this.files,
-    function(file) {
-      suite.emit(EVENT_FILE_PRE_REQUIRE, global, file, self);
-    },
-    function(file, resultModule) {
-      suite.emit(EVENT_FILE_REQUIRE, resultModule, file, self);
-      suite.emit(EVENT_FILE_POST_REQUIRE, global, file, self);
-    }
-  );
-};
-
 /**
  * Removes a previously loaded file from Node's `require` cache.
  *
@@ -2269,11 +2229,7 @@ Object.defineProperty(Mocha.prototype, 'version', {
  * already in the `require` cache), make sure to clear them from
  * the cache first!
  *
- * This method supports only CommonJS test files, and not ES modules ones.
- * To use ES module (and CommonJS) test files, call Mocha#runAsync instead.
- *
  * @public
- * @see {@link Mocha#runAsync}
  * @see {@link Mocha#unloadFiles}
  * @see {@link Runner#run}
  * @param {DoneCB} [fn] - Callback invoked when test execution completed.
@@ -2283,17 +2239,12 @@ Mocha.prototype.run = function(fn) {
   if (this.files.length) {
     this.loadFiles();
   }
-  return this._startRunning(fn);
-};
-
-Mocha.prototype._startRunning = function(fn) {
-  var self = this;
-  var suite = self.suite;
-  var options = self.options;
-  options.files = self.files;
+  var suite = this.suite;
+  var options = this.options;
+  options.files = this.files;
   var runner = new exports.Runner(suite, options.delay);
   createStatsCollector(runner);
-  var reporter = new self._reporter(runner, options);
+  var reporter = new this._reporter(runner, options);
   runner.checkLeaks = options.checkLeaks === true;
   runner.fullStackTrace = options.fullTrace;
   runner.asyncOnly = options.asyncOnly;
@@ -2307,7 +2258,7 @@ Mocha.prototype._startRunning = function(fn) {
     runner.globals(options.global);
   }
   if (options.growl) {
-    self._growl(runner);
+    this._growl(runner);
   }
   if (options.color !== undefined) {
     exports.reporters.Base.useColors = options.color;
@@ -2327,41 +2278,11 @@ Mocha.prototype._startRunning = function(fn) {
   return runner.run(done);
 };
 
-/**
- * Runs root suite and invokes `fn()` when complete. Supports ES Modules.
- *
- * @description
- * To run tests multiple times (or to run tests in files that are
- * already in the `require` cache), make sure to clear them from
- * the cache first!
- *
- * This method supports both ES Modules and CommonJS test files.
- *
- * @public
- * @see {@link Mocha#unloadFiles}
- * @see {@link Runner#run}
- * @return {Promise<Runner>} runner instance
- */
-Mocha.prototype.runAsync = function() {
-  var loadResult = this.files.length
-    ? this.loadFilesAsync()
-    : Promise.resolve();
-
-  var self = this;
-  return loadResult.then(function() {
-    return new Promise(function(resolve) {
-      self._startRunning(function(result) {
-        resolve(result);
-      });
-    });
-  });
-};
-
 }).call(this,require('_process'),typeof global !== "undefined" ? global : typeof self !== "undefined" ? self : typeof window !== "undefined" ? window : {})
-},{"../package.json":90,"./context":5,"./errors":6,"./esm-utils":42,"./growl":2,"./hook":7,"./interfaces":11,"./mocharc.json":15,"./reporters":21,"./runnable":33,"./runner":34,"./stats-collector":35,"./suite":36,"./test":37,"./utils":38,"_process":69,"escape-string-regexp":49,"path":42}],15:[function(require,module,exports){
+},{"../package.json":90,"./context":5,"./errors":6,"./growl":2,"./hook":7,"./interfaces":11,"./mocharc.json":15,"./reporters":21,"./runnable":33,"./runner":34,"./stats-collector":35,"./suite":36,"./test":37,"./utils":38,"_process":69,"escape-string-regexp":49,"path":42}],15:[function(require,module,exports){
 module.exports={
   "diff": true,
-  "extension": ["js", "cjs", "mjs"],
+  "extension": ["js"],
   "opts": "./test/mocha.opts",
   "package": "./package.json",
   "reporter": "spec",
@@ -8288,49 +8209,6 @@ exports.defineConstants = function(obj) {
   return Object.freeze(exports.createMap(obj));
 };
 
-/**
- * Whether current version of Node support ES modules
- *
- * @description
- * Versions prior to 10 did not support ES Modules, and version 10 has an old incompatibile version of ESM.
- * This function returns whether Node.JS has ES Module supports that is compatible with Mocha's needs,
- * which is version 12 and older
- *
- * @param {Boolean} unflagged whether the support is unflagged (`true`) or only using the `--experimental-modules` flag (`false`)
- * @returns {Boolean} whether the current version of Node.JS supports ES Modules in a way that is compatbile with Mocha
- */
-exports.supportsEsModules = function(unflagged) {
-  if (typeof document !== 'undefined') {
-    return false;
-  }
-  if (
-    typeof process !== 'object' ||
-    !process.versions ||
-    !process.versions.node
-  ) {
-    return false;
-  }
-  var versionFields = process.versions.node.split('.');
-  var major = +versionFields[0];
-  var minor = +versionFields[1];
-
-  if (major >= 13) {
-    if (unflagged) {
-      return minor >= 2;
-    }
-    return true;
-  }
-  if (unflagged) {
-    return false;
-  }
-  if (major < 12) {
-    return false;
-  }
-  // major === 12
-
-  return minor >= 11;
-};
-
 }).call(this,require('_process'),require("buffer").Buffer)
 },{"./errors":6,"_process":69,"buffer":43,"fs":42,"glob":42,"he":54,"object.assign":65,"path":42,"util":89}],39:[function(require,module,exports){
 'use strict'
@@ -18212,7 +18090,7 @@ function hasOwnProperty(obj, prop) {
 },{"./support/isBuffer":88,"_process":69,"inherits":56}],90:[function(require,module,exports){
 module.exports={
   "name": "mocha",
-  "version": "7.0.0-esm1",
+  "version": "7.0.0",
   "homepage": "https://mochajs.org/",
   "notifyLogo": "https://ibin.co/4QuRuGjXvl36.png"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mocha",
-  "version": "7.0.0-esm1",
+  "version": "7.0.0",
   "description": "simple, flexible, fun test framework",
   "keywords": [
     "mocha",
@@ -179,7 +179,6 @@
     "Gavin Mogan <GavinM@airg.com>",
     "gaye <gaye@mozilla.com>",
     "gigadude <gigadude@users.noreply.github.com>",
-    "Gil Tayar <gil@tayar.org>",
     "Giovanni Bassi <giggio@giggio.net>",
     "gizemkeser <44727928+gizemkeser@users.noreply.github.com>",
     "Glen Huang <curvedmark@gmail.com>",
@@ -547,7 +546,7 @@
     "growl": "1.10.5",
     "he": "1.2.0",
     "js-yaml": "3.13.1",
-    "log-symbols": "3.0.0",
+    "log-symbols": "2.2.0",
     "minimatch": "3.0.4",
     "mkdirp": "0.5.1",
     "ms": "2.1.1",
@@ -568,7 +567,6 @@
     "acorn": "^7.0.0",
     "assetgraph-builder": "^6.10.1",
     "autoprefixer": "^9.6.0",
-    "babel-eslint": "^10.0.3",
     "browserify": "^16.2.3",
     "browserify-package-json": "^1.0.1",
     "chai": "^4.2.0",

package/lib/esm-utils.js

@@ -1,35 +0,0 @@
-// This file is allowed to use async/await because it is not exposed to browsers (see the `eslintrc`),
-// and Node supports async/await in all its non-dead version.
-
-const url = require('url');
-const path = require('path');
-
-exports.requireOrImport = async file => {
-  file = path.resolve(file);
-
-  if (path.extname(file) === '.mjs') {
-    return import(url.pathToFileURL(file));
-  }
-  // This way of figuring out whether a test file is CJS or ESM is currently the only known
-  // way of figuring out whether a file is CJS or ESM.
-  // If Node.js or the community establish a better procedure for that, we can fix this code.
-  // Another option here would be to always use `import()`, as this also supports CJS, but I would be
-  // wary of using it for _all_ existing test files, till ESM is fully stable.
-  try {
-    return require(file);
-  } catch (err) {
-    if (err.code === 'ERR_REQUIRE_ESM') {
-      return import(url.pathToFileURL(file));
-    } else {
-      throw err;
-    }
-  }
-};
-
-exports.loadFilesAsync = async (files, preLoadFunc, postLoadFunc) => {
-  for (const file of files) {
-    preLoadFunc(file);
-    const result = await exports.requireOrImport(file);
-    postLoadFunc(file, result);
-  }
-};