@vitest/expect 3.0.0-beta.1 → 3.0.0-beta.3

package/dist/index.d.ts

@@ -97,7 +97,29 @@ interface ExpectStatic extends Chai.ExpectStatic, AsymmetricMatchersContaining {
     setState: (state: Partial<MatcherState>) => void;
     not: AsymmetricMatchersContaining;
 }
-interface AsymmetricMatchersContaining {
+interface CustomMatcher {
+    /**
+     * Checks that a value satisfies a custom matcher function.
+     *
+     * @param matcher - A function returning a boolean based on the custom condition
+     * @param message - Optional custom error message on failure
+     *
+     * @example
+     * expect(age).toSatisfy(val => val >= 18, 'Age must be at least 18');
+     * expect(age).toEqual(expect.toSatisfy(val => val >= 18, 'Age must be at least 18'));
+     */
+    toSatisfy: (matcher: (value: any) => boolean, message?: string) => any;
+    /**
+     * Matches if the received value is one of the values in the expected array.
+     *
+     * @example
+     * expect(1).toBeOneOf([1, 2, 3])
+     * expect('foo').toBeOneOf([expect.any(String)])
+     * expect({ a: 1 }).toEqual({ a: expect.toBeOneOf(['1', '2', '3']) })
+     */
+    toBeOneOf: <T>(sample: Array<T>) => any;
+}
+interface AsymmetricMatchersContaining extends CustomMatcher {
     /**
      * Matches if the received string contains the expected substring.
      *
@@ -139,7 +161,7 @@ interface AsymmetricMatchersContaining {
      */
     closeTo: (expected: number, precision?: number) => any;
 }
-interface JestAssertion<T = any> extends jest.Matchers<void, T> {
+interface JestAssertion<T = any> extends jest.Matchers<void, T>, CustomMatcher {
     /**
      * Used when you want to check that two objects have the same value.
      * This matcher recursively checks the equality of all fields, rather than checking for object identity.
@@ -558,16 +580,6 @@ interface Assertion<T = any> extends VitestAssertion<Chai.Assertion, T>, JestAss
      * expect(mockFunc).toHaveBeenCalledExactlyOnceWith('arg1', 42);
      */
     toHaveBeenCalledExactlyOnceWith: <E extends any[]>(...args: E) => void;
-    /**
-     * Checks that a value satisfies a custom matcher function.
-     *
-     * @param matcher - A function returning a boolean based on the custom condition
-     * @param message - Optional custom error message on failure
-     *
-     * @example
-     * expect(age).toSatisfy(val => val >= 18, 'Age must be at least 18');
-     */
-    toSatisfy: <E>(matcher: (value: E) => boolean, message?: string) => void;
     /**
      * This assertion checks if a `Mock` was called before another `Mock`.
      * @param mock - A mock function created by `vi.spyOn` or `vi.fn`
@@ -655,6 +667,8 @@ declare global {
     }
 }
 
+declare const customMatchers: MatchersObject;
+
 interface AsymmetricMatcherInterface {
     asymmetricMatch: (other: unknown) => boolean;
     toString: () => string;
@@ -741,4 +755,4 @@ declare function getObjectSubset(object: any, subset: any, customTesters: Array<
 declare function getState<State extends MatcherState = MatcherState>(expect: ExpectStatic): State;
 declare function setState<State extends MatcherState = MatcherState>(state: Partial<State>, expect: ExpectStatic): void;
 
-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 };
+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, customMatchers, equals, fnNameFor, generateToBeMessage, getObjectKeys, getObjectSubset, getState, hasAsymmetric, hasProperty, isA, isAsymmetric, isImmutableUnorderedKeyed, isImmutableUnorderedSet, iterableEquality, pluralize, setState, sparseArrayEquality, subsetEquality, typeEquality };

package/dist/index.js

@@ -12,6 +12,55 @@ const ASYMMETRIC_MATCHERS_OBJECT = Symbol.for(
   "asymmetric-matchers-object"
 );
 
+const customMatchers = {
+  toSatisfy(actual, expected, message) {
+    const { printReceived, printExpected, matcherHint } = this.utils;
+    const pass = expected(actual);
+    return {
+      pass,
+      message: () => pass ? `${matcherHint(".not.toSatisfy", "received", "")}
+
+Expected value to not satisfy:
+${message || printExpected(expected)}
+Received:
+${printReceived(actual)}` : `${matcherHint(".toSatisfy", "received", "")}
+
+Expected value to satisfy:
+${message || printExpected(expected)}
+
+Received:
+${printReceived(actual)}`
+    };
+  },
+  toBeOneOf(actual, expected) {
+    const { equals, customTesters } = this;
+    const { printReceived, printExpected, matcherHint } = this.utils;
+    if (!Array.isArray(expected)) {
+      throw new TypeError(
+        `You must provide an array to ${matcherHint(".toBeOneOf")}, not '${typeof expected}'.`
+      );
+    }
+    const pass = expected.length === 0 || expected.some(
+      (item) => equals(item, actual, customTesters)
+    );
+    return {
+      pass,
+      message: () => pass ? `${matcherHint(".not.toBeOneOf", "received", "")}
+
+Expected value to not be one of:
+${printExpected(expected)}
+Received:
+${printReceived(actual)}` : `${matcherHint(".toBeOneOf", "received", "")}
+
+Expected value to be one of:
+${printExpected(expected)}
+
+Received:
+${printReceived(actual)}`
+    };
+  }
+};
+
 const EXPECTED_COLOR = c.green;
 const RECEIVED_COLOR = c.red;
 const INVERTED_COLOR = c.inverse;
@@ -164,9 +213,6 @@ function eq(a, b, aStack, bStack, customTesters, hasKey2) {
       return customTesterResult;
     }
   }
-  if (a instanceof Error && b instanceof Error) {
-    return a.message === b.message;
-  }
   if (typeof URL === "function" && a instanceof URL && b instanceof URL) {
     return a.href === b.href;
   }
@@ -219,6 +265,14 @@ function eq(a, b, aStack, bStack, customTesters, hasKey2) {
   if (className === "[object Array]" && a.length !== b.length) {
     return false;
   }
+  if (a instanceof Error && b instanceof Error) {
+    try {
+      return isErrorEqual(a, b, aStack, bStack, customTesters, hasKey2);
+    } finally {
+      aStack.pop();
+      bStack.pop();
+    }
+  }
   const aKeys = keys(a, hasKey2);
   let key;
   let size = aKeys.length;
@@ -236,6 +290,17 @@ function eq(a, b, aStack, bStack, customTesters, hasKey2) {
   bStack.pop();
   return result;
 }
+function isErrorEqual(a, b, aStack, bStack, customTesters, hasKey2) {
+  let result = Object.getPrototypeOf(a) === Object.getPrototypeOf(b) && a.name === b.name && a.message === b.message;
+  if (typeof b.cause !== "undefined") {
+    result && (result = eq(a.cause, b.cause, aStack, bStack, customTesters, hasKey2));
+  }
+  if (a instanceof AggregateError && b instanceof AggregateError) {
+    result && (result = eq(a.errors, b.errors, aStack, bStack, customTesters, hasKey2));
+  }
+  result && (result = eq({ ...a }, { ...b }, aStack, bStack, customTesters, hasKey2));
+  return result;
+}
 function keys(obj, hasKey2) {
   const keys2 = [];
   for (const key in obj) {
@@ -1625,12 +1690,16 @@ const JestChaiExpect = (chai, utils) => {
         );
       }
       if (expected instanceof Error) {
+        const equal = equals(thrown, expected, [
+          ...customTesters,
+          iterableEquality
+        ]);
         return this.assert(
-          thrown && expected.message === thrown.message,
-          `expected error to have message: ${expected.message}`,
-          `expected error not to have message: ${expected.message}`,
-          expected.message,
-          thrown && thrown.message
+          equal,
+          "expected a thrown error to be #{exp}",
+          "expected a thrown error not to be #{exp}",
+          expected,
+          thrown
         );
       }
       if (typeof expected === "object" && "asymmetricMatch" in expected && typeof expected.asymmetricMatch === "function") {
@@ -1804,9 +1873,6 @@ const JestChaiExpect = (chai, utils) => {
       );
     });
   });
-  def("toSatisfy", function(matcher, message) {
-    return this.be.satisfy(matcher, message);
-  });
   def("withContext", function(context) {
     for (const key in context) {
       utils.flag(this, key, context[key]);
@@ -2100,7 +2166,7 @@ function JestExtendPlugin(c, expect, matchers) {
             return "any";
           }
           toAsymmetricMatcher() {
-            return `${this.toString()}<${this.sample.map(String).join(", ")}>`;
+            return `${this.toString()}<${this.sample.map((item) => stringify(item)).join(", ")}>`;
           }
         }
         const customMatcher = (...sample) => new CustomMatcher(false, ...sample);
@@ -2140,4 +2206,4 @@ const JestExtend = (chai, utils) => {
   );
 };
 
-export { ASYMMETRIC_MATCHERS_OBJECT, Any, Anything, ArrayContaining, AsymmetricMatcher, GLOBAL_EXPECT, JEST_MATCHERS_OBJECT, JestAsymmetricMatchers, JestChaiExpect, JestExtend, MATCHERS_OBJECT, ObjectContaining, StringContaining, StringMatching, addCustomEqualityTesters, arrayBufferEquality, equals, fnNameFor, generateToBeMessage, getObjectKeys, getObjectSubset, getState, hasAsymmetric, hasProperty, isA, isAsymmetric, isImmutableUnorderedKeyed, isImmutableUnorderedSet, iterableEquality, pluralize, setState, sparseArrayEquality, subsetEquality, typeEquality };
+export { ASYMMETRIC_MATCHERS_OBJECT, Any, Anything, ArrayContaining, AsymmetricMatcher, GLOBAL_EXPECT, JEST_MATCHERS_OBJECT, JestAsymmetricMatchers, JestChaiExpect, JestExtend, MATCHERS_OBJECT, ObjectContaining, StringContaining, StringMatching, addCustomEqualityTesters, arrayBufferEquality, customMatchers, equals, fnNameFor, generateToBeMessage, getObjectKeys, getObjectSubset, getState, hasAsymmetric, hasProperty, isA, isAsymmetric, isImmutableUnorderedKeyed, isImmutableUnorderedSet, iterableEquality, pluralize, setState, sparseArrayEquality, subsetEquality, typeEquality };

package/package.json

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