chai 5.0.3 → 5.1.1

package/lib/chai/utils/index.js

@@ -4,171 +4,104 @@
  * MIT Licensed
  */
 
-/*!
- * Dependencies that are used for multiple exports are required here only once
- */
-
+// Dependencies that are used for multiple exports are required here only once
 import * as checkError from 'check-error';
 
-/*!
- * test utility
- */
-
+// test utility
 export {test} from './test.js';
 
-/*!
- * type utility
- */
-
+// type utility
 export {type} from './type-detect.js';
 
-/*!
- * expectTypes utility
- */
+// expectTypes utility
 export {expectTypes} from './expectTypes.js';
 
-/*!
- * message utility
- */
-
+// message utility
 export {getMessage} from './getMessage.js';
 
-/*!
- * actual utility
- */
-
+// actual utility
 export {getActual} from './getActual.js';
 
-/*!
- * Inspect util
- */
-
+// Inspect util
 export {inspect} from './inspect.js';
 
-/*!
- * Object Display util
- */
-
+// Object Display util
 export {objDisplay} from './objDisplay.js';
 
-/*!
- * Flag utility
- */
-
+// Flag utility
 export {flag} from './flag.js';
 
-/*!
- * Flag transferring utility
- */
-
+// Flag transferring utility
 export {transferFlags} from './transferFlags.js';
 
-/*!
- * Deep equal utility
- */
-
+// Deep equal utility
 export {default as eql} from 'deep-eql';
 
-/*!
- * Deep path info
- */
-
+// Deep path info
 export {getPathInfo, hasProperty} from 'pathval';
 
-/*!
+/**
  * Function name
+ *
+ * @param {Function} fn
+ * @returns {string}
  */
-
 export function getName(fn) {
   return fn.name
 }
 
-/*!
- * add Property
- */
-
+// add Property
 export {addProperty} from './addProperty.js';
 
-/*!
- * add Method
- */
-
+// add Method
 export {addMethod} from './addMethod.js';
 
-/*!
- * overwrite Property
- */
-
+// overwrite Property
 export {overwriteProperty} from './overwriteProperty.js';
 
-/*!
- * overwrite Method
- */
-
+// overwrite Method
 export {overwriteMethod} from './overwriteMethod.js';
 
-/*!
- * Add a chainable method
- */
-
+// Add a chainable method
 export {addChainableMethod} from './addChainableMethod.js';
 
-/*!
- * Overwrite chainable method
- */
-
+// Overwrite chainable method
 export {overwriteChainableMethod} from './overwriteChainableMethod.js';
 
-/*!
- * Compare by inspect method
- */
-
+// Compare by inspect method
 export {compareByInspect} from './compareByInspect.js';
 
-/*!
- * Get own enumerable property symbols method
- */
-
+// Get own enumerable property symbols method
 export {getOwnEnumerablePropertySymbols} from './getOwnEnumerablePropertySymbols.js';
 
-/*!
- * Get own enumerable properties method
- */
-
+// Get own enumerable properties method
 export {getOwnEnumerableProperties} from './getOwnEnumerableProperties.js';
 
-/*!
- * Checks error against a given set of criteria
- */
-
+// Checks error against a given set of criteria
 export {checkError};
 
-/*!
- * Proxify util
- */
-
+// Proxify util
 export {proxify} from './proxify.js';
 
-/*!
- * addLengthGuard util
- */
-
+// addLengthGuard util
 export {addLengthGuard} from './addLengthGuard.js';
 
-/*!
- * isProxyEnabled helper
- */
-
+// isProxyEnabled helper
 export {isProxyEnabled} from './isProxyEnabled.js';
 
-/*!
- * isNaN method
- */
-
+// isNaN method
 export {isNaN} from './isNaN.js';
 
-/*!
- * getOperator method
- */
-
+// getOperator method
 export {getOperator} from './getOperator.js';
+
+/**
+ * Determines if an object is a `RegExp`
+ * This is used since `instanceof` will not work in virtual contexts
+ *
+ * @param {*} obj Object to test
+ * @returns {boolean}
+ */
+export function isRegExp(obj) {
+  return Object.prototype.toString.call(obj) === '[object RegExp]';
+}

package/lib/chai/utils/inspect.js

@@ -10,12 +10,13 @@ import {config} from '../config.js';
  * Echoes the value of a value. Tries to print the value out
  * in the best way possible given the different types.
  *
- * @param {Object} obj The object to print out.
- * @param {Boolean} showHidden Flag that shows hidden (not enumerable)
+ * @param {object} obj The object to print out.
+ * @param {boolean} showHidden Flag that shows hidden (not enumerable)
  *    properties of objects. Default is false.
- * @param {Number} depth Depth in which to descend in object. Default is 2.
- * @param {Boolean} colors Flag to turn on ANSI escape codes to color the
+ * @param {number} depth Depth in which to descend in object. Default is 2.
+ * @param {boolean} colors Flag to turn on ANSI escape codes to color the
  *    output. Default is false (no coloring).
+ * @returns {string}
  * @namespace Utils
  * @name inspect
  */

package/lib/chai/utils/isNaN.js

@@ -11,11 +11,11 @@
  *
  *     utils.isNaN(NaN); // true
  *
- * @param {Value} The value which has to be checked if it is NaN
+ * @param {unknown} value The value which has to be checked if it is NaN
+ * @returns {boolean}
  * @name isNaN
- * @api private
+ * @private
  */
-
 function _isNaN(value) {
   // Refer http://www.ecma-international.org/ecma-262/6.0/#sec-isnan-number
   // section's NOTE.

package/lib/chai/utils/isProxyEnabled.js

@@ -15,8 +15,8 @@ import {config} from '../config.js';
  *
  * @namespace Utils
  * @name isProxyEnabled
+ * @returns {boolean}
  */
-
 export function isProxyEnabled() {
   return config.useProxy &&
     typeof Proxy !== 'undefined' &&

package/lib/chai/utils/objDisplay.js

@@ -4,10 +4,6 @@
  * MIT Licensed
  */
 
-/*!
- * Module dependencies
- */
-
 import {inspect} from './inspect.js';
 import {config} from '../config.js';
 
@@ -18,13 +14,12 @@ import {config} from '../config.js';
  * criteria to be inspected in-line for error
  * messages or should be truncated.
  *
- * @param {Mixed} javascript object to inspect
+ * @param {unknown} obj javascript object to inspect
  * @returns {string} stringified object
  * @name objDisplay
  * @namespace Utils
- * @api public
+ * @public
  */
-
 export function objDisplay(obj) {
   var str = inspect(obj)
     , type = Object.prototype.toString.call(obj);

package/lib/chai/utils/overwriteChainableMethod.js

@@ -16,10 +16,10 @@ import {transferFlags} from './transferFlags.js';
  * name.
  *
  *     utils.overwriteChainableMethod(chai.Assertion.prototype, 'lengthOf',
- *       function (_super) {
- *       }
- *     , function (_super) {
- *       }
+ *         function (_super) {
+ *         }
+ *         , function (_super) {
+ *         }
  *     );
  *
  * Can also be accessed directly from `chai.Assertion`.
@@ -31,15 +31,14 @@ import {transferFlags} from './transferFlags.js';
  *     expect(myFoo).to.have.lengthOf(3);
  *     expect(myFoo).to.have.lengthOf.above(3);
  *
- * @param {Object} ctx object whose method / property is to be overwritten
- * @param {String} name of method / property to overwrite
+ * @param {object} ctx object whose method / property is to be overwritten
+ * @param {string} name of method / property to overwrite
  * @param {Function} method function that returns a function to be used for name
  * @param {Function} chainingBehavior function that returns a function to be used for property
  * @namespace Utils
  * @name overwriteChainableMethod
- * @api public
+ * @public
  */
-
 export function overwriteChainableMethod(ctx, name, method, chainingBehavior) {
   var chainableBehavior = ctx.__methods[name];
 

package/lib/chai/utils/overwriteMethod.js

@@ -18,14 +18,14 @@ import {transferFlags} from './transferFlags.js';
  * to be used for name.
  *
  *     utils.overwriteMethod(chai.Assertion.prototype, 'equal', function (_super) {
- *       return function (str) {
- *         var obj = utils.flag(this, 'object');
- *         if (obj instanceof Foo) {
- *           new chai.Assertion(obj.value).to.equal(str);
- *         } else {
- *           _super.apply(this, arguments);
+ *         return function (str) {
+ *             var obj = utils.flag(this, 'object');
+ *             if (obj instanceof Foo) {
+ *                 new chai.Assertion(obj.value).to.equal(str);
+ *             } else {
+ *                 _super.apply(this, arguments);
+ *             }
  *         }
- *       }
  *     });
  *
  * Can also be accessed directly from `chai.Assertion`.
@@ -36,14 +36,13 @@ import {transferFlags} from './transferFlags.js';
  *
  *     expect(myFoo).to.equal('bar');
  *
- * @param {Object} ctx object whose method is to be overwritten
- * @param {String} name of method to overwrite
+ * @param {object} ctx object whose method is to be overwritten
+ * @param {string} name of method to overwrite
  * @param {Function} method function that returns a function to be used for name
  * @namespace Utils
  * @name overwriteMethod
- * @api public
+ * @public
  */
-
 export function overwriteMethod(ctx, name, method) {
   var _method = ctx[name]
     , _super = function () {

package/lib/chai/utils/overwriteProperty.js

@@ -16,17 +16,16 @@ import {transferFlags} from './transferFlags.js';
  * access to previous value. Must return function to use as getter.
  *
  *     utils.overwriteProperty(chai.Assertion.prototype, 'ok', function (_super) {
- *       return function () {
- *         var obj = utils.flag(this, 'object');
- *         if (obj instanceof Foo) {
- *           new chai.Assertion(obj.name).to.equal('bar');
- *         } else {
- *           _super.call(this);
+ *         return function () {
+ *             var obj = utils.flag(this, 'object');
+ *             if (obj instanceof Foo) {
+ *                 new chai.Assertion(obj.name).to.equal('bar');
+ *             } else {
+ *                 _super.call(this);
+ *             }
  *         }
- *       }
  *     });
  *
- *
  * Can also be accessed directly from `chai.Assertion`.
  *
  *     chai.Assertion.overwriteProperty('foo', fn);
@@ -35,14 +34,13 @@ import {transferFlags} from './transferFlags.js';
  *
  *     expect(myFoo).to.be.ok;
  *
- * @param {Object} ctx object whose property is to be overwritten
- * @param {String} name of property to overwrite
+ * @param {object} ctx object whose property is to be overwritten
+ * @param {string} name of property to overwrite
  * @param {Function} getter function that returns a getter function to be used for name
  * @namespace Utils
  * @name overwriteProperty
- * @api public
+ * @public
  */
-
 export function overwriteProperty(ctx, name, getter) {
   var _get = Object.getOwnPropertyDescriptor(ctx, name)
     , _super = function () {};

package/lib/chai/utils/proxify.js

@@ -9,6 +9,8 @@ import {isProxyEnabled} from './isProxyEnabled.js';
  * MIT Licensed
  */
 
+const builtins = ['__flags', '__methods', '_obj', 'assert'];
+
 /**
  * ### .proxify(object)
  *
@@ -22,14 +24,12 @@ import {isProxyEnabled} from './isProxyEnabled.js';
  * If proxies are unsupported or disabled via the user's Chai config, then
  * return object without modification.
  *
- * @param {Object} obj
- * @param {String} nonChainableMethodName
+ * @param {object} obj
+ * @param {string} nonChainableMethodName
+ * @returns {unknown}
  * @namespace Utils
  * @name proxify
  */
-
-const builtins = ['__flags', '__methods', '_obj', 'assert'];
-
 export function proxify(obj ,nonChainableMethodName) {
   if (!isProxyEnabled()) return obj;
 
@@ -103,13 +103,13 @@ export function proxify(obj ,nonChainableMethodName) {
 /**
  * # stringDistanceCapped(strA, strB, cap)
  * Return the Levenshtein distance between two strings, but no more than cap.
+ *
  * @param {string} strA
  * @param {string} strB
- * @param {number} number
- * @return {number} min(string distance between strA and strB, cap)
- * @api private
+ * @param {number} cap
+ * @returns {number} min(string distance between strA and strB, cap)
+ * @private
  */
-
 function stringDistanceCapped(strA, strB, cap) {
   if (Math.abs(strA.length - strB.length) >= cap) {
     return cap;

package/lib/chai/utils/test.js

@@ -4,10 +4,6 @@
  * MIT Licensed
  */
 
-/*!
- * Module dependencies
- */
-
 import {flag} from './flag.js';
 
 /**
@@ -15,12 +11,12 @@ import {flag} from './flag.js';
  *
  * Test an object for expression.
  *
- * @param {Object} object (constructed Assertion)
- * @param {Arguments} chai.Assertion.prototype.assert arguments
+ * @param {object} obj (constructed Assertion)
+ * @param {unknown} args
+ * @returns {unknown}
  * @namespace Utils
  * @name test
  */
-
 export function test(obj, args) {
   var negate = flag(obj, 'negate')
     , expr = args[0];

package/lib/chai/utils/transferFlags.js

@@ -12,21 +12,19 @@
  * assertion flags (namely `object`, `ssfi`, `lockSsfi`,
  * and `message`) will not be transferred.
  *
- *
  *     var newAssertion = new Assertion();
  *     utils.transferFlags(assertion, newAssertion);
  *
  *     var anotherAssertion = new Assertion(myObj);
  *     utils.transferFlags(assertion, anotherAssertion, false);
  *
- * @param {Assertion} assertion the assertion to transfer the flags from
- * @param {Object} object the object to transfer the flags to; usually a new assertion
- * @param {Boolean} includeAll
+ * @param {import('../assertion.js').Assertion} assertion the assertion to transfer the flags from
+ * @param {object} object the object to transfer the flags to; usually a new assertion
+ * @param {boolean} includeAll
  * @namespace Utils
  * @name transferFlags
- * @api private
+ * @private
  */
-
 export function transferFlags(assertion, object, includeAll) {
   var flags = assertion.__flags || (assertion.__flags = Object.create(null));
 

package/lib/chai/utils/type-detect.js

@@ -1,3 +1,7 @@
+/**
+ * @param {unknown} obj
+ * @returns {string}
+ */
 export function type(obj) {
   if (typeof obj === 'undefined') {
     return 'undefined';

package/lib/chai.js

@@ -15,10 +15,7 @@ import {assert} from './chai/interface/assert.js';
 
 const used = [];
 
-/*!
- * Assertion Error
- */
-
+// Assertion Error
 export {AssertionError};
 
 /**
@@ -26,11 +23,10 @@ export {AssertionError};
  *
  * Provides a way to extend the internals of Chai.
  *
- * @param {Function}
+ * @param {Function} fn
  * @returns {this} for chaining
- * @api public
+ * @public
  */
-
 export function use(fn) {
   const exports = {
     AssertionError,
@@ -50,38 +46,20 @@ export function use(fn) {
   return exports;
 };
 
-/*!
- * Utility Functions
- */
-
+// Utility Functions
 export {util};
 
-/*!
- * Configuration
- */
-
+// Configuration
 export {config};
 
-/*!
- * Primary `Assertion` prototype
- */
-
+// Primary `Assertion` prototype
 export * from './chai/assertion.js';
 
-/*!
- * Expect interface
- */
-
+// Expect interface
 export * from './chai/interface/expect.js';
 
-/*!
- * Should interface
- */
-
+// Should interface
 export * from './chai/interface/should.js';
 
-/*!
- * Assert interface
- */
-
+// Assert interface
 export * from './chai/interface/assert.js';

package/package.json

@@ -18,7 +18,7 @@
     "Veselin Todorov <hi@vesln.com>",
     "John Firebaugh <john.firebaugh@gmail.com>"
   ],
-  "version": "5.0.3",
+  "version": "5.1.1",
   "repository": {
     "type": "git",
     "url": "https://github.com/chaijs/chai"
@@ -31,10 +31,11 @@
     "prebuild": "npm run clean",
     "build": "npm run build:esm",
     "build:esm": "esbuild --bundle --format=esm --keep-names --outfile=chai.js index.js",
-    "pretest": "npm run build",
+    "pretest": "npm run lint && npm run build",
     "test": "npm run test-node && npm run test-chrome",
     "test-node": "mocha --require ./test/bootstrap/index.js --reporter dot test/*.js",
     "test-chrome": "web-test-runner --playwright",
+    "lint": "eslint lib/",
     "clean": "rm -f chai.js coverage"
   },
   "engines": {
@@ -42,7 +43,7 @@
   },
   "dependencies": {
     "assertion-error": "^2.0.1",
-    "check-error": "^2.0.0",
+    "check-error": "^2.1.1",
     "deep-eql": "^5.0.1",
     "loupe": "^3.1.0",
     "pathval": "^2.0.0"
@@ -53,6 +54,8 @@
     "@web/test-runner": "^0.18.0",
     "@web/test-runner-playwright": "^0.11.0",
     "esbuild": "^0.19.10",
+    "eslint": "^8.56.0",
+    "eslint-plugin-jsdoc": "^48.0.4",
     "mocha": "^10.2.0"
   }
 }

package/web-test-runner.config.js

@@ -5,7 +5,10 @@ const commonjs = fromRollup(rollupCommonjs);
 
 export default {
   nodeResolve: true,
-  files: ["test/*.js"],
+  files: [
+    "test/*.js",
+    "!test/virtual-machines.js"
+  ],
   plugins: [
     commonjs({
       include: [