@vitest/runner 0.31.0 → 0.31.2

package/dist/chunk-tasks.js

@@ -85,13 +85,13 @@ function normalizeErrorMessage(message) {
 }
 function processError(err, options = {}) {
   if (!err || typeof err !== "object")
-    return err;
+    return { message: err };
   if (err.stack)
     err.stackStr = String(err.stack);
   if (err.name)
     err.nameStr = String(err.name);
-  const clonedActual = deepClone(err.actual);
-  const clonedExpected = deepClone(err.expected);
+  const clonedActual = deepClone(err.actual, { forceWritable: true });
+  const clonedExpected = deepClone(err.expected, { forceWritable: true });
   const { replacedActual, replacedExpected } = replaceAsymmetricMatcher(clonedActual, clonedExpected);
   if (err.showDiff || err.showDiff === void 0 && err.expected !== void 0 && err.actual !== void 0)
     err.diff = unifiedDiff(replacedActual, replacedExpected, options);
@@ -238,6 +238,9 @@ function createChainable(keys, fn) {
     };
     Object.assign(chain2, fn);
     chain2.withContext = () => chain2.bind(context);
+    chain2.setContext = (key, value) => {
+      context[key] = value;
+    };
     for (const key of keys) {
       Object.defineProperty(chain2, key, {
         get() {

package/dist/index.d.ts

@@ -1,7 +1,7 @@
-import { V as VitestRunner } from './runner-7aa38127.js';
-export { C as CancelReason, a as VitestRunnerConfig, c as VitestRunnerConstructor, b as VitestRunnerImportSource } from './runner-7aa38127.js';
-import { T as Task, F as File, S as SuiteAPI, a as TestAPI, b as SuiteCollector, c as SuiteHooks, O as OnTestFailedHandler, d as Test } from './tasks-2a410173.js';
-export { D as DoneCallback, m as HookCleanupCallback, H as HookListener, R as RunMode, o as RuntimeContext, q as SequenceHooks, r as SequenceSetupFiles, j as Suite, n as SuiteFactory, f as TaskBase, g as TaskCustom, h as TaskResult, i as TaskResultPack, e as TaskState, p as TestContext, k as TestFunction, l as TestOptions } from './tasks-2a410173.js';
+import { V as VitestRunner } from './runner-6af7d148.js';
+export { C as CancelReason, a as VitestRunnerConfig, c as VitestRunnerConstructor, b as VitestRunnerImportSource } from './runner-6af7d148.js';
+import { T as Task, F as File, S as SuiteAPI, a as TestAPI, b as SuiteCollector, c as SuiteHooks, O as OnTestFailedHandler, d as Test } from './tasks-900f5000.js';
+export { D as DoneCallback, n as HookCleanupCallback, H as HookListener, R as RunMode, p as RuntimeContext, r as SequenceHooks, s as SequenceSetupFiles, k as Suite, o as SuiteFactory, f as TaskBase, h as TaskCustom, g as TaskMeta, i as TaskResult, j as TaskResultPack, e as TaskState, q as TestContext, l as TestFunction, m as TestOptions } from './tasks-900f5000.js';
 import { Awaitable } from '@vitest/utils';
 
 declare function updateTask(task: Task, runner: VitestRunner): void;

package/dist/index.js

@@ -54,6 +54,7 @@ function createTestContext(test, runner) {
     throw new Error("done() callback is deprecated, use promise instead");
   };
   context.meta = test;
+  context.task = test;
   context.onTestFailed = (fn) => {
     test.onFailed || (test.onFailed = []);
     test.onFailed.push(fn);
@@ -65,9 +66,29 @@ function makeTimeoutMsg(isHook, timeout) {
 If this is a long-running ${isHook ? "hook" : "test"}, pass a timeout value as the last argument or configure it globally with "${isHook ? "hookTimeout" : "testTimeout"}".`;
 }
 
+var version = "0.31.2";
+
+function getVersion() {
+  return globalThis.__vitest_runner_version__ || version;
+}
+function markVersion() {
+  globalThis.__vitest_runner_version__ = version;
+}
+function checkVersion() {
+  const collectVersion = getVersion();
+  if (collectVersion !== version) {
+    const error = `Version mismatch: Vitest started as ${collectVersion}, but tests are collected with ${version} version.
+
+- If you are using global Vitest, make sure your package has the same version.
+- If you have a monorepo setup, make sure your main package has the same version as your test packages.`;
+    throw new Error(error);
+  }
+}
+
 const suite = createSuite();
 const test = createTest(
   function(name, fn, options) {
+    checkVersion();
     getCurrentSuite().test.fn.call(this, name, fn, options);
   }
 );
@@ -101,18 +122,20 @@ function createSuiteHooks() {
   };
 }
 function createSuiteCollector(name, factory = () => {
-}, mode, concurrent, shuffle, suiteOptions) {
+}, mode, concurrent, shuffle, each, suiteOptions) {
   const tasks = [];
   const factoryQueue = [];
   let suite2;
   initSuite();
-  const test2 = createTest(function(name2, fn = noop, options = suiteOptions) {
+  const test2 = createTest(function(name2, fn = noop, options) {
     const mode2 = this.only ? "only" : this.skip ? "skip" : this.todo ? "todo" : "run";
     if (typeof options === "number")
       options = { timeout: options };
     if (typeof suiteOptions === "object") {
       options = {
-        ...suiteOptions,
+        repeats: suiteOptions.repeats,
+        retry: suiteOptions.retry,
+        timeout: suiteOptions.timeout,
         ...options
       };
     }
@@ -120,11 +143,13 @@ function createSuiteCollector(name, factory = () => {
       id: "",
       type: "test",
       name: name2,
+      each: this.each,
       mode: mode2,
       suite: void 0,
       fails: this.fails,
       retry: options == null ? void 0 : options.retry,
-      repeats: options == null ? void 0 : options.repeats
+      repeats: options == null ? void 0 : options.repeats,
+      meta: /* @__PURE__ */ Object.create(null)
     };
     if (this.concurrent || concurrent)
       test3.concurrent = true;
@@ -147,7 +172,8 @@ function createSuiteCollector(name, factory = () => {
       id: "",
       name: name2,
       type: "custom",
-      mode: self.only ? "only" : self.skip ? "skip" : self.todo ? "todo" : "run"
+      mode: self.only ? "only" : self.skip ? "skip" : self.todo ? "todo" : "run",
+      meta: /* @__PURE__ */ Object.create(null)
     };
     tasks.push(task);
     return task;
@@ -156,6 +182,7 @@ function createSuiteCollector(name, factory = () => {
     type: "collector",
     name,
     mode,
+    options: suiteOptions,
     test: test2,
     tasks,
     collect,
@@ -174,8 +201,10 @@ function createSuiteCollector(name, factory = () => {
       type: "suite",
       name,
       mode,
+      each,
       shuffle,
-      tasks: []
+      tasks: [],
+      meta: /* @__PURE__ */ Object.create(null)
     };
     setHooks(suite2, createSuiteHooks());
   }
@@ -205,11 +234,20 @@ function createSuiteCollector(name, factory = () => {
 }
 function createSuite() {
   function suiteFn(name, factory, options) {
+    var _a;
+    checkVersion();
     const mode = this.only ? "only" : this.skip ? "skip" : this.todo ? "todo" : "run";
-    return createSuiteCollector(name, factory, mode, this.concurrent, this.shuffle, options);
+    const currentSuite = getCurrentSuite();
+    if (typeof options === "number")
+      options = { timeout: options };
+    if (currentSuite && typeof ((_a = currentSuite.options) == null ? void 0 : _a.repeats) === "number") {
+      options = { repeats: currentSuite.options.repeats, ...options };
+    }
+    return createSuiteCollector(name, factory, mode, this.concurrent, this.shuffle, this.each, options);
   }
   suiteFn.each = function(cases, ...args) {
     const suite2 = this.withContext();
+    this.setContext("each", true);
     if (Array.isArray(cases) && args.length)
       cases = formatTemplateString(cases, args);
     return (name, fn, options) => {
@@ -218,6 +256,7 @@ function createSuite() {
         const items = Array.isArray(i) ? i : [i];
         arrayOnlyCases ? suite2(formatTitle(name, items, idx), () => fn(...items), options) : suite2(formatTitle(name, items, idx), () => fn(i), options);
       });
+      this.setContext("each", void 0);
     };
   };
   suiteFn.skipIf = (condition) => condition ? suite.skip : suite;
@@ -231,6 +270,7 @@ function createTest(fn) {
   const testFn = fn;
   testFn.each = function(cases, ...args) {
     const test2 = this.withContext();
+    this.setContext("each", true);
     if (Array.isArray(cases) && args.length)
       cases = formatTemplateString(cases, args);
     return (name, fn2, options) => {
@@ -239,6 +279,7 @@ function createTest(fn) {
         const items = Array.isArray(i) ? i : [i];
         arrayOnlyCases ? test2(formatTitle(name, items, idx), () => fn2(...items), options) : test2(formatTitle(name, items, idx), () => fn2(i), options);
       });
+      this.setContext("each", void 0);
     };
   };
   testFn.skipIf = (condition) => condition ? test.skip : test;
@@ -305,6 +346,7 @@ async function collectTests(paths, runner) {
       mode: "run",
       filepath,
       tasks: [],
+      meta: /* @__PURE__ */ Object.create(null),
       projectName: config.name
     };
     clearCollectorContext(runner);
@@ -401,7 +443,7 @@ const packs = /* @__PURE__ */ new Map();
 let updateTimer;
 let previousUpdate;
 function updateTask(task, runner) {
-  packs.set(task.id, task.result);
+  packs.set(task.id, [task.result, task.meta]);
   const { clearTimeout, setTimeout } = getSafeTimers();
   clearTimeout(updateTimer);
   updateTimer = setTimeout(() => {
@@ -414,7 +456,14 @@ async function sendTasksUpdate(runner) {
   clearTimeout(updateTimer);
   await previousUpdate;
   if (packs.size) {
-    const p = (_a = runner.onTaskUpdate) == null ? void 0 : _a.call(runner, Array.from(packs));
+    const taskPacks = Array.from(packs).map(([id, task]) => {
+      return [
+        id,
+        task[0],
+        task[1]
+      ];
+    });
+    const p = (_a = runner.onTaskUpdate) == null ? void 0 : _a.call(runner, taskPacks);
     packs.clear();
     return p;
   }
@@ -617,6 +666,7 @@ async function runFiles(files, runner) {
 }
 async function startTests(paths, runner) {
   var _a, _b, _c, _d;
+  markVersion();
   await ((_a = runner.onBeforeCollect) == null ? void 0 : _a.call(runner, paths));
   const files = await collectTests(paths, runner);
   (_b = runner.onCollected) == null ? void 0 : _b.call(runner, files);

package/dist/{runner-7aa38127.d.ts → runner-6af7d148.d.ts}

@@ -1,4 +1,4 @@
-import { q as SequenceHooks, r as SequenceSetupFiles, F as File, d as Test, j as Suite, h as TaskResult, p as TestContext } from './tasks-2a410173.js';
+import { r as SequenceHooks, s as SequenceSetupFiles, F as File, d as Test, k as Suite, j as TaskResultPack, q as TestContext } from './tasks-900f5000.js';
 
 interface VitestRunnerConfig {
     root: string;
@@ -83,7 +83,7 @@ interface VitestRunner {
     /**
      * Called, when a task is updated. The same as "onTaskUpdate" in a reporter, but this is running in the same thread as tests.
      */
-    onTaskUpdate?(task: [string, TaskResult | undefined][]): Promise<void>;
+    onTaskUpdate?(task: TaskResultPack[]): Promise<void>;
     /**
      * Called before running all tests in collected paths.
      */

package/dist/{tasks-2a410173.d.ts → tasks-900f5000.d.ts}

@@ -15,15 +15,18 @@ interface TaskBase {
     id: string;
     name: string;
     mode: RunMode;
+    meta: TaskMeta;
+    each?: boolean;
     concurrent?: boolean;
     shuffle?: boolean;
     suite?: Suite;
     file?: File;
     result?: TaskResult;
     retry?: number;
-    meta?: any;
     repeats?: number;
 }
+interface TaskMeta {
+}
 interface TaskCustom extends TaskBase {
     type: 'custom';
 }
@@ -42,7 +45,7 @@ interface TaskResult {
     retryCount?: number;
     repeatCount?: number;
 }
-type TaskResultPack = [id: string, result: TaskResult | undefined];
+type TaskResultPack = [id: string, result: TaskResult | undefined, meta: TaskMeta];
 interface Suite extends TaskBase {
     type: 'suite';
     tasks: Task[];
@@ -114,9 +117,11 @@ interface TestOptions {
      */
     retry?: number;
     /**
-     * How many times the test will repeat.
+     * How many times the test will run.
+     * Only inner tests will repeat if set on `describe()`, nested `describe()` will inherit parent's repeat by default.
+     *
+     * @default 1
      *
-     * @default 5
      */
     repeats?: number;
 }
@@ -141,14 +146,15 @@ type SuiteAPI<ExtraContext = {}> = ChainableSuiteAPI<ExtraContext> & {
 type HookListener<T extends any[], Return = void> = (...args: T) => Awaitable<Return>;
 type HookCleanupCallback = (() => Awaitable<unknown>) | void;
 interface SuiteHooks<ExtraContext = {}> {
-    beforeAll: HookListener<[Suite | File], HookCleanupCallback>[];
-    afterAll: HookListener<[Suite | File]>[];
-    beforeEach: HookListener<[TestContext & ExtraContext, Suite], HookCleanupCallback>[];
-    afterEach: HookListener<[TestContext & ExtraContext, Suite]>[];
+    beforeAll: HookListener<[Readonly<Suite | File>], HookCleanupCallback>[];
+    afterAll: HookListener<[Readonly<Suite | File>]>[];
+    beforeEach: HookListener<[TestContext & ExtraContext, Readonly<Suite>], HookCleanupCallback>[];
+    afterEach: HookListener<[TestContext & ExtraContext, Readonly<Suite>]>[];
 }
 interface SuiteCollector<ExtraContext = {}> {
     readonly name: string;
     readonly mode: RunMode;
+    options?: TestOptions;
     type: 'collector';
     test: TestAPI<ExtraContext>;
     tasks: (Suite | TaskCustom | Test | SuiteCollector<ExtraContext>)[];
@@ -165,8 +171,14 @@ interface RuntimeContext {
 interface TestContext {
     /**
      * Metadata of the current test
+     *
+     * @deprecated Use `task` instead
      */
     meta: Readonly<Test>;
+    /**
+     * Metadata of the current test
+     */
+    task: Readonly<Test>;
     /**
      * Extract hooks on test failed
      */
@@ -176,4 +188,4 @@ type OnTestFailedHandler = (result: TaskResult) => Awaitable<void>;
 type SequenceHooks = 'stack' | 'list' | 'parallel';
 type SequenceSetupFiles = 'list' | 'parallel';
 
-export { ChainableFunction as C, DoneCallback as D, File as F, HookListener as H, OnTestFailedHandler as O, RunMode as R, SuiteAPI as S, Task as T, TestAPI as a, SuiteCollector as b, SuiteHooks as c, Test as d, TaskState as e, TaskBase as f, TaskCustom as g, TaskResult as h, TaskResultPack as i, Suite as j, TestFunction as k, TestOptions as l, HookCleanupCallback as m, SuiteFactory as n, RuntimeContext as o, TestContext as p, SequenceHooks as q, SequenceSetupFiles as r, createChainable as s };
+export { ChainableFunction as C, DoneCallback as D, File as F, HookListener as H, OnTestFailedHandler as O, RunMode as R, SuiteAPI as S, Task as T, TestAPI as a, SuiteCollector as b, SuiteHooks as c, Test as d, TaskState as e, TaskBase as f, TaskMeta as g, TaskCustom as h, TaskResult as i, TaskResultPack as j, Suite as k, TestFunction as l, TestOptions as m, HookCleanupCallback as n, SuiteFactory as o, RuntimeContext as p, TestContext as q, SequenceHooks as r, SequenceSetupFiles as s, createChainable as t };

package/dist/types.d.ts

@@ -1,3 +1,3 @@
-export { D as DoneCallback, F as File, m as HookCleanupCallback, H as HookListener, O as OnTestFailedHandler, R as RunMode, o as RuntimeContext, q as SequenceHooks, r as SequenceSetupFiles, j as Suite, S as SuiteAPI, b as SuiteCollector, n as SuiteFactory, c as SuiteHooks, T as Task, f as TaskBase, g as TaskCustom, h as TaskResult, i as TaskResultPack, e as TaskState, d as Test, a as TestAPI, p as TestContext, k as TestFunction, l as TestOptions } from './tasks-2a410173.js';
-export { C as CancelReason, V as VitestRunner, a as VitestRunnerConfig, c as VitestRunnerConstructor, b as VitestRunnerImportSource } from './runner-7aa38127.js';
+export { D as DoneCallback, F as File, n as HookCleanupCallback, H as HookListener, O as OnTestFailedHandler, R as RunMode, p as RuntimeContext, r as SequenceHooks, s as SequenceSetupFiles, k as Suite, S as SuiteAPI, b as SuiteCollector, o as SuiteFactory, c as SuiteHooks, T as Task, f as TaskBase, h as TaskCustom, g as TaskMeta, i as TaskResult, j as TaskResultPack, e as TaskState, d as Test, a as TestAPI, q as TestContext, l as TestFunction, m as TestOptions } from './tasks-900f5000.js';
+export { C as CancelReason, V as VitestRunner, a as VitestRunnerConfig, c as VitestRunnerConstructor, b as VitestRunnerImportSource } from './runner-6af7d148.js';
 import '@vitest/utils';

package/dist/utils.d.ts

@@ -1,5 +1,5 @@
-import { j as Suite, T as Task, d as Test, g as TaskCustom } from './tasks-2a410173.js';
-export { C as ChainableFunction, s as createChainable } from './tasks-2a410173.js';
+import { k as Suite, T as Task, d as Test, h as TaskCustom } from './tasks-900f5000.js';
+export { C as ChainableFunction, t as createChainable } from './tasks-900f5000.js';
 import { Arrayable } from '@vitest/utils';
 export { ErrorWithDiff, ParsedStack } from '@vitest/utils';
 import { DiffOptions } from '@vitest/utils/diff';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vitest/runner",
   "type": "module",
-  "version": "0.31.0",
+  "version": "0.31.2",
   "description": "Vitest test runner",
   "license": "MIT",
   "funding": "https://opencollective.com/vitest",
@@ -41,7 +41,7 @@
     "concordance": "^5.0.4",
     "p-limit": "^4.0.0",
     "pathe": "^1.1.0",
-    "@vitest/utils": "0.31.0"
+    "@vitest/utils": "0.31.2"
   },
   "scripts": {
     "build": "rimraf dist && rollup -c",