chai 5.1.2 → 5.2.1

package/lib/chai/utils/isProxyEnabled.js

@@ -18,7 +18,9 @@ import {config} from '../config.js';
  * @returns {boolean}
  */
 export function isProxyEnabled() {
-  return config.useProxy &&
+  return (
+    config.useProxy &&
     typeof Proxy !== 'undefined' &&
-    typeof Reflect !== 'undefined';
+    typeof Reflect !== 'undefined'
+  );
 }

package/lib/chai/utils/objDisplay.js

@@ -21,8 +21,8 @@ import {config} from '../config.js';
  * @public
  */
 export function objDisplay(obj) {
-  var str = inspect(obj)
-    , type = Object.prototype.toString.call(obj);
+  let str = inspect(obj),
+    type = Object.prototype.toString.call(obj);
 
   if (config.truncateThreshold && str.length >= config.truncateThreshold) {
     if (type === '[object Function]') {
@@ -32,10 +32,11 @@ export function objDisplay(obj) {
     } else if (type === '[object Array]') {
       return '[ Array(' + obj.length + ') ]';
     } else if (type === '[object Object]') {
-      var keys = Object.keys(obj)
-        , kstr = keys.length > 2
-          ? keys.splice(0, 2).join(', ') + ', ...'
-          : keys.join(', ');
+      let keys = Object.keys(obj),
+        kstr =
+          keys.length > 2
+            ? keys.splice(0, 2).join(', ') + ', ...'
+            : keys.join(', ');
       return '{ Object (' + kstr + ') }';
     } else {
       return str;

package/lib/chai/utils/overwriteChainableMethod.js

@@ -40,28 +40,29 @@ import {transferFlags} from './transferFlags.js';
  * @public
  */
 export function overwriteChainableMethod(ctx, name, method, chainingBehavior) {
-  var chainableBehavior = ctx.__methods[name];
+  let chainableBehavior = ctx.__methods[name];
 
-  var _chainingBehavior = chainableBehavior.chainingBehavior;
-  chainableBehavior.chainingBehavior = function overwritingChainableMethodGetter() {
-    var result = chainingBehavior(_chainingBehavior).call(this);
-    if (result !== undefined) {
-      return result;
-    }
+  let _chainingBehavior = chainableBehavior.chainingBehavior;
+  chainableBehavior.chainingBehavior =
+    function overwritingChainableMethodGetter() {
+      let result = chainingBehavior(_chainingBehavior).call(this);
+      if (result !== undefined) {
+        return result;
+      }
 
-    var newAssertion = new Assertion();
-    transferFlags(this, newAssertion);
-    return newAssertion;
-  };
+      let newAssertion = new Assertion();
+      transferFlags(this, newAssertion);
+      return newAssertion;
+    };
 
-  var _method = chainableBehavior.method;
+  let _method = chainableBehavior.method;
   chainableBehavior.method = function overwritingChainableMethodWrapper() {
-    var result = method(_method).apply(this, arguments);
+    let result = method(_method).apply(this, arguments);
     if (result !== undefined) {
       return result;
     }
 
-    var newAssertion = new Assertion();
+    let newAssertion = new Assertion();
     transferFlags(this, newAssertion);
     return newAssertion;
   };

package/lib/chai/utils/overwriteMethod.js

@@ -44,15 +44,14 @@ import {transferFlags} from './transferFlags.js';
  * @public
  */
 export function overwriteMethod(ctx, name, method) {
-  var _method = ctx[name]
-    , _super = function () {
+  let _method = ctx[name],
+    _super = function () {
       throw new Error(name + ' is not a function');
     };
 
-  if (_method && 'function' === typeof _method)
-    _super = _method;
+  if (_method && 'function' === typeof _method) _super = _method;
 
-  var overwritingMethodWrapper = function () {
+  let overwritingMethodWrapper = function () {
     // Setting the `ssfi` flag to `overwritingMethodWrapper` causes this
     // function to be the starting point for removing implementation frames from
     // the stack trace of a failed assertion.
@@ -72,19 +71,19 @@ export function overwriteMethod(ctx, name, method) {
     // Setting the `lockSsfi` flag to `true` prevents the overwritten assertion
     // from changing the `ssfi` flag. By this point, the `ssfi` flag is already
     // set to the correct starting point for this assertion.
-    var origLockSsfi = flag(this, 'lockSsfi');
+    let origLockSsfi = flag(this, 'lockSsfi');
     flag(this, 'lockSsfi', true);
-    var result = method(_super).apply(this, arguments);
+    let result = method(_super).apply(this, arguments);
     flag(this, 'lockSsfi', origLockSsfi);
 
     if (result !== undefined) {
       return result;
     }
 
-    var newAssertion = new Assertion();
+    let newAssertion = new Assertion();
     transferFlags(this, newAssertion);
     return newAssertion;
-  }
+  };
 
   addLengthGuard(overwritingMethodWrapper, name, false);
   ctx[name] = proxify(overwritingMethodWrapper, name);

package/lib/chai/utils/overwriteProperty.js

@@ -42,49 +42,48 @@ import {transferFlags} from './transferFlags.js';
  * @public
  */
 export function overwriteProperty(ctx, name, getter) {
-  var _get = Object.getOwnPropertyDescriptor(ctx, name)
-    , _super = function () {};
+  let _get = Object.getOwnPropertyDescriptor(ctx, name),
+    _super = function () {};
 
-  if (_get && 'function' === typeof _get.get)
-    _super = _get.get
+  if (_get && 'function' === typeof _get.get) _super = _get.get;
 
-  Object.defineProperty(ctx, name,
-    { get: function overwritingPropertyGetter() {
-        // Setting the `ssfi` flag to `overwritingPropertyGetter` causes this
-        // function to be the starting point for removing implementation frames
-        // from the stack trace of a failed assertion.
-        //
-        // However, we only want to use this function as the starting point if
-        // the `lockSsfi` flag isn't set and proxy protection is disabled.
-        //
-        // If the `lockSsfi` flag is set, then either this assertion has been
-        // overwritten by another assertion, or this assertion is being invoked
-        // from inside of another assertion. In the first case, the `ssfi` flag
-        // has already been set by the overwriting assertion. In the second
-        // case, the `ssfi` flag has already been set by the outer assertion.
-        //
-        // If proxy protection is enabled, then the `ssfi` flag has already been
-        // set by the proxy getter.
-        if (!isProxyEnabled() && !flag(this, 'lockSsfi')) {
-          flag(this, 'ssfi', overwritingPropertyGetter);
-        }
-
-        // Setting the `lockSsfi` flag to `true` prevents the overwritten
-        // assertion from changing the `ssfi` flag. By this point, the `ssfi`
-        // flag is already set to the correct starting point for this assertion.
-        var origLockSsfi = flag(this, 'lockSsfi');
-        flag(this, 'lockSsfi', true);
-        var result = getter(_super).call(this);
-        flag(this, 'lockSsfi', origLockSsfi);
+  Object.defineProperty(ctx, name, {
+    get: function overwritingPropertyGetter() {
+      // Setting the `ssfi` flag to `overwritingPropertyGetter` causes this
+      // function to be the starting point for removing implementation frames
+      // from the stack trace of a failed assertion.
+      //
+      // However, we only want to use this function as the starting point if
+      // the `lockSsfi` flag isn't set and proxy protection is disabled.
+      //
+      // If the `lockSsfi` flag is set, then either this assertion has been
+      // overwritten by another assertion, or this assertion is being invoked
+      // from inside of another assertion. In the first case, the `ssfi` flag
+      // has already been set by the overwriting assertion. In the second
+      // case, the `ssfi` flag has already been set by the outer assertion.
+      //
+      // If proxy protection is enabled, then the `ssfi` flag has already been
+      // set by the proxy getter.
+      if (!isProxyEnabled() && !flag(this, 'lockSsfi')) {
+        flag(this, 'ssfi', overwritingPropertyGetter);
+      }
 
-        if (result !== undefined) {
-          return result;
-        }
+      // Setting the `lockSsfi` flag to `true` prevents the overwritten
+      // assertion from changing the `ssfi` flag. By this point, the `ssfi`
+      // flag is already set to the correct starting point for this assertion.
+      let origLockSsfi = flag(this, 'lockSsfi');
+      flag(this, 'lockSsfi', true);
+      let result = getter(_super).call(this);
+      flag(this, 'lockSsfi', origLockSsfi);
 
-        var newAssertion = new Assertion();
-        transferFlags(this, newAssertion);
-        return newAssertion;
+      if (result !== undefined) {
+        return result;
       }
-    , configurable: true
+
+      let newAssertion = new Assertion();
+      transferFlags(this, newAssertion);
+      return newAssertion;
+    },
+    configurable: true
   });
 }

package/lib/chai/utils/proxify.js

@@ -9,6 +9,7 @@ import {isProxyEnabled} from './isProxyEnabled.js';
  * MIT Licensed
  */
 
+/** @type {PropertyKey[]} */
 const builtins = ['__flags', '__methods', '_obj', 'assert'];
 
 /**
@@ -24,13 +25,13 @@ const builtins = ['__flags', '__methods', '_obj', 'assert'];
  * If proxies are unsupported or disabled via the user's Chai config, then
  * return object without modification.
  *
- * @param {object} obj
- * @param {string} nonChainableMethodName
- * @returns {unknown}
  * @namespace Utils
- * @name proxify
+ * @template {object} T
+ * @param {T} obj
+ * @param {string} [nonChainableMethodName]
+ * @returns {T}
  */
-export function proxify(obj ,nonChainableMethodName) {
+export function proxify(obj, nonChainableMethodName) {
   if (!isProxyEnabled()) return obj;
 
   return new Proxy(obj, {
@@ -39,31 +40,37 @@ export function proxify(obj ,nonChainableMethodName) {
       // such as `Symbol.toStringTag`.
       // The values for which an error should be thrown can be configured using
       // the `config.proxyExcludedKeys` setting.
-      if (typeof property === 'string' &&
-          config.proxyExcludedKeys.indexOf(property) === -1 &&
-          !Reflect.has(target, property)) {
+      if (
+        typeof property === 'string' &&
+        config.proxyExcludedKeys.indexOf(property) === -1 &&
+        !Reflect.has(target, property)
+      ) {
         // Special message for invalid property access of non-chainable methods.
         if (nonChainableMethodName) {
-          throw Error('Invalid Chai property: ' + nonChainableMethodName + '.' +
-            property + '. See docs for proper usage of "' +
-            nonChainableMethodName + '".');
+          throw Error(
+            'Invalid Chai property: ' +
+              nonChainableMethodName +
+              '.' +
+              property +
+              '. See docs for proper usage of "' +
+              nonChainableMethodName +
+              '".'
+          );
         }
 
         // If the property is reasonably close to an existing Chai property,
         // suggest that property to the user. Only suggest properties with a
         // distance less than 4.
-        var suggestion = null;
-        var suggestionDistance = 4;
-        getProperties(target).forEach(function(prop) {
+        let suggestion = null;
+        let suggestionDistance = 4;
+        getProperties(target).forEach(function (prop) {
           if (
+            // we actually mean to check `Object.prototype` here
+            // eslint-disable-next-line no-prototype-builtins
             !Object.prototype.hasOwnProperty(prop) &&
             builtins.indexOf(prop) === -1
           ) {
-            var dist = stringDistanceCapped(
-              property,
-              prop,
-              suggestionDistance
-            );
+            let dist = stringDistanceCapped(property, prop, suggestionDistance);
             if (dist < suggestionDistance) {
               suggestion = prop;
               suggestionDistance = dist;
@@ -72,8 +79,13 @@ export function proxify(obj ,nonChainableMethodName) {
         });
 
         if (suggestion !== null) {
-          throw Error('Invalid Chai property: ' + property +
-            '. Did you mean "' + suggestion + '"?');
+          throw Error(
+            'Invalid Chai property: ' +
+              property +
+              '. Did you mean "' +
+              suggestion +
+              '"?'
+          );
         } else {
           throw Error('Invalid Chai property: ' + property);
         }
@@ -115,21 +127,21 @@ function stringDistanceCapped(strA, strB, cap) {
     return cap;
   }
 
-  var memo = [];
+  let memo = [];
   // `memo` is a two-dimensional array containing distances.
   // memo[i][j] is the distance between strA.slice(0, i) and
   // strB.slice(0, j).
-  for (var i = 0; i <= strA.length; i++) {
+  for (let i = 0; i <= strA.length; i++) {
     memo[i] = Array(strB.length + 1).fill(0);
     memo[i][0] = i;
   }
-  for (var j = 0; j < strB.length; j++) {
+  for (let j = 0; j < strB.length; j++) {
     memo[0][j] = j;
   }
 
-  for (var i = 1; i <= strA.length; i++) {
-    var ch = strA.charCodeAt(i - 1);
-    for (var j = 1; j <= strB.length; j++) {
+  for (let i = 1; i <= strA.length; i++) {
+    let ch = strA.charCodeAt(i - 1);
+    for (let j = 1; j <= strB.length; j++) {
       if (Math.abs(i - j) >= cap) {
         memo[i][j] = cap;
         continue;
@@ -137,8 +149,7 @@ function stringDistanceCapped(strA, strB, cap) {
       memo[i][j] = Math.min(
         memo[i - 1][j] + 1,
         memo[i][j - 1] + 1,
-        memo[i - 1][j - 1] +
-          (ch === strB.charCodeAt(j - 1) ? 0 : 1)
+        memo[i - 1][j - 1] + (ch === strB.charCodeAt(j - 1) ? 0 : 1)
       );
     }
   }

package/lib/chai/utils/test.js

@@ -18,7 +18,7 @@ import {flag} from './flag.js';
  * @name test
  */
 export function test(obj, args) {
-  var negate = flag(obj, 'negate')
-    , expr = args[0];
+  let negate = flag(obj, 'negate'),
+    expr = args[0];
   return negate ? !expr : expr;
 }

package/lib/chai/utils/transferFlags.js

@@ -26,7 +26,7 @@
  * @private
  */
 export function transferFlags(assertion, object, includeAll) {
-  var flags = assertion.__flags || (assertion.__flags = Object.create(null));
+  let flags = assertion.__flags || (assertion.__flags = Object.create(null));
 
   if (!object.__flags) {
     object.__flags = Object.create(null);
@@ -34,9 +34,14 @@ export function transferFlags(assertion, object, includeAll) {
 
   includeAll = arguments.length === 3 ? includeAll : true;
 
-  for (var flag in flags) {
-    if (includeAll ||
-        (flag !== 'object' && flag !== 'ssfi' && flag !== 'lockSsfi' && flag != 'message')) {
+  for (let flag in flags) {
+    if (
+      includeAll ||
+      (flag !== 'object' &&
+        flag !== 'ssfi' &&
+        flag !== 'lockSsfi' &&
+        flag != 'message')
+    ) {
       object.__flags[flag] = flags[flag];
     }
   }

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

@@ -6,7 +6,7 @@ export function type(obj) {
   if (typeof obj === 'undefined') {
     return 'undefined';
   }
-  
+
   if (obj === null) {
     return 'null';
   }

package/lib/chai.js

@@ -29,6 +29,7 @@ export {AssertionError};
  */
 export function use(fn) {
   const exports = {
+    use,
     AssertionError,
     util,
     config,
@@ -44,7 +45,7 @@ export function use(fn) {
   }
 
   return exports;
-};
+}
 
 // Utility Functions
 export {util};

package/package.json

@@ -18,7 +18,7 @@
     "Veselin Todorov <hi@vesln.com>",
     "John Firebaugh <john.firebaugh@gmail.com>"
   ],
-  "version": "5.1.2",
+  "version": "5.2.1",
   "repository": {
     "type": "git",
     "url": "https://github.com/chaijs/chai"
@@ -31,15 +31,19 @@
     "prebuild": "npm run clean",
     "build": "npm run build:esm",
     "build:esm": "esbuild --bundle --format=esm --keep-names --outfile=chai.js index.js",
+    "format": "prettier --write lib",
     "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-node": "c8 --99 --check-coverage mocha --require ./test/bootstrap/index.js test/*.js",
     "test-chrome": "web-test-runner --playwright",
-    "lint": "eslint lib/",
-    "clean": "rm -f chai.js coverage"
+    "lint": "npm run lint:js && npm run lint:format",
+    "lint:js": "eslint lib/",
+    "lint:format": "prettier --check lib",
+    "lint:types": "tsc",
+    "clean": "rm -rf chai.js coverage/"
   },
   "engines": {
-    "node": ">=12"
+    "node": ">=18"
   },
   "dependencies": {
     "assertion-error": "^2.0.1",
@@ -49,13 +53,17 @@
     "pathval": "^2.0.0"
   },
   "devDependencies": {
+    "@eslint/js": "^9.17.0",
     "@rollup/plugin-commonjs": "^25.0.7",
     "@web/dev-server-rollup": "^0.6.1",
     "@web/test-runner": "^0.18.0",
     "@web/test-runner-playwright": "^0.11.0",
-    "esbuild": "^0.19.10",
+    "c8": "^10.1.3",
+    "esbuild": "^0.25.0",
     "eslint": "^8.56.0",
     "eslint-plugin-jsdoc": "^48.0.4",
-    "mocha": "^10.2.0"
+    "mocha": "^10.2.0",
+    "prettier": "^3.4.2",
+    "typescript": "~5.7.3"
   }
 }

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "target": "esnext",
+    "module": "nodenext",
+    "moduleResolution": "nodenext",
+    "types": [],
+    "checkJs": true,
+    "noEmit": true,
+    "isolatedModules": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true
+  },
+  "include": [
+    "lib/**/*.js"
+  ]
+}

package/lib/chai/utils/getEnumerableProperties.js

@@ -1,25 +0,0 @@
-/*!
- * Chai - getEnumerableProperties utility
- * Copyright(c) 2012-2014 Jake Luer <jake@alogicalparadox.com>
- * MIT Licensed
- */
-
-/**
- * ### .getEnumerableProperties(object)
- *
- * This allows the retrieval of enumerable property names of an object,
- * inherited or not.
- *
- * @param {object} object
- * @returns {Array}
- * @namespace Utils
- * @name getEnumerableProperties
- * @public
- */
-module.exports = function getEnumerableProperties(object) {
-  var result = [];
-  for (var name in object) {
-    result.push(name);
-  }
-  return result;
-};

package/register-assert.cjs

@@ -1,3 +0,0 @@
-const {assert} = require('./chai.cjs');
-
-globalThis.assert = assert;

package/register-expect.cjs

@@ -1,3 +0,0 @@
-const {expect} = require('./chai.cjs');
-
-globalThis.expect = expect;

package/register-should.cjs

@@ -1,3 +0,0 @@
-const {should} = require('./chai.cjs');
-
-globalThis.should = should();