@vitest/expect 4.1.2 → 4.1.4

package/dist/index.d.ts

@@ -1,4 +1,3 @@
-import { Test } from '@vitest/runner';
 import { MockInstance } from '@vitest/spy';
 import { Formatter } from 'tinyrainbow';
 import { StandardSchemaV1 } from '@standard-schema/spec';
@@ -157,7 +156,12 @@ interface MatcherState {
 	};
 	soft?: boolean;
 	poll?: boolean;
-	task?: Readonly<Test>;
+	/**
+	* The same assertion instance that chai plugins receive.
+	* @experimental
+	* @see {@link https://www.chaijs.com/guide/plugins/} Core Plugin Concepts
+	*/
+	readonly assertion: Assertion;
 }
 interface SyncExpectationResult {
 	pass: boolean;
@@ -917,8 +921,9 @@ declare function isStandardSchema(obj: any): obj is StandardSchemaV1;
 declare function getState<State extends MatcherState = MatcherState>(expect: ExpectStatic): State;
 declare function setState<State extends MatcherState = MatcherState>(state: Partial<State>, expect: ExpectStatic): void;
 
-declare function createAssertionMessage(util: Chai.ChaiUtils, assertion: Assertion, hasArgs: boolean): string;
+declare function createAssertionMessage(util: Chai.ChaiUtils, assertion: Chai.Assertion, hasArgs: boolean): string;
 declare function recordAsyncExpect(_test: any, promise: Promise<any>, assertion: string, error: Error, isSoft?: boolean): Promise<any>;
+/** wrap assertion function to support `expect.soft` and provide assertion name as `_name` */
 declare function wrapAssertion(utils: Chai.ChaiUtils, name: string, fn: (this: Chai.AssertionStatic & Assertion, ...args: any[]) => void | PromiseLike<void>): (this: Chai.AssertionStatic & Assertion, ...args: any[]) => void | PromiseLike<void>;
 
 export { ASYMMETRIC_MATCHERS_OBJECT, Any, Anything, ArrayContaining, AsymmetricMatcher, ChaiStyleAssertions, GLOBAL_EXPECT, JEST_MATCHERS_OBJECT, JestAsymmetricMatchers, JestChaiExpect, JestExtend, MATCHERS_OBJECT, ObjectContaining, SchemaMatching, StringContaining, StringMatching, addCustomEqualityTesters, arrayBufferEquality, createAssertionMessage, customMatchers, equals, fnNameFor, generateToBeMessage, getObjectKeys, getObjectSubset, getState, hasAsymmetric, hasProperty, isA, isAsymmetric, isError, isImmutableUnorderedKeyed, isImmutableUnorderedSet, isStandardSchema, iterableEquality, pluralize, recordAsyncExpect, setState, sparseArrayEquality, subsetEquality, typeEquality, wrapAssertion };

package/dist/index.js

@@ -1142,6 +1142,7 @@ function handleTestError(test, err) {
 	test.result.errors ||= [];
 	test.result.errors.push(processError(err));
 }
+/** wrap assertion function to support `expect.soft` and provide assertion name as `_name` */
 function wrapAssertion(utils, name, fn) {
 	return function(...args) {
 		// private
@@ -1836,7 +1837,6 @@ function getMatcherState(assertion, expect) {
 	}
 	const matcherState = {
 		...getState(expect),
-		task,
 		currentTestName,
 		customTesters: getCustomEqualityTesters(),
 		isNot,
@@ -1845,8 +1845,10 @@ function getMatcherState(assertion, expect) {
 		equals,
 		suppressedErrors: [],
 		soft: util.flag(assertion, "soft"),
-		poll: util.flag(assertion, "poll")
+		poll: util.flag(assertion, "poll"),
+		assertion
 	};
+	Object.assign(matcherState, { task });
 	return {
 		state: matcherState,
 		isNot,
@@ -1855,24 +1857,24 @@ function getMatcherState(assertion, expect) {
 	};
 }
 class JestExtendError extends Error {
-	constructor(message, actual, expected, context) {
+	constructor(message, actual, expected, __vitest_error_context__) {
 		super(message);
 		this.actual = actual;
 		this.expected = expected;
-		this.context = context;
+		this.__vitest_error_context__ = __vitest_error_context__;
 	}
 }
 function JestExtendPlugin(c, expect, matchers) {
 	return (_, utils) => {
 		Object.entries(matchers).forEach(([expectAssertionName, expectAssertion]) => {
-			function expectWrapper(...args) {
+			function __VITEST_EXTEND_ASSERTION__(...args) {
 				const { state, isNot, obj, customMessage } = getMatcherState(this, expect);
 				const result = expectAssertion.call(state, obj, ...args);
 				if (result && typeof result === "object" && typeof result.then === "function") {
 					const thenable = result;
 					return thenable.then(({ pass, message, actual, expected, meta }) => {
 						if (pass && isNot || !pass && !isNot) {
-							const errorMessage = customMessage != null ? customMessage : message();
+							const errorMessage = (customMessage ? `${customMessage}: ` : "") + message();
 							throw new JestExtendError(errorMessage, actual, expected, {
 								assertionName: expectAssertionName,
 								meta
@@ -1882,16 +1884,23 @@ function JestExtendPlugin(c, expect, matchers) {
 				}
 				const { pass, message, actual, expected, meta } = result;
 				if (pass && isNot || !pass && !isNot) {
-					const errorMessage = customMessage != null ? customMessage : message();
+					const errorMessage = (customMessage ? `${customMessage}: ` : "") + message();
 					throw new JestExtendError(errorMessage, actual, expected, {
 						assertionName: expectAssertionName,
 						meta
 					});
 				}
 			}
-			const softWrapper = wrapAssertion(utils, expectAssertionName, expectWrapper);
+			const softWrapper = wrapAssertion(utils, expectAssertionName, __VITEST_EXTEND_ASSERTION__);
 			utils.addMethod(globalThis[JEST_MATCHERS_OBJECT].matchers, expectAssertionName, softWrapper);
 			utils.addMethod(c.Assertion.prototype, expectAssertionName, softWrapper);
+			// `expect.poll()` inspects the installed Chai assertion method,
+			// so copy the internal marker from the original matcher function.
+			// this is only for domain snapshot matchers for now.
+			if (expectAssertion.__vitest_poll_takeover__) {
+				const addedMethod = c.Assertion.prototype[expectAssertionName];
+				Object.defineProperty(addedMethod, "__vitest_poll_takeover__", { value: true });
+			}
 			class CustomMatcher extends AsymmetricMatcher {
 				constructor(inverse = false, ...sample) {
 					super(sample, inverse);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vitest/expect",
   "type": "module",
-  "version": "4.1.2",
+  "version": "4.1.4",
   "description": "Jest's expect matchers as a Chai plugin",
   "license": "MIT",
   "funding": "https://opencollective.com/vitest",
@@ -39,11 +39,11 @@
     "@types/chai": "^5.2.2",
     "chai": "^6.2.2",
     "tinyrainbow": "^3.1.0",
-    "@vitest/spy": "4.1.2",
-    "@vitest/utils": "4.1.2"
+    "@vitest/spy": "4.1.4",
+    "@vitest/utils": "4.1.4"
   },
   "devDependencies": {
-    "@vitest/runner": "4.1.2"
+    "@vitest/runner": "4.1.4"
   },
   "scripts": {
     "build": "premove dist && rollup -c",