@vitest/runner 2.1.5 → 2.2.0-beta.2

package/dist/chunk-tasks.js

@@ -179,17 +179,20 @@ function partitionSuiteChildren(suite) {
 }
 
 function isAtomTest(s) {
+  return isTestCase(s);
+}
+function isTestCase(s) {
   return s.type === "test" || s.type === "custom";
 }
 function getTests(suite) {
   const tests = [];
   const arraySuites = toArray(suite);
   for (const s of arraySuites) {
-    if (isAtomTest(s)) {
+    if (isTestCase(s)) {
       tests.push(s);
     } else {
       for (const task of s.tasks) {
-        if (isAtomTest(task)) {
+        if (isTestCase(task)) {
           tests.push(task);
         } else {
           const taskTests = getTests(task);
@@ -204,7 +207,7 @@ function getTests(suite) {
 }
 function getTasks(tasks = []) {
   return toArray(tasks).flatMap(
-    (s) => isAtomTest(s) ? [s] : [s, ...getTasks(s.tasks)]
+    (s) => isTestCase(s) ? [s] : [s, ...getTasks(s.tasks)]
   );
 }
 function getSuites(suite) {
@@ -214,7 +217,7 @@ function getSuites(suite) {
 }
 function hasTests(suite) {
   return toArray(suite).some(
-    (s) => s.tasks.some((c) => isAtomTest(c) || hasTests(c))
+    (s) => s.tasks.some((c) => isTestCase(c) || hasTests(c))
   );
 }
 function hasFailed(suite) {

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { B as BeforeAllListener, A as AfterAllListener, d as BeforeEachListener, e as AfterEachListener, f as TaskHook, O as OnTestFailedHandler, g as OnTestFinishedHandler, a as Test, C as Custom, S as Suite, h as SuiteHooks, T as Task, F as File, i as SuiteAPI, j as TestAPI, k as SuiteCollector } from './tasks-3ZnPj1LR.js';
-export { D as DoneCallback, E as ExtendedContext, l as Fixture, m as FixtureFn, n as FixtureOptions, o as Fixtures, H as HookCleanupCallback, p as HookListener, I as InferFixturesTypes, R as RunMode, q as RuntimeContext, r as SequenceHooks, s as SequenceSetupFiles, t as SuiteFactory, u as TaskBase, v as TaskContext, w as TaskCustomOptions, x as TaskMeta, y as TaskPopulated, z as TaskResult, G as TaskResultPack, J as TaskState, K as TestContext, L as TestFunction, M as TestOptions, U as Use } from './tasks-3ZnPj1LR.js';
+import { B as BeforeAllListener, A as AfterAllListener, d as BeforeEachListener, e as AfterEachListener, f as TaskHook, O as OnTestFailedHandler, g as OnTestFinishedHandler, a as Test, C as Custom, S as Suite, h as SuiteHooks, T as Task, F as File, i as SuiteAPI, j as TestAPI, k as SuiteCollector } from './tasks-CgWT5bp6.js';
+export { D as DoneCallback, E as ExtendedContext, l as Fixture, m as FixtureFn, n as FixtureOptions, o as Fixtures, H as HookCleanupCallback, p as HookListener, I as InferFixturesTypes, R as RunMode, q as RuntimeContext, r as SequenceHooks, s as SequenceSetupFiles, t as SuiteFactory, u as TaskBase, v as TaskContext, w as TaskCustomOptions, x as TaskMeta, y as TaskPopulated, z as TaskResult, G as TaskResultPack, J as TaskState, K as TestContext, L as TestFunction, M as TestOptions, U as Use } from './tasks-CgWT5bp6.js';
 import { Awaitable } from '@vitest/utils';
 import { VitestRunner } from './types.js';
 export { CancelReason, VitestRunnerConfig, VitestRunnerConstructor, VitestRunnerImportSource } from './types.js';

package/dist/index.js

@@ -6,9 +6,10 @@ export { processError } from '@vitest/utils/error';
 import 'pathe';
 
 class PendingError extends Error {
-  constructor(message, task) {
+  constructor(message, task, note) {
     super(message);
     this.message = message;
+    this.note = note;
     this.taskId = task.id;
   }
   code = "VITEST_PENDING";
@@ -54,9 +55,9 @@ function createTestContext(test, runner) {
     throw new Error("done() callback is deprecated, use promise instead");
   };
   context.task = test;
-  context.skip = () => {
+  context.skip = (note) => {
     test.pending = true;
-    throw new PendingError("test is skipped; abort execution", test);
+    throw new PendingError("test is skipped; abort execution", test, note);
   };
   context.onTestFailed = (fn) => {
     test.onFailed || (test.onFailed = []);
@@ -95,14 +96,15 @@ function getHooks(key) {
   return hooksMap.get(key);
 }
 
-function mergeContextFixtures(fixtures, context = {}) {
-  const fixtureOptionKeys = ["auto"];
+function mergeContextFixtures(fixtures, context, inject) {
+  const fixtureOptionKeys = ["auto", "injected"];
   const fixtureArray = Object.entries(fixtures).map(
     ([prop, value]) => {
       const fixtureItem = { value };
       if (Array.isArray(value) && value.length >= 2 && isObject(value[1]) && Object.keys(value[1]).some((key) => fixtureOptionKeys.includes(key))) {
         Object.assign(fixtureItem, value[1]);
-        fixtureItem.value = value[0];
+        const userValue = value[0];
+        fixtureItem.value = fixtureItem.injected ? inject(prop) ?? userValue : userValue;
       }
       fixtureItem.prop = prop;
       fixtureItem.isFn = typeof fixtureItem.value === "function";
@@ -401,7 +403,7 @@ function createSuiteCollector(name, factory = () => {
       each: options.each,
       fails: options.fails,
       context: void 0,
-      type: "custom",
+      type: "test",
       file: void 0,
       retry: options.retry ?? runner.config.retry,
       repeats: options.repeats,
@@ -666,7 +668,14 @@ function createTaskCollector(fn, context) {
     return condition ? this : this.skip;
   };
   taskFn.extend = function(fixtures) {
-    const _context = mergeContextFixtures(fixtures, context);
+    const _context = mergeContextFixtures(
+      fixtures,
+      context || {},
+      (key) => {
+        var _a, _b;
+        return (_b = (_a = getRunner()).injectValue) == null ? void 0 : _b.call(_a, key);
+      }
+    );
     return createTest(function fn2(name, optionsOrFn, optionsOrTest) {
       getCurrentSuite().test.fn.call(
         this,
@@ -1008,7 +1017,7 @@ async function callCleanupHooks(cleanups) {
   );
 }
 async function runTest(test, runner) {
-  var _a, _b, _c, _d, _e, _f, _g;
+  var _a, _b, _c, _d, _e, _f, _g, _h;
   await ((_a = runner.onBeforeRunTask) == null ? void 0 : _a.call(runner, test));
   if (test.mode !== "run") {
     return;
@@ -1071,13 +1080,13 @@ async function runTest(test, runner) {
       }
       if (test.pending || ((_e = test.result) == null ? void 0 : _e.state) === "skip") {
         test.mode = "skip";
-        test.result = { state: "skip" };
+        test.result = { state: "skip", note: (_f = test.result) == null ? void 0 : _f.note };
         updateTask(test, runner);
         setCurrentTest(void 0);
         return;
       }
       try {
-        await ((_f = runner.onTaskFinished) == null ? void 0 : _f.call(runner, test));
+        await ((_g = runner.onTaskFinished) == null ? void 0 : _g.call(runner, test));
       } catch (e) {
         failTask(test.result, e, runner.config.diffOptions);
       }
@@ -1124,12 +1133,13 @@ async function runTest(test, runner) {
   }
   setCurrentTest(void 0);
   test.result.duration = now() - start;
-  await ((_g = runner.onAfterRunTask) == null ? void 0 : _g.call(runner, test));
+  await ((_h = runner.onAfterRunTask) == null ? void 0 : _h.call(runner, test));
   updateTask(test, runner);
 }
 function failTask(result, err, diffOptions) {
   if (err instanceof PendingError) {
     result.state = "skip";
+    result.note = err.note;
     return;
   }
   result.state = "fail";

package/dist/{tasks-3ZnPj1LR.d.ts → tasks-CgWT5bp6.d.ts}

@@ -3,6 +3,10 @@ import { ErrorWithDiff, Awaitable } from '@vitest/utils';
 interface FixtureItem extends FixtureOptions {
     prop: string;
     value: any;
+    /**
+     * Indicated if the injected value should be preferred over the fixture value
+     */
+    injected?: boolean;
     /**
      * Indicates whether the fixture is a function
      */
@@ -162,6 +166,8 @@ interface TaskResult {
      * `repeats` option is set. This number also contains `retryCount`.
      */
     repeatCount?: number;
+    /** @private */
+    note?: string;
 }
 /**
  * The tuple representing a single task update.
@@ -228,14 +234,23 @@ interface Test<ExtraContext = object> extends TaskPopulated {
      */
     context: TaskContext<Test> & ExtraContext & TestContext;
 }
+/**
+ * @deprecated Use `Test` instead. `type: 'custom'` is not used since 2.2
+ */
 interface Custom<ExtraContext = object> extends TaskPopulated {
+    /**
+     * @deprecated use `test` instead. `custom` is not used since 2.2
+     */
     type: 'custom';
     /**
      * Task context that will be passed to the test function.
      */
-    context: TaskContext<Custom> & ExtraContext & TestContext;
+    context: TaskContext<Test> & ExtraContext & TestContext;
 }
 type Task = Test | Suite | Custom | File;
+/**
+ * @deprecated Vitest doesn't provide `done()` anymore
+ */
 type DoneCallback = (error?: any) => void;
 type TestFunction<ExtraContext = object> = (context: ExtendedContext<Test> & ExtraContext) => Awaitable<any> | void;
 type ExtractEachCallbackArgs<T extends ReadonlyArray<any>> = {
@@ -384,10 +399,10 @@ interface AfterAllListener {
     (suite: Readonly<Suite | File>): Awaitable<unknown>;
 }
 interface BeforeEachListener<ExtraContext = object> {
-    (context: ExtendedContext<Test | Custom> & ExtraContext, suite: Readonly<Suite>): Awaitable<unknown>;
+    (context: ExtendedContext<Test> & ExtraContext, suite: Readonly<Suite>): Awaitable<unknown>;
 }
 interface AfterEachListener<ExtraContext = object> {
-    (context: ExtendedContext<Test | Custom> & ExtraContext, suite: Readonly<Suite>): Awaitable<unknown>;
+    (context: ExtendedContext<Test> & ExtraContext, suite: Readonly<Suite>): Awaitable<unknown>;
 }
 interface SuiteHooks<ExtraContext = object> {
     beforeAll: BeforeAllListener[];
@@ -413,7 +428,7 @@ interface TaskCustomOptions extends TestOptions {
      * If nothing is provided, the runner will try to get the function using `getFn(task)`.
      * If the runner cannot find the function, the task will be marked as failed.
      */
-    handler?: (context: TaskContext<Custom>) => Awaitable<void>;
+    handler?: (context: TaskContext<Test>) => Awaitable<void>;
 }
 interface SuiteCollector<ExtraContext = object> {
     readonly name: string;
@@ -422,7 +437,7 @@ interface SuiteCollector<ExtraContext = object> {
     type: 'collector';
     test: TestAPI<ExtraContext>;
     tasks: (Suite | Custom<ExtraContext> | Test<ExtraContext> | SuiteCollector<ExtraContext>)[];
-    task: (name: string, options?: TaskCustomOptions) => Custom<ExtraContext>;
+    task: (name: string, options?: TaskCustomOptions) => Test<ExtraContext>;
     collect: (file: File) => Promise<Suite>;
     clear: () => void;
     on: <T extends keyof SuiteHooks<ExtraContext>>(name: T, ...fn: SuiteHooks<ExtraContext>[T]) => void;
@@ -440,7 +455,7 @@ interface TestContext {
 /**
  * Context that's always available in the test function.
  */
-interface TaskContext<Task extends Custom | Test = Custom | Test> {
+interface TaskContext<Task extends Test = Test> {
     /**
      * Metadata of the current test
      */
@@ -457,9 +472,9 @@ interface TaskContext<Task extends Custom | Test = Custom | Test> {
      * Mark tests as skipped. All execution after this call will be skipped.
      * This function throws an error, so make sure you are not catching it accidentally.
      */
-    skip: () => void;
+    skip: (note?: string) => void;
 }
-type ExtendedContext<T extends Custom | Test> = TaskContext<T> & TestContext;
+type ExtendedContext<T extends Test> = TaskContext<T> & TestContext;
 type OnTestFailedHandler = (result: TaskResult) => Awaitable<void>;
 type OnTestFinishedHandler = (result: TaskResult) => Awaitable<void>;
 interface TaskHook<HookListener> {

package/dist/types.d.ts

@@ -1,6 +1,6 @@
 import { DiffOptions } from '@vitest/utils/diff';
-import { r as SequenceHooks, s as SequenceSetupFiles, F as File, T as Task, a as Test, C as Custom, S as Suite, G as TaskResultPack, v as TaskContext, E as ExtendedContext } from './tasks-3ZnPj1LR.js';
-export { A as AfterAllListener, e as AfterEachListener, B as BeforeAllListener, d as BeforeEachListener, j as CustomAPI, D as DoneCallback, l as Fixture, m as FixtureFn, n as FixtureOptions, o as Fixtures, H as HookCleanupCallback, p as HookListener, I as InferFixturesTypes, O as OnTestFailedHandler, g as OnTestFinishedHandler, R as RunMode, q as RuntimeContext, i as SuiteAPI, k as SuiteCollector, t as SuiteFactory, h as SuiteHooks, u as TaskBase, w as TaskCustomOptions, f as TaskHook, x as TaskMeta, y as TaskPopulated, z as TaskResult, J as TaskState, j as TestAPI, K as TestContext, L as TestFunction, M as TestOptions, U as Use } from './tasks-3ZnPj1LR.js';
+import { r as SequenceHooks, s as SequenceSetupFiles, F as File, T as Task, a as Test, C as Custom, S as Suite, G as TaskResultPack, v as TaskContext, E as ExtendedContext } from './tasks-CgWT5bp6.js';
+export { A as AfterAllListener, e as AfterEachListener, B as BeforeAllListener, d as BeforeEachListener, j as CustomAPI, D as DoneCallback, l as Fixture, m as FixtureFn, n as FixtureOptions, o as Fixtures, H as HookCleanupCallback, p as HookListener, I as InferFixturesTypes, O as OnTestFailedHandler, g as OnTestFinishedHandler, R as RunMode, q as RuntimeContext, i as SuiteAPI, k as SuiteCollector, t as SuiteFactory, h as SuiteHooks, u as TaskBase, w as TaskCustomOptions, f as TaskHook, x as TaskMeta, y as TaskPopulated, z as TaskResult, J as TaskState, j as TestAPI, K as TestContext, L as TestFunction, M as TestOptions, U as Use } from './tasks-CgWT5bp6.js';
 import '@vitest/utils';
 
 /**
@@ -118,11 +118,15 @@ interface VitestRunner {
      *
      * @see https://vitest.dev/advanced/runner.html#your-task-function
      */
-    extendTaskContext?: <T extends Test | Custom>(context: TaskContext<T>) => ExtendedContext<T>;
+    extendTaskContext?: <T extends Test>(context: TaskContext<T>) => ExtendedContext<T>;
     /**
      * Called when test and setup files are imported. Can be called in two situations: when collecting tests and when importing setup files.
      */
     importFile: (filepath: string, source: VitestRunnerImportSource) => unknown;
+    /**
+     * Function that is called when the runner attempts to get the value when `test.extend` is used with `{ injected: true }`
+     */
+    injectValue?: (key: string) => unknown;
     /**
      * Publicly available configuration.
      */

package/dist/utils.d.ts

@@ -1,5 +1,5 @@
-import { S as Suite, F as File, T as Task, a as Test, C as Custom } from './tasks-3ZnPj1LR.js';
-export { b as ChainableFunction, c as createChainable } from './tasks-3ZnPj1LR.js';
+import { S as Suite, F as File, T as Task, a as Test, C as Custom } from './tasks-CgWT5bp6.js';
+export { b as ChainableFunction, c as createChainable } from './tasks-CgWT5bp6.js';
 import { Arrayable } from '@vitest/utils';
 
 /**
@@ -21,6 +21,9 @@ declare function limitConcurrency(concurrency?: number): <Args extends unknown[]
  */
 declare function partitionSuiteChildren(suite: Suite): Task[][];
 
+/**
+ * @deprecated use `isTestCase` instead
+ */
 declare function isAtomTest(s: Task): s is Test | Custom;
 declare function getTests(suite: Arrayable<Task>): (Test | Custom)[];
 declare function getTasks(tasks?: Arrayable<Task>): Task[];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vitest/runner",
   "type": "module",
-  "version": "2.1.5",
+  "version": "2.2.0-beta.2",
   "description": "Vitest test runner",
   "license": "MIT",
   "funding": "https://opencollective.com/vitest",
@@ -39,7 +39,7 @@
   ],
   "dependencies": {
     "pathe": "^1.1.2",
-    "@vitest/utils": "2.1.5"
+    "@vitest/utils": "2.2.0-beta.2"
   },
   "scripts": {
     "build": "rimraf dist && rollup -c",