chai - npm Package Compare versions

Comparing version 5.1.0 to 5.1.1

lib/chai.js

@@ -26,5 +26,5 @@ /*!
  *
- * @param {Function}
+ * @param {Function} fn
  * @returns {this} for chaining
- * @api public
+ * @public
  */
@@ -31,0 +31,0 @@ export function use(fn) {

lib/chai/assertion.js

@@ -21,33 +21,33 @@ /*!
  * - `object`: This flag contains the target of the assertion. For example, in
- *   the assertion `expect(numKittens).to.equal(7);`, the `object` flag will
- *   contain `numKittens` so that the `equal` assertion can reference it when
- *   needed.
+ * the assertion `expect(numKittens).to.equal(7);`, the `object` flag will
+ * contain `numKittens` so that the `equal` assertion can reference it when
+ * needed.
  *
  * - `message`: This flag contains an optional custom error message to be
- *   prepended to the error message that's generated by the assertion when it
- *   fails.
+ * prepended to the error message that's generated by the assertion when it
+ * fails.
  *
  * - `ssfi`: This flag stands for "start stack function indicator". It
- *   contains a function reference that serves as the starting point for
- *   removing frames from the stack trace of the error that's created by the
- *   assertion when it fails. The goal is to provide a cleaner stack trace to
- *   end users by removing Chai's internal functions. Note that it only works
- *   in environments that support `Error.captureStackTrace`, and only when
- *   `Chai.config.includeStack` hasn't been set to `false`.
+ * contains a function reference that serves as the starting point for
+ * removing frames from the stack trace of the error that's created by the
+ * assertion when it fails. The goal is to provide a cleaner stack trace to
+ * end users by removing Chai's internal functions. Note that it only works
+ * in environments that support `Error.captureStackTrace`, and only when
+ * `Chai.config.includeStack` hasn't been set to `false`.
  *
  * - `lockSsfi`: This flag controls whether or not the given `ssfi` flag
- *   should retain its current value, even as assertions are chained off of
- *   this object. This is usually set to `true` when creating a new assertion
- *   from within another assertion. It's also temporarily set to `true` before
- *   an overwritten assertion gets called by the overwriting assertion.
+ * should retain its current value, even as assertions are chained off of
+ * this object. This is usually set to `true` when creating a new assertion
+ * from within another assertion. It's also temporarily set to `true` before
+ * an overwritten assertion gets called by the overwriting assertion.
  *
  * - `eql`: This flag contains the deepEqual function to be used by the assertion.
  *
- * @param {Mixed} obj target of the assertion
- * @param {String} msg (optional) custom error message
+ * @param {unknown} obj target of the assertion
+ * @param {string} msg (optional) custom error message
  * @param {Function} ssfi (optional) starting point for removing stack frames
- * @param {Boolean} lockSsfi (optional) whether or not the ssfi flag is locked
- * @api private
+ * @param {boolean} lockSsfi (optional) whether or not the ssfi flag is locked
+ * @returns {unknown}
+ * @private
  */
-
 export function Assertion (obj, msg, ssfi, lockSsfi) {
@@ -115,9 +115,9 @@ util.flag(this, 'ssfi', ssfi || Assertion);
  * @name assert
- * @param {Philosophical} expression to be tested
- * @param {String|Function} message or function that returns message to display if expression fails
- * @param {String|Function} negatedMessage or function that returns negatedMessage to display if negated expression fails
- * @param {Mixed} expected value (remember to check for negation)
- * @param {Mixed} actual (optional) will default to `this.obj`
- * @param {Boolean} showDiff (optional) when set to `true`, assert will display a diff in addition to the message if expression fails
- * @api private
+ * @param {unknown} expression to be tested
+ * @param {string | Function} message or function that returns message to display if expression fails
+ * @param {string | Function} negatedMessage or function that returns negatedMessage to display if negated expression fails
+ * @param {unknown} expected value (remember to check for negation)
+ * @param {unknown} actual (optional) will default to `this.obj`
+ * @param {boolean} showDiff (optional) when set to `true`, assert will display a diff in addition to the message if expression fails
+ * @private
  */
@@ -157,3 +157,3 @@
  *
- * @api private
+ * @private
  */
@@ -160,0 +160,0 @@ Object.defineProperty(Assertion.prototype, '_obj',

lib/chai/config.js

@@ -12,6 +12,5 @@ export const config = {
    *
-   * @param {Boolean}
-   * @api public
+   * @param {boolean}
+   * @public
    */
-
   includeStack: false,
@@ -28,6 +27,5 @@
    *
-   * @param {Boolean}
-   * @api public
+   * @param {boolean}
+   * @public
    */
-
   showDiff: true,
@@ -51,6 +49,5 @@
    *
-   * @param {Number}
-   * @api public
+   * @param {number}
+   * @public
    */
-
   truncateThreshold: 40,
@@ -72,6 +69,5 @@
    *
-   * @param {Boolean}
-   * @api public
+   * @param {boolean}
+   * @public
    */
-
   useProxy: true,
@@ -94,5 +90,4 @@
    * @param {Array}
-   * @api public
+   * @public
    */
-
   proxyExcludedKeys: ['then', 'catch', 'inspect', 'toJSON'],
@@ -109,18 +104,17 @@
    *     chai.config.deepEqual = (expected, actual) => {
-   *        return chai.util.eql(expected, actual, {
-   *           comparator: (expected, actual) => {
-   *              // for non number comparison, use the default behavior
-   *              if(typeof expected !== 'number') return null;
-   *              // allow a difference of 10 between compared numbers
-   *              return typeof actual === 'number' && Math.abs(actual - expected) < 10
-   *           }
-   *        })
+   *         return chai.util.eql(expected, actual, {
+   *             comparator: (expected, actual) => {
+   *                 // for non number comparison, use the default behavior
+   *                 if(typeof expected !== 'number') return null;
+   *                 // allow a difference of 10 between compared numbers
+   *                 return typeof actual === 'number' && Math.abs(actual - expected) < 10
+   *             }
+   *         })
    *     };
    *
    * @param {Function}
-   * @api public
+   * @public
    */
-
   deepEqual: null
 
 };

lib/chai/interface/expect.js

@@ -11,2 +11,7 @@ /*!
 
+/**
+ * @param {unknown} val
+ * @param {string} message
+ * @returns {Assertion}
+ */
 function expect(val, message) {
@@ -34,4 +39,4 @@ return new Assertion(val, message);
  * @param {unknown} expected
- * @param {String} message
- * @param {String} operator
+ * @param {string} message
+ * @param {string} operator
  * @namespace expect
@@ -38,0 +43,0 @@ * @public

lib/chai/interface/should.js

@@ -10,4 +10,10 @@ /*!
 
+/**
+ * @returns {void}
+ */
 function loadShould () {
   // explicitly define this method as function as to have it's name to include as `ssfi`
+  /**
+   * @returns {Assertion}
+   */
   function shouldGetter() {
@@ -23,2 +29,5 @@ if (this instanceof String
   }
+  /**
+   * @param {unknown} value
+   */
   function shouldSetter(value) {
@@ -60,8 +69,7 @@ // See https://github.com/chaijs/chai/issues/86: this makes
    *
-   *
    * @name fail
    * @param {unknown} actual
    * @param {unknown} expected
-   * @param {String} message
-   * @param {String} operator
+   * @param {string} message
+   * @param {string} operator
    * @namespace BDD
@@ -94,8 +102,8 @@ * @public
    * @param {unknown} expected
-   * @param {String} message
+   * @param {string} message
    * @namespace Should
    * @public
    */
-  should.equal = function (val1, val2, msg) {
-    new Assertion(val1, msg).to.equal(val2);
+  should.equal = function (actual, expected, message) {
+    new Assertion(actual, message).to.equal(expected);
   };
@@ -118,6 +126,6 @@
    * @alias Throw
-   * @param {Function} function
-   * @param {ErrorConstructor} constructor
-   * @param {RegExp} regexp
-   * @param {String} message
+   * @param {Function} fn
+   * @param {Error} errt
+   * @param {RegExp} errs
+   * @param {string} msg
    * @see https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Error#Error_types
@@ -137,5 +145,6 @@ * @namespace Should
    *     var foo = 'hi';
-   *
    *     should.exist(foo, 'foo exists');
    *
+   * @param {unknown} val
+   * @param {string} msg
    * @name exist
@@ -162,8 +171,8 @@ * @namespace Should
    * @param {unknown} expected
-   * @param {String} message
+   * @param {string} msg
    * @namespace Should
    * @public
    */
-  should.not.equal = function (val1, val2, msg) {
-    new Assertion(val1, msg).to.not.equal(val2);
+  should.not.equal = function (actual, expected, msg) {
+    new Assertion(actual, msg).to.not.equal(expected);
   };
@@ -182,6 +191,6 @@
    * @alias not.Throw
-   * @param {Function} function
-   * @param {ErrorConstructor} constructor
-   * @param {RegExp} regexp
-   * @param {String} message
+   * @param {Function} fn
+   * @param {Error} errt
+   * @param {RegExp} errs
+   * @param {string} msg
    * @see https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Error#Error_types
@@ -201,7 +210,8 @@ * @namespace Should
    *     var bar = null;
-   *
    *     should.not.exist(bar, 'bar does not exist');
    *
+   * @namespace Should
    * @name not.exist
-   * @namespace Should
+   * @param {unknown} val
+   * @param {string} msg
    * @public
@@ -208,0 +218,0 @@ */

lib/chai/utils/addChainableMethod.js

@@ -46,4 +46,4 @@ /*!
  *     utils.addChainableMethod(chai.Assertion.prototype, 'foo', function (str) {
- *       var obj = utils.flag(this, 'object');
- *       new chai.Assertion(obj).to.be.equal(str);
+ *         var obj = utils.flag(this, 'object');
+ *         new chai.Assertion(obj).to.be.equal(str);
  *     });
@@ -61,4 +61,4 @@ *
  *
- * @param {Object} ctx object to which the method is added
- * @param {String} name of method to add
+ * @param {object} ctx object to which the method is added
+ * @param {string} name of method to add
  * @param {Function} method function to be used for `name`, when called
@@ -68,5 +68,4 @@ * @param {Function} chainingBehavior function to be called every time the property is accessed
  * @name addChainableMethod
- * @api public
+ * @public
  */
-
 export function addChainableMethod(ctx, name, method, chainingBehavior) {
@@ -73,0 +72,0 @@ if (typeof chainingBehavior !== 'function') {

lib/chai/utils/addLengthGuard.js

@@ -37,8 +37,8 @@ const fnLengthDesc = Object.getOwnPropertyDescriptor(function () {}, 'length');
  * @param {Function} fn
- * @param {String} assertionName
- * @param {Boolean} isChainable
+ * @param {string} assertionName
+ * @param {boolean} isChainable
+ * @returns {unknown}
  * @namespace Utils
  * @name addLengthGuard
  */
-
 export function addLengthGuard(fn, assertionName, isChainable) {
@@ -45,0 +45,0 @@ if (!fnLengthDesc.configurable) return fn;

lib/chai/utils/addMethod.js

@@ -19,4 +19,4 @@ /*!
  *     utils.addMethod(chai.Assertion.prototype, 'foo', function (str) {
- *       var obj = utils.flag(this, 'object');
- *       new chai.Assertion(obj).to.be.equal(str);
+ *         var obj = utils.flag(this, 'object');
+ *         new chai.Assertion(obj).to.be.equal(str);
  *     });
@@ -32,10 +32,9 @@ *
  *
- * @param {Object} ctx object to which the method is added
- * @param {String} name of method to add
+ * @param {object} ctx object to which the method is added
+ * @param {string} name of method to add
  * @param {Function} method function to be used for name
  * @namespace Utils
  * @name addMethod
- * @api public
+ * @public
  */
-
 export function addMethod(ctx, name, method) {
@@ -42,0 +41,0 @@ var methodWrapper = function () {

lib/chai/utils/addProperty.js

@@ -18,4 +18,4 @@ /*!
  *     utils.addProperty(chai.Assertion.prototype, 'foo', function () {
- *       var obj = utils.flag(this, 'object');
- *       new chai.Assertion(obj).to.be.instanceof(Foo);
+ *         var obj = utils.flag(this, 'object');
+ *         new chai.Assertion(obj).to.be.instanceof(Foo);
  *     });
@@ -31,10 +31,9 @@ *
  *
- * @param {Object} ctx object to which the property is added
- * @param {String} name of property to add
+ * @param {object} ctx object to which the property is added
+ * @param {string} name of property to add
  * @param {Function} getter function to be used for name
  * @namespace Utils
  * @name addProperty
- * @api public
+ * @public
  */
-
 export function addProperty(ctx, name, getter) {
@@ -41,0 +40,0 @@ getter = getter === undefined ? function () {} : getter;

lib/chai/utils/compareByInspect.js

@@ -17,12 +17,11 @@ /*!
  *
- * @param {Mixed} first element to compare
- * @param {Mixed} second element to compare
- * @returns {Number} -1 if 'a' should come before 'b'; otherwise 1
+ * @param {unknown} a first element to compare
+ * @param {unknown} b second element to compare
+ * @returns {number} -1 if 'a' should come before 'b'; otherwise 1
  * @name compareByInspect
  * @namespace Utils
- * @api public
+ * @public
  */
-
 export function compareByInspect(a, b) {
   return inspect(a) < inspect(b) ? -1 : 1;
 }

lib/chai/utils/expectTypes.js

@@ -7,2 +7,6 @@ /*!
 
+import {AssertionError} from 'assertion-error';
+import {flag} from './flag.js';
+import {type} from './type-detect.js';
+
 /**
@@ -15,13 +19,8 @@ * ### .expectTypes(obj, types)
  *
- * @param {Mixed} obj constructed Assertion
- * @param {Array} type A list of allowed types for this assertion
+ * @param {unknown} obj constructed Assertion
+ * @param {Array} types A list of allowed types for this assertion
  * @namespace Utils
  * @name expectTypes
- * @api public
+ * @public
  */
-
-import {AssertionError} from 'assertion-error';
-import {flag} from './flag.js';
-import {type} from './type-detect.js';
-
 export function expectTypes(obj, types) {
@@ -28,0 +27,0 @@ var flagMsg = flag(obj, 'message');

lib/chai/utils/flag.js

@@ -18,10 +18,10 @@ /*!
  *
- * @param {Object} object constructed Assertion
- * @param {String} key
- * @param {Mixed} value (optional)
+ * @param {object} obj object constructed Assertion
+ * @param {string} key
+ * @param {unknown} value (optional)
  * @namespace Utils
  * @name flag
- * @api private
+ * @returns {unknown | undefined}
+ * @private
  */
-
 export function flag(obj, key, value) {
@@ -28,0 +28,0 @@ var flags = obj.__flags || (obj.__flags = Object.create(null));

lib/chai/utils/getActual.js

@@ -12,10 +12,10 @@ /*!
  *
- * @param {Object} object (constructed Assertion)
- * @param {Arguments} chai.Assertion.prototype.assert arguments
+ * @param {object} obj object (constructed Assertion)
+ * @param {unknown} args chai.Assertion.prototype.assert arguments
+ * @returns {unknown}
  * @namespace Utils
  * @name getActual
  */
-
 export function getActual(obj, args) {
   return args.length > 4 ? args[4] : obj._obj;
 }

lib/chai/utils/getEnumerableProperties.js

@@ -13,9 +13,8 @@ /*!
  *
- * @param {Object} object
+ * @param {object} object
  * @returns {Array}
  * @namespace Utils
  * @name getEnumerableProperties
- * @api public
+ * @public
  */
-
 module.exports = function getEnumerableProperties(object) {
@@ -22,0 +21,0 @@ var result = [];

lib/chai/utils/getMessage.js

@@ -23,9 +23,9 @@ /*!
  *
- * @param {Object} object (constructed Assertion)
- * @param {Arguments} chai.Assertion.prototype.assert arguments
+ * @param {object} obj object (constructed Assertion)
+ * @param {unknown} args chai.Assertion.prototype.assert arguments
+ * @returns {unknown}
  * @namespace Utils
  * @name getMessage
- * @api public
+ * @public
  */
-
 export function getMessage(obj, args) {
@@ -32,0 +32,0 @@ var negate = flag(obj, 'negate')

lib/chai/utils/getOperator.js

 import {flag} from './flag.js';
 import {type} from './type-detect.js';
 
+/**
+ * @param {unknown} obj
+ * @returns {boolean}
+ */
 function isObjectType(obj) {
@@ -20,9 +24,9 @@ var objectType = type(obj);
  *
- * @param {Object} object (constructed Assertion)
- * @param {Arguments} chai.Assertion.prototype.assert arguments
+ * @param {object} obj object (constructed Assertion)
+ * @param {unknown} args chai.Assertion.prototype.assert arguments
+ * @returns {unknown}
  * @namespace Utils
  * @name getOperator
- * @api public
+ * @public
  */
-
 export function getOperator(obj, args) {
@@ -29,0 +33,0 @@ var operator = flag(obj, 'operator');

lib/chai/utils/getOwnEnumerableProperties.js

@@ -16,11 +16,10 @@ /*!
  *
- * @param {Object} object
+ * @param {object} obj
  * @returns {Array}
  * @namespace Utils
  * @name getOwnEnumerableProperties
- * @api public
+ * @public
  */
-
 export function getOwnEnumerableProperties(obj) {
   return Object.keys(obj).concat(getOwnEnumerablePropertySymbols(obj));
 }

lib/chai/utils/getOwnEnumerablePropertySymbols.js

@@ -14,9 +14,8 @@ /*!
  *
- * @param {Object} object
+ * @param {object} obj
  * @returns {Array}
  * @namespace Utils
  * @name getOwnEnumerablePropertySymbols
- * @api public
+ * @public
  */
-
 export function getOwnEnumerablePropertySymbols(obj) {
@@ -23,0 +22,0 @@ if (typeof Object.getOwnPropertySymbols !== 'function') return [];

lib/chai/utils/getProperties.js

@@ -13,12 +13,14 @@ /*!
  *
- * @param {Object} object
+ * @param {object} object
  * @returns {Array}
  * @namespace Utils
  * @name getProperties
- * @api public
+ * @public
  */
-
 export function getProperties(object) {
   var result = Object.getOwnPropertyNames(object);
 
+  /**
+   * @param {unknown} property
+   */
   function addProperty(property) {
@@ -25,0 +27,0 @@ if (result.indexOf(property) === -1) {

lib/chai/utils/index.js

@@ -43,3 +43,8 @@ /*!
 
-// Function name
+/**
+ * Function name
+ *
+ * @param {Function} fn
+ * @returns {string}
+ */
 export function getName(fn) {
@@ -93,1 +98,12 @@ return fn.name
 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]';
+}

lib/chai/utils/inspect.js

@@ -13,8 +13,9 @@ // This is (almost) directly from Node.js utils
  *
- * @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
@@ -21,0 +22,0 @@ * @name inspect

lib/chai/utils/isNaN.js

@@ -14,7 +14,7 @@ /*!
  *
- * @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) {
@@ -21,0 +21,0 @@ // Refer http://www.ecma-international.org/ecma-262/6.0/#sec-isnan-number

lib/chai/utils/isProxyEnabled.js

@@ -18,4 +18,4 @@ import {config} from '../config.js';
  * @name isProxyEnabled
+ * @returns {boolean}
  */
-
 export function isProxyEnabled() {
@@ -22,0 +22,0 @@ return config.useProxy &&

lib/chai/utils/objDisplay.js

@@ -17,9 +17,8 @@ /*!
  *
- * @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) {
@@ -26,0 +25,0 @@ var str = inspect(obj)

lib/chai/utils/overwriteChainableMethod.js

@@ -19,6 +19,6 @@ /*!
  *     utils.overwriteChainableMethod(chai.Assertion.prototype, 'lengthOf',
- *       function (_super) {
- *       }
- *     , function (_super) {
- *       }
+ *         function (_super) {
+ *         }
+ *         , function (_super) {
+ *         }
  *     );
@@ -35,4 +35,4 @@ *
  *
- * @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
@@ -42,5 +42,4 @@ * @param {Function} chainingBehavior function that returns a function to be used for property
  * @name overwriteChainableMethod
- * @api public
+ * @public
  */
-
 export function overwriteChainableMethod(ctx, name, method, chainingBehavior) {
@@ -47,0 +46,0 @@ var chainableBehavior = ctx.__methods[name];

lib/chai/utils/overwriteMethod.js

@@ -21,10 +21,10 @@ /*!
  *     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);
+ *             }
  *         }
- *       }
  *     });
@@ -40,10 +40,9 @@ *
  *
- * @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) {
@@ -50,0 +49,0 @@ var _method = ctx[name]

lib/chai/utils/overwriteProperty.js

@@ -19,13 +19,12 @@ /*!
  *     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`.
@@ -39,10 +38,9 @@ *
  *
- * @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) {
@@ -49,0 +47,0 @@ var _get = Object.getOwnPropertyDescriptor(ctx, name)

lib/chai/utils/proxify.js

@@ -12,2 +12,4 @@ import {config} from '../config.js';
 
+const builtins = ['__flags', '__methods', '_obj', 'assert'];
+
 /**
@@ -26,10 +28,8 @@ * ### .proxify(object)
  *
- * @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) {
@@ -108,9 +108,9 @@ if (!isProxyEnabled()) return obj;
  * 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) {
@@ -117,0 +117,0 @@ if (Math.abs(strA.length - strB.length) >= cap) {

lib/chai/utils/test.js

@@ -14,8 +14,8 @@ /*!
  *
- * @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) {
@@ -22,0 +22,0 @@ var negate = flag(obj, 'negate')

lib/chai/utils/transferFlags.js

@@ -15,3 +15,2 @@ /*!
  *
- *
  *     var newAssertion = new Assertion();
@@ -23,10 +22,9 @@ *     utils.transferFlags(assertion, newAssertion);
  *
- * @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) {
@@ -33,0 +31,0 @@ var flags = assertion.__flags || (assertion.__flags = Object.create(null));

lib/chai/utils/type-detect.js

@@ -0,1 +1,5 @@
+/**
+ * @param {unknown} obj
+ * @returns {string}
+ */
 export function type(obj) {
@@ -2,0 +6,0 @@ if (typeof obj === 'undefined') {

package.json

@@ -21,3 +21,3 @@ {
   ],
-  "version": "5.1.0",
+  "version": "5.1.1",
   "repository": {
@@ -35,6 +35,7 @@ "type": "git",
     "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"
@@ -47,3 +48,3 @@ },
     "assertion-error": "^2.0.1",
-    "check-error": "^2.0.0",
+    "check-error": "^2.1.1",
     "deep-eql": "^5.0.1",
@@ -59,4 +60,6 @@ "loupe": "^3.1.0",
     "esbuild": "^0.19.10",
+    "eslint": "^8.56.0",
+    "eslint-plugin-jsdoc": "^48.0.4",
     "mocha": "^10.2.0"
   }
 }

README.md

@@ -101,5 +101,5 @@ <h1 align=center>
 ```bash
-mocha spec.js -r chai/register-assert  # Using Assert style
-mocha spec.js -r chai/register-expect  # Using Expect style
-mocha spec.js -r chai/register-should  # Using Should style
+mocha spec.js --require chai/register-assert.js  # Using Assert style
+mocha spec.js --require chai/register-expect.js  # Using Expect style
+mocha spec.js --require chai/register-should.js  # Using Should style
 ```
@@ -106,0 +106,0 @@

web-test-runner.config.js

@@ -8,3 +8,6 @@ import { fromRollup } from "@web/dev-server-rollup";
   nodeResolve: true,
-  files: ["test/*.js"],
+  files: [
+    "test/*.js",
+    "!test/virtual-machines.js"
+  ],
   plugins: [
@@ -11,0 +14,0 @@ commonjs({

No alert changes

Improved metrics

Total package byte prevSize

505610

increased by0.42%

Number of package files

51

increased by2%

Lines of code

12392

increased by1.08%

Worsened metrics

Dev dependency count

8

increased by33.33%

Dependency changes

• Updatedcheck-error@^2.1.1