mocha 8.0.1 → 8.1.3

package/lib/utils.js

@@ -9,14 +9,9 @@
  * Module dependencies.
  */
 
-var fs = require('fs');
 var path = require('path');
 var util = require('util');
-var glob = require('glob');
 var he = require('he');
-var errors = require('./errors');
-var createNoFilesMatchPatternError = errors.createNoFilesMatchPatternError;
-var createMissingArgumentError = errors.createMissingArgumentError;
 
 var assign = (exports.assign = require('object.assign').getPolyfill());
 
@@ -96,67 +91,6 @@ exports.clean = function(str) {
   return str.trim();
 };
 
-/**
- * Parse the given `qs`.
- *
- * @private
- * @param {string} qs
- * @return {Object}
- */
-exports.parseQuery = function(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;
-    }, {});
-};
-
-/**
- * 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
- */
-exports.highlightTags = function(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);
-  }
-};
-
 /**
  * If a value could have properties, and has none, this function is called,
  * which returns a string representation of the empty value.
@@ -444,140 +378,6 @@ exports.canonicalize = function canonicalize(value, stack, typeHint) {
   return canonicalizedObj;
 };
 
-/**
- * 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;
-  });
-}
-
-/**
- * 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] === '.';
-}
-
-/**
- * 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
- * @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.
- */
-exports.lookupFiles = 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 ' + exports.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(
-        util.format(
-          'Argument %s required when argument %s is a directory',
-          exports.sQuote('extensions'),
-          exports.sQuote('filepath')
-        ),
-        'extensions',
-        'array'
-      );
-    }
-
-    if (
-      !stat.isFile() ||
-      !hasMatchingExtname(pathname, extensions) ||
-      isHiddenOnUnix(pathname)
-    ) {
-      return;
-    }
-    files.push(pathname);
-  });
-
-  return files;
-};
-
 /**
  * process.emitWarning or a polyfill
  * @see https://nodejs.org/api/process.html#process_process_emitwarning_warning_options
@@ -708,7 +508,7 @@ exports.isPromise = function isPromise(value) {
  * Clamps a numeric value to an inclusive range.
  *
  * @param {number} value - Value to be clamped.
- * @param {numer[]} range - Two element array specifying [min, max] range.
+ * @param {number[]} range - Two element array specifying [min, max] range.
  * @returns {number} clamped value
  */
 exports.clamp = function clamp(value, range) {
@@ -768,9 +568,9 @@ exports.noop = function() {};
  * doesn't support it. Recommended for use in Mocha's public APIs.
  *
  * @public
- * @see {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map|MDN:Map}
+ * @see {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map#Custom_and_Null_objects|MDN:Map}
  * @see {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/create#Custom_and_Null_objects|MDN:Object.create - Custom objects}
- * @see {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/assign|MDN:Object.assign}
+ * @see {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/assign#Custom_and_Null_objects|MDN:Object.assign}
  * @param {...*} [obj] - Arguments to `Object.assign()`.
  * @returns {Object} An object with no prototype, having `...obj` properties
  */
@@ -804,7 +604,7 @@ exports.defineConstants = function(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.
+ * Versions prior to 10 did not support ES Modules, and version 10 has an old incompatible version of ESM.
  * This function returns whether Node.JS has ES Module supports that is compatible with Mocha's needs,
  * which is version >=12.11.
  *
@@ -845,3 +645,32 @@ exports.cwd = function cwd() {
 exports.isBrowser = function isBrowser() {
   return Boolean(process.browser);
 };
+
+/**
+ * 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
+ * @alias module:lib/cli.lookupFiles
+ * @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.
+ * @deprecated Moved to {@link module:lib/cli.lookupFiles}
+ */
+exports.lookupFiles = (...args) => {
+  if (exports.isBrowser()) {
+    throw require('./errors').createUnsupportedError(
+      'lookupFiles() is only supported in Node.js!'
+    );
+  }
+  exports.deprecate(
+    '`lookupFiles()` in module `mocha/lib/utils` has moved to module `mocha/lib/cli` and will be removed in the next major revision of Mocha'
+  );
+  return require('./cli').lookupFiles(...args);
+};