@vitest/expect 2.1.2 → 2.1.4

package/README.md

@@ -5,12 +5,12 @@ Jest's expect matchers as a Chai plugin.
 ## Usage
 
 ```js
-import * as chai from 'chai'
 import {
   JestAsymmetricMatchers,
   JestChaiExpect,
   JestExtend,
 } from '@vitest/expect'
+import * as chai from 'chai'
 
 // allows using expect.extend instead of chai.use to extend plugins
 chai.use(JestExtend)

package/dist/index.d.ts

@@ -1,9 +1,14 @@
+import { stringify, Constructable } from '@vitest/utils';
 import * as tinyrainbow from 'tinyrainbow';
 import { Formatter } from 'tinyrainbow';
-import { stringify, Constructable } from '@vitest/utils';
 import { diff, printDiffOrStringify } from '@vitest/utils/diff';
 export { DiffOptions } from '@vitest/utils/diff';
 
+declare const MATCHERS_OBJECT: unique symbol;
+declare const JEST_MATCHERS_OBJECT: unique symbol;
+declare const GLOBAL_EXPECT: unique symbol;
+declare const ASYMMETRIC_MATCHERS_OBJECT: unique symbol;
+
 declare function matcherHint(matcherName: string, received?: string, expected?: string, options?: MatcherHintOptions): string;
 declare function printReceived(object: unknown): string;
 declare function printExpected(value: unknown): string;
@@ -227,6 +232,10 @@ declare class StringMatching extends AsymmetricMatcher<RegExp> {
 }
 declare const JestAsymmetricMatchers: ChaiPlugin;
 
+declare const JestChaiExpect: ChaiPlugin;
+
+declare const JestExtend: ChaiPlugin;
+
 declare function equals(a: unknown, b: unknown, customTesters?: Array<Tester>, strictCheck?: boolean): boolean;
 declare function isAsymmetric(obj: any): boolean;
 declare function hasAsymmetric(obj: any, seen?: Set<unknown>): boolean;
@@ -243,21 +252,12 @@ declare function sparseArrayEquality(a: unknown, b: unknown, customTesters?: Arr
 declare function generateToBeMessage(deepEqualityName: string, expected?: string, actual?: string): string;
 declare function pluralize(word: string, count: number): string;
 declare function getObjectKeys(object: object): Array<string | symbol>;
-declare function getObjectSubset(object: any, subset: any, customTesters?: Array<Tester>): {
+declare function getObjectSubset(object: any, subset: any, customTesters: Array<Tester>): {
     subset: any;
     stripped: number;
 };
 
-declare const MATCHERS_OBJECT: unique symbol;
-declare const JEST_MATCHERS_OBJECT: unique symbol;
-declare const GLOBAL_EXPECT: unique symbol;
-declare const ASYMMETRIC_MATCHERS_OBJECT: unique symbol;
-
 declare function getState<State extends MatcherState = MatcherState>(expect: ExpectStatic): State;
 declare function setState<State extends MatcherState = MatcherState>(state: Partial<State>, expect: ExpectStatic): void;
 
-declare const JestChaiExpect: ChaiPlugin;
-
-declare const JestExtend: ChaiPlugin;
-
 export { ASYMMETRIC_MATCHERS_OBJECT, Any, Anything, ArrayContaining, type Assertion, AsymmetricMatcher, type AsymmetricMatcherInterface, type AsymmetricMatchersContaining, type AsyncExpectationResult, type ChaiPlugin, type ExpectStatic, type ExpectationResult, GLOBAL_EXPECT, JEST_MATCHERS_OBJECT, type JestAssertion, JestAsymmetricMatchers, JestChaiExpect, JestExtend, MATCHERS_OBJECT, type MatcherHintOptions, type MatcherState, type MatchersObject, ObjectContaining, type PromisifyAssertion, type RawMatcherFn, StringContaining, StringMatching, type SyncExpectationResult, type Tester, type TesterContext, addCustomEqualityTesters, arrayBufferEquality, equals, fnNameFor, generateToBeMessage, getObjectKeys, getObjectSubset, getState, hasAsymmetric, hasProperty, isA, isAsymmetric, isImmutableUnorderedKeyed, isImmutableUnorderedSet, iterableEquality, pluralize, setState, sparseArrayEquality, subsetEquality, typeEquality };

package/dist/index.js

@@ -1,6 +1,6 @@
 import { getType, stringify, isObject, assertTypes } from '@vitest/utils';
-import c from 'tinyrainbow';
 import { diff, printDiffOrStringify } from '@vitest/utils/diff';
+import c from 'tinyrainbow';
 import { isMockFunction } from '@vitest/spy';
 import { processError } from '@vitest/utils/error';
 import { use, util } from 'chai';
@@ -12,39 +12,6 @@ const ASYMMETRIC_MATCHERS_OBJECT = Symbol.for(
   "asymmetric-matchers-object"
 );
 
-if (!Object.prototype.hasOwnProperty.call(globalThis, MATCHERS_OBJECT)) {
-  const globalState = /* @__PURE__ */ new WeakMap();
-  const matchers = /* @__PURE__ */ Object.create(null);
-  const customEqualityTesters = [];
-  const assymetricMatchers = /* @__PURE__ */ Object.create(null);
-  Object.defineProperty(globalThis, MATCHERS_OBJECT, {
-    get: () => globalState
-  });
-  Object.defineProperty(globalThis, JEST_MATCHERS_OBJECT, {
-    configurable: true,
-    get: () => ({
-      state: globalState.get(globalThis[GLOBAL_EXPECT]),
-      matchers,
-      customEqualityTesters
-    })
-  });
-  Object.defineProperty(globalThis, ASYMMETRIC_MATCHERS_OBJECT, {
-    get: () => assymetricMatchers
-  });
-}
-function getState(expect) {
-  return globalThis[MATCHERS_OBJECT].get(expect);
-}
-function setState(state, expect) {
-  const map = globalThis[MATCHERS_OBJECT];
-  const current = map.get(expect) || {};
-  const results = Object.defineProperties(current, {
-    ...Object.getOwnPropertyDescriptors(current),
-    ...Object.getOwnPropertyDescriptors(state)
-  });
-  map.set(expect, results);
-}
-
 const EXPECTED_COLOR = c.green;
 const RECEIVED_COLOR = c.red;
 const INVERTED_COLOR = c.inverse;
@@ -229,6 +196,7 @@ function eq(a, b, aStack, bStack, customTesters, hasKey2) {
       const numB = +b;
       return numA === numB || Number.isNaN(numA) && Number.isNaN(numB);
     }
+    // RegExps are compared by their source patterns and flags.
     case "[object RegExp]":
       return a.source === b.source && a.flags === b.flags;
   }
@@ -555,7 +523,7 @@ function getObjectKeys(object) {
     )
   ];
 }
-function getObjectSubset(object, subset, customTesters = []) {
+function getObjectSubset(object, subset, customTesters) {
   let stripped = 0;
   const getObjectSubsetWithContext = (seenReferences = /* @__PURE__ */ new WeakMap()) => (object2, subset2) => {
     if (Array.isArray(object2)) {
@@ -576,6 +544,12 @@ function getObjectSubset(object, subset, customTesters = []) {
       }
       const trimmed = {};
       seenReferences.set(object2, trimmed);
+      if (typeof object2.constructor === "function" && typeof object2.constructor.name === "string") {
+        Object.defineProperty(trimmed, "constructor", {
+          enumerable: false,
+          value: object2.constructor
+        });
+      }
       for (const key of getObjectKeys(object2)) {
         if (hasPropertyInObject(subset2, key)) {
           trimmed[key] = seenReferences.has(object2[key]) ? seenReferences.get(object2[key]) : getObjectSubsetWithContext(seenReferences)(
@@ -604,6 +578,39 @@ function getObjectSubset(object, subset, customTesters = []) {
   return { subset: getObjectSubsetWithContext()(object, subset), stripped };
 }
 
+if (!Object.prototype.hasOwnProperty.call(globalThis, MATCHERS_OBJECT)) {
+  const globalState = /* @__PURE__ */ new WeakMap();
+  const matchers = /* @__PURE__ */ Object.create(null);
+  const customEqualityTesters = [];
+  const assymetricMatchers = /* @__PURE__ */ Object.create(null);
+  Object.defineProperty(globalThis, MATCHERS_OBJECT, {
+    get: () => globalState
+  });
+  Object.defineProperty(globalThis, JEST_MATCHERS_OBJECT, {
+    configurable: true,
+    get: () => ({
+      state: globalState.get(globalThis[GLOBAL_EXPECT]),
+      matchers,
+      customEqualityTesters
+    })
+  });
+  Object.defineProperty(globalThis, ASYMMETRIC_MATCHERS_OBJECT, {
+    get: () => assymetricMatchers
+  });
+}
+function getState(expect) {
+  return globalThis[MATCHERS_OBJECT].get(expect);
+}
+function setState(state, expect) {
+  const map = globalThis[MATCHERS_OBJECT];
+  const current = map.get(expect) || {};
+  const results = Object.defineProperties(current, {
+    ...Object.getOwnPropertyDescriptors(current),
+    ...Object.getOwnPropertyDescriptors(state)
+  });
+  map.set(expect, results);
+}
+
 class AsymmetricMatcher {
   constructor(sample, inverse = false) {
     this.sample = sample;
@@ -916,9 +923,10 @@ function recordAsyncExpect(test, promise) {
   }
   return promise;
 }
-function wrapSoft(utils, fn) {
+function wrapAssertion(utils, name, fn) {
   return function(...args) {
     var _a;
+    utils.flag(this, "_name", name);
     if (!utils.flag(this, "soft")) {
       return fn.apply(this, args);
     }
@@ -942,7 +950,7 @@ const JestChaiExpect = (chai, utils) => {
   const customTesters = getCustomEqualityTesters();
   function def(name, fn) {
     const addMethod = (n) => {
-      const softWrapper = wrapSoft(utils, fn);
+      const softWrapper = wrapAssertion(utils, n, fn);
       utils.addMethod(chai.Assertion.prototype, n, softWrapper);
       utils.addMethod(
         globalThis[JEST_MATCHERS_OBJECT].matchers,
@@ -1068,7 +1076,8 @@ const JestChaiExpect = (chai, utils) => {
     const isNot = utils.flag(this, "negate");
     const { subset: actualSubset, stripped } = getObjectSubset(
       actual,
-      expected
+      expected,
+      customTesters
     );
     if (pass && isNot || !pass && !isNot) {
       const msg = utils.getMessage(this, [
@@ -1163,8 +1172,8 @@ const JestChaiExpect = (chai, utils) => {
       Boolean(obj),
       "expected #{this} to be truthy",
       "expected #{this} to not be truthy",
-      obj,
-      false
+      true,
+      obj
     );
   });
   def("toBeFalsy", function() {
@@ -1173,8 +1182,8 @@ const JestChaiExpect = (chai, utils) => {
       !obj,
       "expected #{this} to be falsy",
       "expected #{this} to not be falsy",
-      obj,
-      false
+      false,
+      obj
     );
   });
   def("toBeGreaterThan", function(expected) {
@@ -1185,8 +1194,8 @@ const JestChaiExpect = (chai, utils) => {
       actual > expected,
       `expected ${actual} to be greater than ${expected}`,
       `expected ${actual} to be not greater than ${expected}`,
-      actual,
       expected,
+      actual,
       false
     );
   });
@@ -1198,8 +1207,8 @@ const JestChaiExpect = (chai, utils) => {
       actual >= expected,
       `expected ${actual} to be greater than or equal to ${expected}`,
       `expected ${actual} to be not greater than or equal to ${expected}`,
-      actual,
       expected,
+      actual,
       false
     );
   });
@@ -1211,8 +1220,8 @@ const JestChaiExpect = (chai, utils) => {
       actual < expected,
       `expected ${actual} to be less than ${expected}`,
       `expected ${actual} to be not less than ${expected}`,
-      actual,
       expected,
+      actual,
       false
     );
   });
@@ -1224,19 +1233,40 @@ const JestChaiExpect = (chai, utils) => {
       actual <= expected,
       `expected ${actual} to be less than or equal to ${expected}`,
       `expected ${actual} to be not less than or equal to ${expected}`,
-      actual,
       expected,
+      actual,
       false
     );
   });
   def("toBeNaN", function() {
-    return this.be.NaN;
+    const obj = utils.flag(this, "object");
+    this.assert(
+      Number.isNaN(obj),
+      "expected #{this} to be NaN",
+      "expected #{this} not to be NaN",
+      Number.NaN,
+      obj
+    );
   });
   def("toBeUndefined", function() {
-    return this.be.undefined;
+    const obj = utils.flag(this, "object");
+    this.assert(
+      void 0 === obj,
+      "expected #{this} to be undefined",
+      "expected #{this} not to be undefined",
+      void 0,
+      obj
+    );
   });
   def("toBeNull", function() {
-    return this.be.null;
+    const obj = utils.flag(this, "object");
+    this.assert(
+      obj === null,
+      "expected #{this} to be null",
+      "expected #{this} not to be null",
+      null,
+      obj
+    );
   });
   def("toBeDefined", function() {
     const obj = utils.flag(this, "object");
@@ -1435,7 +1465,7 @@ const JestChaiExpect = (chai, utils) => {
     ["toThrow", "toThrowError"],
     function(expected) {
       if (typeof expected === "string" || typeof expected === "undefined" || expected instanceof RegExp) {
-        return this.throws(expected);
+        return this.throws(expected === "" ? /^$/ : expected);
       }
       const obj = this._obj;
       const promise = utils.flag(this, "promise");
@@ -1913,7 +1943,7 @@ function JestExtendPlugin(c, expect, matchers) {
             throw new JestExtendError(message(), actual, expected);
           }
         }
-        const softWrapper = wrapSoft(utils, expectWrapper);
+        const softWrapper = wrapAssertion(utils, expectAssertionName, expectWrapper);
         utils.addMethod(
           globalThis[JEST_MATCHERS_OBJECT].matchers,
           expectAssertionName,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vitest/expect",
   "type": "module",
-  "version": "2.1.2",
+  "version": "2.1.4",
   "description": "Jest's expect matchers as a Chai plugin",
   "license": "MIT",
   "funding": "https://opencollective.com/vitest",
@@ -30,15 +30,15 @@
     "dist"
   ],
   "dependencies": {
-    "chai": "^5.1.1",
+    "chai": "^5.1.2",
     "tinyrainbow": "^1.2.0",
-    "@vitest/spy": "2.1.2",
-    "@vitest/utils": "2.1.2"
+    "@vitest/spy": "2.1.4",
+    "@vitest/utils": "2.1.4"
   },
   "devDependencies": {
     "@types/chai": "4.3.6",
     "rollup-plugin-copy": "^3.5.0",
-    "@vitest/runner": "2.1.2"
+    "@vitest/runner": "2.1.4"
   },
   "scripts": {
     "build": "rimraf dist && rollup -c",