mocha 11.1.0 → 11.2.0

package/bin/mocha.js

@@ -78,7 +78,7 @@ if (mochaArgs._) {
 }
 
 if (mochaArgs['node-option'] || Object.keys(nodeArgs).length || hasInspect) {
-  const {spawn} = require('child_process');
+  const {spawn} = require('node:child_process');
   const mochaPath = require.resolve('../lib/cli/cli.js');
 
   const nodeArgv =
@@ -126,7 +126,7 @@ if (mochaArgs['node-option'] || Object.keys(nodeArgs).length || hasInspect) {
     // be needed.
     if (!args.parallel || args.jobs < 2) {
       // win32 does not support SIGTERM, so use next best thing.
-      if (require('os').platform() === 'win32') {
+      if (require('node:os').platform() === 'win32') {
         proc.kill('SIGKILL');
       } else {
         // using SIGKILL won't cleanly close the output streams, which can result

package/lib/cli/cli.js

@@ -1,5 +1,3 @@
-#!/usr/bin/env node
-
 'use strict';
 
 /**
@@ -13,7 +11,7 @@
 const debug = require('debug')('mocha:cli:cli');
 const symbols = require('log-symbols');
 const yargs = require('yargs');
-const path = require('path');
+const path = require('node:path');
 const {
   loadRc,
   loadPkgRc,

package/lib/cli/collect-files.js

@@ -1,7 +1,7 @@
 'use strict';
 
-const fs = require('fs');
-const path = require('path');
+const fs = require('node:fs');
+const path = require('node:path');
 const ansi = require('ansi-colors');
 const debug = require('debug')('mocha:cli:run:helpers');
 const minimatch = require('minimatch');

package/lib/cli/config.js

@@ -7,8 +7,8 @@
  * @module
  */
 
-const fs = require('fs');
-const path = require('path');
+const fs = require('node:fs');
+const path = require('node:path');
 const debug = require('debug')('mocha:cli:config');
 const findUp = require('find-up');
 const {createUnparsableFileError} = require('../errors');

package/lib/cli/init.js

@@ -7,8 +7,8 @@
  * @module
  */
 
-const fs = require('fs');
-const path = require('path');
+const fs = require('node:fs');
+const path = require('node:path');
 
 exports.command = 'init <path>';
 

package/lib/cli/lookup-files.js

@@ -5,8 +5,8 @@
  * @private
  */
 
-var fs = require('fs');
-var path = require('path');
+var fs = require('node:fs');
+var path = require('node:path');
 var glob = require('glob');
 var errors = require('../errors');
 var createNoFilesMatchPatternError = errors.createNoFilesMatchPatternError;

package/lib/cli/options.js

@@ -7,7 +7,7 @@
  * @private
  */
 
-const fs = require('fs');
+const fs = require('node:fs');
 const ansi = require('ansi-colors');
 const yargsParser = require('yargs-parser');
 const {

package/lib/cli/run-helpers.js

@@ -7,13 +7,13 @@
  * @private
  */
 
-const fs = require('fs');
-const path = require('path');
+const fs = require('node:fs');
+const path = require('node:path');
 const ansi = require('ansi-colors');
 const debug = require('debug')('mocha:cli:run:helpers');
 const {watchRun, watchParallelRun} = require('./watch-run');
 const collectFiles = require('./collect-files');
-const {format} = require('util');
+const {format} = require('node:util');
 const {createInvalidLegacyPluginError} = require('../errors');
 const {requireOrImport} = require('../nodejs/esm-utils');
 const PluginLoader = require('../plugin-loader');

package/lib/cli/watch-run.js

@@ -2,7 +2,7 @@
 
 const logSymbols = require('log-symbols');
 const debug = require('debug')('mocha:cli:watch');
-const path = require('path');
+const path = require('node:path');
 const chokidar = require('chokidar');
 const Context = require('../context');
 const collectFiles = require('./collect-files');

package/lib/errors.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const {format} = require('util');
+const {format} = require('node:util');
 
 /**
  * Contains error codes, factory functions to create throwable error objects,

package/lib/mocha.js

@@ -7,7 +7,7 @@
  */
 
 var escapeRe = require('escape-string-regexp');
-var path = require('path');
+var path = require('node:path');
 var builtinReporters = require('./reporters');
 var utils = require('./utils');
 var mocharc = require('./mocharc.json');

package/lib/nodejs/esm-utils.js

@@ -1,5 +1,5 @@
-const path = require('path');
-const url = require('url');
+const path = require('node:path');
+const url = require('node:url');
 
 const forward = x => x;
 

package/lib/reporters/json.js

@@ -7,8 +7,8 @@
  */
 
 var Base = require('./base');
-var fs = require('fs');
-var path = require('path');
+var fs = require('node:fs');
+var path = require('node:path');
 const createUnsupportedError = require('../errors').createUnsupportedError;
 const utils = require('../utils');
 var constants = require('../runner').constants;

package/lib/reporters/tap.js

@@ -6,7 +6,7 @@
  * Module dependencies.
  */
 
-var util = require('util');
+var util = require('node:util');
 var Base = require('./base');
 var constants = require('../runner').constants;
 var EVENT_TEST_PASS = constants.EVENT_TEST_PASS;

package/lib/reporters/xunit.js

@@ -8,8 +8,8 @@
 
 var Base = require('./base');
 var utils = require('../utils');
-var fs = require('fs');
-var path = require('path');
+var fs = require('node:fs');
+var path = require('node:path');
 var errors = require('../errors');
 var createUnsupportedError = errors.createUnsupportedError;
 var constants = require('../runner').constants;
@@ -104,7 +104,7 @@ function XUnit(runner, options) {
     );
 
     tests.forEach(function (t) {
-      self.test(t);
+      self.test(t, options);
     });
 
     self.write('</testsuite>');
@@ -152,13 +152,13 @@ XUnit.prototype.write = function (line) {
  *
  * @param {Test} test
  */
-XUnit.prototype.test = function (test) {
+XUnit.prototype.test = function (test, options) {
   Base.useColors = false;
 
   var attrs = {
     classname: test.parent.fullTitle(),
     name: test.title,
-    file: test.file,
+    file: testFilePath(test.file, options),
     time: test.duration / 1000 || 0
   };
 
@@ -215,4 +215,12 @@ function tag(name, attrs, close, content) {
   return tag;
 }
 
+function testFilePath(filepath, options) {
+  if (options && options.reporterOptions && options.reporterOptions.showRelativePaths) {
+    return path.relative(process.cwd(), filepath);
+  }
+
+  return filepath;
+}
+
 XUnit.description = 'XUnit-compatible XML output';

package/lib/runnable.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var EventEmitter = require('events').EventEmitter;
+var EventEmitter = require('node:events').EventEmitter;
 var Pending = require('./pending');
 var debug = require('debug')('mocha:runnable');
 var milliseconds = require('ms');
@@ -24,8 +24,10 @@ var MAX_TIMEOUT = Math.pow(2, 31) - 1;
 
 module.exports = Runnable;
 
+// "Additional properties" doc comment added for hosted docs (mochajs.org/api)
 /**
  * Initialize a new `Runnable` with the given `title` and callback `fn`.
+ * Additional properties, like `getFullTitle()` and `slow()`, can be viewed in the `Runnable` source.
  *
  * @class
  * @extends external:EventEmitter

package/lib/runner.js

@@ -4,7 +4,7 @@
  * Module dependencies.
  * @private
  */
-var EventEmitter = require('events').EventEmitter;
+var EventEmitter = require('node:events').EventEmitter;
 var Pending = require('./pending');
 var utils = require('./utils');
 var debug = require('debug')('mocha:runner');
@@ -47,7 +47,39 @@ var globals = [
 
 var constants = utils.defineConstants(
   /**
-   * {@link Runner}-related constants.
+   * {@link Runner}-related constants. Used by reporters. Each event emits the corresponding object, unless otherwise indicated.
+   * @example
+   * const Mocha = require('mocha');
+   * const Base = Mocha.reporters.Base;
+   * const {
+   *   EVENT_HOOK_BEGIN,
+   *   EVENT_TEST_PASS,
+   *   EVENT_TEST_FAIL,
+   *   EVENT_TEST_END
+   * } = Mocha.Runner.constants
+   *
+   * function MyReporter(runner, options) {
+   *   Base.call(this, runner, options);
+   *
+   *   runner.on(EVENT_HOOK_BEGIN, function(hook) {
+   *     console.log('hook called: ', hook.title);
+   *   });
+   *
+   *   runner.on(EVENT_TEST_PASS, function(test) {
+   *     console.log('pass: %s', test.fullTitle());
+   *   });
+   *
+   *   runner.on(EVENT_TEST_FAIL, function(test, err) {
+   *     console.log('fail: %s -- error: %s', test.fullTitle(), err.message);
+   *   });
+   *
+   *   runner.on(EVENT_TEST_END, function() {
+   *     console.log('end: %d/%d', runner.stats.passes, runner.stats.tests);
+   *   });
+   * }
+   *
+   * module.exports = MyReporter;
+   *
    * @public
    * @memberof Runner
    * @readonly
@@ -97,7 +129,13 @@ var constants = utils.defineConstants(
      */
     EVENT_TEST_END: 'test end',
     /**
-     * Emitted when {@link Test} execution fails
+     * Emitted when {@link Test} execution fails. Includes an `err` object of type `Error`.
+     * @example
+     * runner.on(EVENT_TEST_FAIL, function(test, err) {
+     *   console.log('fail: %s -- error: %s', test.fullTitle(), err.message);
+     * });
+     *
+     *
      */
     EVENT_TEST_FAIL: 'fail',
     /**

package/lib/suite.js

@@ -4,7 +4,7 @@
  * Module dependencies.
  * @private
  */
-const {EventEmitter} = require('events');
+const {EventEmitter} = require('node:events');
 const Hook = require('./hook');
 var {
   assignNewMochaID,

package/lib/utils.js

@@ -8,8 +8,8 @@
 /**
  * Module dependencies.
  */
-var path = require('path');
-var util = require('util');
+var path = require('node:path');
+var util = require('node:util');
 var he = require('he');
 
 const MOCHA_ID_PROP_NAME = '__mocha_id__';

package/mocha.js

@@ -1,4 +1,4 @@
-// mocha@11.1.0 in javascript ES2018
+// mocha@11.2.0 in javascript ES2018
 (function (global, factory) {
   typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
   typeof define === 'function' && define.amd ? define(factory) :
@@ -12980,8 +12980,10 @@
 
   var runnable = Runnable$3;
 
+  // "Additional properties" doc comment added for hosted docs (mochajs.org/api)
   /**
    * Initialize a new `Runnable` with the given `title` and callback `fn`.
+   * Additional properties, like `getFullTitle()` and `slow()`, can be viewed in the `Runnable` source.
    *
    * @class
    * @extends external:EventEmitter
@@ -14234,7 +14236,39 @@
 
   var constants$1 = utils$1.defineConstants(
     /**
-     * {@link Runner}-related constants.
+     * {@link Runner}-related constants. Used by reporters. Each event emits the corresponding object, unless otherwise indicated.
+     * @example
+     * const Mocha = require('mocha');
+     * const Base = Mocha.reporters.Base;
+     * const {
+     *   EVENT_HOOK_BEGIN,
+     *   EVENT_TEST_PASS,
+     *   EVENT_TEST_FAIL,
+     *   EVENT_TEST_END
+     * } = Mocha.Runner.constants
+     *
+     * function MyReporter(runner, options) {
+     *   Base.call(this, runner, options);
+     *
+     *   runner.on(EVENT_HOOK_BEGIN, function(hook) {
+     *     console.log('hook called: ', hook.title);
+     *   });
+     *
+     *   runner.on(EVENT_TEST_PASS, function(test) {
+     *     console.log('pass: %s', test.fullTitle());
+     *   });
+     *
+     *   runner.on(EVENT_TEST_FAIL, function(test, err) {
+     *     console.log('fail: %s -- error: %s', test.fullTitle(), err.message);
+     *   });
+     *
+     *   runner.on(EVENT_TEST_END, function() {
+     *     console.log('end: %d/%d', runner.stats.passes, runner.stats.tests);
+     *   });
+     * }
+     *
+     * module.exports = MyReporter;
+     *
      * @public
      * @memberof Runner
      * @readonly
@@ -14284,7 +14318,13 @@
        */
       EVENT_TEST_END: 'test end',
       /**
-       * Emitted when {@link Test} execution fails
+       * Emitted when {@link Test} execution fails. Includes an `err` object of type `Error`.
+       * @example
+       * runner.on(EVENT_TEST_FAIL, function(test, err) {
+       *   console.log('fail: %s -- error: %s', test.fullTitle(), err.message);
+       * });
+       *
+       *
        */
       EVENT_TEST_FAIL: 'fail',
       /**
@@ -17745,7 +17785,7 @@
       );
 
       tests.forEach(function (t) {
-        self.test(t);
+        self.test(t, options);
       });
 
       self.write('</testsuite>');
@@ -17793,13 +17833,13 @@
    *
    * @param {Test} test
    */
-  XUnit.prototype.test = function (test) {
+  XUnit.prototype.test = function (test, options) {
     Base.useColors = false;
 
     var attrs = {
       classname: test.parent.fullTitle(),
       name: test.title,
-      file: test.file,
+      file: testFilePath(test.file, options),
       time: test.duration / 1000 || 0
     };
 
@@ -17856,6 +17896,14 @@
     return tag;
   }
 
+  function testFilePath(filepath, options) {
+    if (options && options.reporterOptions && options.reporterOptions.showRelativePaths) {
+      return path.relative(process.cwd(), filepath);
+    }
+
+    return filepath;
+  }
+
   XUnit.description = 'XUnit-compatible XML output';
   }(xunit));
 
@@ -19208,7 +19256,7 @@
   };
 
   var name = "mocha";
-  var version = "11.1.0";
+  var version = "11.2.0";
   var homepage = "https://mochajs.org/";
   var notifyLogo = "https://ibin.co/4QuRuGjXvl36.png";
   var require$$17 = {