chai 5.1.0 → 5.1.2

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

@@ -11,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

@@ -23,9 +23,9 @@ 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 = {

package/package.json

@@ -18,7 +18,7 @@
     "Veselin Todorov <hi@vesln.com>",
     "John Firebaugh <john.firebaugh@gmail.com>"
   ],
-  "version": "5.1.0",
+  "version": "5.1.2",
   "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: [