@vitest/expect 0.31.4 → 0.32.1

package/dist/index.d.ts

@@ -1,6 +1,8 @@
 import { use } from 'chai';
 import { stringify, Constructable } from '@vitest/utils';
 export { setupColors } from '@vitest/utils';
+import { diff } from '@vitest/utils/diff';
+export { DiffOptions } from '@vitest/utils/diff';
 
 type Formatter = (input: string | number | null | undefined) => string;
 
@@ -34,11 +36,11 @@ declare function getMatcherUtils(): {
     printReceived: (object: unknown) => string;
     printExpected: (value: unknown) => string;
 };
-declare function diff(a: any, b: any, options?: DiffOptions): string;
 
 type FirstFunctionArgument<T> = T extends (arg: infer A) => unknown ? A : never;
 type ChaiPlugin = FirstFunctionArgument<typeof use>;
 type Tester = (a: any, b: any) => boolean | undefined;
+
 interface MatcherHintOptions {
     comment?: string;
     expectedColor?: Formatter;
@@ -49,27 +51,6 @@ interface MatcherHintOptions {
     secondArgument?: string;
     secondArgumentColor?: Formatter;
 }
-interface DiffOptions {
-    aAnnotation?: string;
-    aColor?: Formatter;
-    aIndicator?: string;
-    bAnnotation?: string;
-    bColor?: Formatter;
-    bIndicator?: string;
-    changeColor?: Formatter;
-    changeLineTrailingSpaceColor?: Formatter;
-    commonColor?: Formatter;
-    commonIndicator?: string;
-    commonLineTrailingSpaceColor?: Formatter;
-    contextLines?: number;
-    emptyFirstOrLastLinePlaceholder?: string;
-    expand?: boolean;
-    includeChangeCounts?: boolean;
-    omitAnnotationLines?: boolean;
-    patchColor?: Formatter;
-    compareKeys?: any;
-    showLegend?: boolean;
-}
 interface MatcherState {
     assertionCalls: number;
     currentTestName?: string;
@@ -91,6 +72,7 @@ interface MatcherState {
         iterableEquality: Tester;
         subsetEquality: Tester;
     };
+    soft?: boolean;
 }
 interface SyncExpectationResult {
     pass: boolean;
@@ -106,6 +88,8 @@ interface RawMatcherFn<T extends MatcherState = MatcherState> {
 type MatchersObject<T extends MatcherState = MatcherState> = Record<string, RawMatcherFn<T>>;
 interface ExpectStatic extends Chai.ExpectStatic, AsymmetricMatchersContaining {
     <T>(actual: T, message?: string): Assertion<T>;
+    unreachable(message?: string): never;
+    soft<T>(actual: T, message?: string): Assertion<T>;
     extend(expects: MatchersObject): void;
     assertions(expected: number): void;
     hasAssertions(): void;
@@ -270,4 +254,4 @@ declare const JestChaiExpect: ChaiPlugin;
 
 declare const JestExtend: ChaiPlugin;
 
-export { Any, Anything, ArrayContaining, Assertion, AsymmetricMatcher, AsymmetricMatcherInterface, AsymmetricMatchersContaining, AsyncExpectationResult, ChaiPlugin, DiffOptions, ExpectStatic, ExpectationResult, FirstFunctionArgument, GLOBAL_EXPECT, JEST_MATCHERS_OBJECT, JestAssertion, JestAsymmetricMatchers, JestChaiExpect, JestExtend, MATCHERS_OBJECT, MatcherHintOptions, MatcherState, MatchersObject, ObjectContaining, RawMatcherFn, StringContaining, StringMatching, SyncExpectationResult, Tester, arrayBufferEquality, equals, fnNameFor, generateToBeMessage, getState, hasAsymmetric, hasProperty, isA, isAsymmetric, isImmutableUnorderedKeyed, isImmutableUnorderedSet, iterableEquality, setState, sparseArrayEquality, subsetEquality, typeEquality };
+export { Any, Anything, ArrayContaining, Assertion, AsymmetricMatcher, AsymmetricMatcherInterface, AsymmetricMatchersContaining, AsyncExpectationResult, ChaiPlugin, ExpectStatic, ExpectationResult, FirstFunctionArgument, GLOBAL_EXPECT, JEST_MATCHERS_OBJECT, JestAssertion, JestAsymmetricMatchers, JestChaiExpect, JestExtend, MATCHERS_OBJECT, MatcherHintOptions, MatcherState, MatchersObject, ObjectContaining, RawMatcherFn, StringContaining, StringMatching, SyncExpectationResult, Tester, arrayBufferEquality, equals, fnNameFor, generateToBeMessage, getState, hasAsymmetric, hasProperty, isA, isAsymmetric, isImmutableUnorderedKeyed, isImmutableUnorderedSet, iterableEquality, setState, sparseArrayEquality, subsetEquality, typeEquality };

package/dist/index.js

@@ -1,8 +1,9 @@
 import { getColors, stringify, isObject, assertTypes } from '@vitest/utils';
 export { setupColors } from '@vitest/utils';
-import { unifiedDiff } from '@vitest/utils/diff';
+import { diff } from '@vitest/utils/diff';
 import { AssertionError, util } from 'chai';
 import { isMockFunction } from '@vitest/spy';
+import { processError } from '@vitest/utils/error';
 
 const MATCHERS_OBJECT = Symbol.for("matchers-object");
 const JEST_MATCHERS_OBJECT = Symbol.for("$$jest-matchers-object");
@@ -100,11 +101,6 @@ function getMatcherUtils() {
     printExpected
   };
 }
-function diff(a, b, options) {
-  return unifiedDiff(b, a, {
-    showLegend: options == null ? void 0 : options.showLegend
-  });
-}
 
 function equals(a, b, customTesters, strictCheck) {
   customTesters = customTesters || [];
@@ -637,13 +633,33 @@ function recordAsyncExpect(test, promise) {
   }
   return promise;
 }
+function wrapSoft(utils, fn) {
+  return function(...args) {
+    var _a;
+    const test = utils.flag(this, "vitest-test");
+    const state = (test == null ? void 0 : test.context._local) ? test.context.expect.getState() : getState(globalThis[GLOBAL_EXPECT]);
+    if (!state.soft)
+      return fn.apply(this, args);
+    if (!test)
+      throw new Error("expect.soft() can only be used inside a test");
+    try {
+      return fn.apply(this, args);
+    } catch (err) {
+      test.result || (test.result = { state: "fail" });
+      test.result.state = "fail";
+      (_a = test.result).errors || (_a.errors = []);
+      test.result.errors.push(processError(err));
+    }
+  };
+}
 
 const JestChaiExpect = (chai, utils) => {
   const c = () => getColors();
   function def(name, fn) {
     const addMethod = (n) => {
-      utils.addMethod(chai.Assertion.prototype, n, fn);
-      utils.addMethod(globalThis[JEST_MATCHERS_OBJECT].matchers, n, fn);
+      const softWrapper = wrapSoft(utils, fn);
+      utils.addMethod(chai.Assertion.prototype, n, softWrapper);
+      utils.addMethod(globalThis[JEST_MATCHERS_OBJECT].matchers, n, softWrapper);
     };
     if (Array.isArray(name))
       name.forEach((n) => addMethod(n));
@@ -788,7 +804,8 @@ const JestChaiExpect = (chai, utils) => {
       Boolean(obj),
       "expected #{this} to be truthy",
       "expected #{this} to not be truthy",
-      obj
+      obj,
+      false
     );
   });
   def("toBeFalsy", function() {
@@ -797,7 +814,8 @@ const JestChaiExpect = (chai, utils) => {
       !obj,
       "expected #{this} to be falsy",
       "expected #{this} to not be falsy",
-      obj
+      obj,
+      false
     );
   });
   def("toBeGreaterThan", function(expected) {
@@ -809,7 +827,8 @@ const JestChaiExpect = (chai, utils) => {
       `expected ${actual} to be greater than ${expected}`,
       `expected ${actual} to be not greater than ${expected}`,
       actual,
-      expected
+      expected,
+      false
     );
   });
   def("toBeGreaterThanOrEqual", function(expected) {
@@ -821,7 +840,8 @@ const JestChaiExpect = (chai, utils) => {
       `expected ${actual} to be greater than or equal to ${expected}`,
       `expected ${actual} to be not greater than or equal to ${expected}`,
       actual,
-      expected
+      expected,
+      false
     );
   });
   def("toBeLessThan", function(expected) {
@@ -833,7 +853,8 @@ const JestChaiExpect = (chai, utils) => {
       `expected ${actual} to be less than ${expected}`,
       `expected ${actual} to be not less than ${expected}`,
       actual,
-      expected
+      expected,
+      false
     );
   });
   def("toBeLessThanOrEqual", function(expected) {
@@ -845,7 +866,8 @@ const JestChaiExpect = (chai, utils) => {
       `expected ${actual} to be less than or equal to ${expected}`,
       `expected ${actual} to be not less than or equal to ${expected}`,
       actual,
-      expected
+      expected,
+      false
     );
   });
   def("toBeNaN", function() {
@@ -921,7 +943,8 @@ const JestChaiExpect = (chai, utils) => {
       `expected #{this} to be close to #{exp}, received difference is ${receivedDiff}, but expected ${expectedDiff}`,
       `expected #{this} to not be close to #{exp}, received difference is ${receivedDiff}, but expected ${expectedDiff}`,
       received,
-      expected
+      expected,
+      false
     );
   });
   const assertIsMock = (assertion) => {
@@ -948,12 +971,13 @@ const JestChaiExpect = (chai, utils) => {
       msg += c().gray(`
 
 Received: 
+
 ${spy.mock.calls.map((callArg, i) => {
-        let methodCall = c().bold(`    ${ordinalOf(i + 1)} ${spy.getMockName()} call:
+        let methodCall = c().bold(`  ${ordinalOf(i + 1)} ${spy.getMockName()} call:
 
 `);
         if (actualCall)
-          methodCall += diff(actualCall, callArg, { showLegend: false });
+          methodCall += diff(actualCall, callArg, { omitAnnotationLines: true });
         else
           methodCall += stringify(callArg).split("\n").map((line) => `    ${line}`).join("\n");
         methodCall += "\n";
@@ -970,12 +994,13 @@ Number of calls: ${c().bold(spy.mock.calls.length)}
     msg += c().gray(`
 
 Received: 
+
 ${spy.mock.results.map((callReturn, i) => {
-      let methodCall = c().bold(`    ${ordinalOf(i + 1)} ${spy.getMockName()} call return:
+      let methodCall = c().bold(`  ${ordinalOf(i + 1)} ${spy.getMockName()} call return:
 
 `);
       if (actualReturn)
-        methodCall += diff(actualReturn, callReturn.value, { showLegend: false });
+        methodCall += diff(actualReturn, callReturn.value, { omitAnnotationLines: true });
       else
         methodCall += stringify(callReturn).split("\n").map((line) => `    ${line}`).join("\n");
       methodCall += "\n";
@@ -996,7 +1021,8 @@ Number of calls: ${c().bold(spy.mock.calls.length)}
       `expected "${spyName}" to be called #{exp} times`,
       `expected "${spyName}" to not be called #{exp} times`,
       number,
-      callCount
+      callCount,
+      false
     );
   });
   def("toHaveBeenCalledOnce", function() {
@@ -1008,7 +1034,8 @@ Number of calls: ${c().bold(spy.mock.calls.length)}
       `expected "${spyName}" to be called once`,
       `expected "${spyName}" to not be called once`,
       1,
-      callCount
+      callCount,
+      false
     );
   });
   def(["toHaveBeenCalled", "toBeCalled"], function() {
@@ -1112,7 +1139,8 @@ Number of calls: ${c().bold(spy.mock.calls.length)}
         `expected error to be instance of ${name}`,
         `expected error not to be instance of ${name}`,
         expected,
-        thrown
+        thrown,
+        false
       );
     }
     if (expected instanceof Error) {
@@ -1131,7 +1159,8 @@ Number of calls: ${c().bold(spy.mock.calls.length)}
         "expected error to match asymmetric matcher",
         "expected error not to match asymmetric matcher",
         matcher.toString(),
-        thrown
+        thrown,
+        false
       );
     }
     throw new Error(`"toThrow" expects string, RegExp, function, Error instance or asymmetric matcher, got "${typeof expected}"`);
@@ -1145,7 +1174,8 @@ Number of calls: ${c().bold(spy.mock.calls.length)}
       `expected "${spyName}" to be successfully called at least once`,
       `expected "${spyName}" to not be successfully called`,
       calledAndNotThrew,
-      !calledAndNotThrew
+      !calledAndNotThrew,
+      false
     );
   });
   def(["toHaveReturnedTimes", "toReturnTimes"], function(times) {
@@ -1157,7 +1187,8 @@ Number of calls: ${c().bold(spy.mock.calls.length)}
       `expected "${spyName}" to be successfully called ${times} times`,
       `expected "${spyName}" to not be successfully called ${times} times`,
       `expected number of returns: ${times}`,
-      `received number of returns: ${successfulReturns}`
+      `received number of returns: ${successfulReturns}`,
+      false
     );
   });
   def(["toHaveReturnedWith", "toReturnWith"], function(value) {
@@ -1322,8 +1353,9 @@ function JestExtendPlugin(expect, matchers) {
         if (pass && isNot || !pass && !isNot)
           throw new JestExtendError(message(), actual, expected);
       }
-      utils.addMethod(globalThis[JEST_MATCHERS_OBJECT].matchers, expectAssertionName, expectWrapper);
-      utils.addMethod(c.Assertion.prototype, expectAssertionName, expectWrapper);
+      const softWrapper = wrapSoft(utils, expectWrapper);
+      utils.addMethod(globalThis[JEST_MATCHERS_OBJECT].matchers, expectAssertionName, softWrapper);
+      utils.addMethod(c.Assertion.prototype, expectAssertionName, softWrapper);
       class CustomMatcher extends AsymmetricMatcher {
         constructor(inverse = false, ...sample) {
           super(sample, inverse);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vitest/expect",
   "type": "module",
-  "version": "0.31.4",
+  "version": "0.32.1",
   "description": "Jest's expect matchers as a Chai plugin",
   "license": "MIT",
   "funding": "https://opencollective.com/vitest",
@@ -30,11 +30,12 @@
   ],
   "dependencies": {
     "chai": "^4.3.7",
-    "@vitest/spy": "0.31.4",
-    "@vitest/utils": "0.31.4"
+    "@vitest/spy": "0.32.1",
+    "@vitest/utils": "0.32.1"
   },
   "devDependencies": {
-    "picocolors": "^1.0.0"
+    "picocolors": "^1.0.0",
+    "@vitest/runner": "0.32.1"
   },
   "scripts": {
     "build": "rimraf dist && rollup -c",