@vitest/runner 4.0.0-beta.14 → 4.0.0-beta.16

package/dist/{tasks.d-B4TVMiFg.d.ts → hooks.d-C0RE9A6t.d.ts}

@@ -352,7 +352,13 @@ interface ExtendedAPI<ExtraContext> {
 	skipIf: (condition: any) => ChainableTestAPI<ExtraContext>;
 	runIf: (condition: any) => ChainableTestAPI<ExtraContext>;
 }
-type TestAPI<ExtraContext = object> = ChainableTestAPI<ExtraContext> & ExtendedAPI<ExtraContext> & {
+interface Hooks<ExtraContext> {
+	beforeAll: typeof beforeAll;
+	afterAll: typeof afterAll;
+	beforeEach: typeof beforeEach<ExtraContext>;
+	afterEach: typeof afterEach<ExtraContext>;
+}
+type TestAPI<ExtraContext = object> = ChainableTestAPI<ExtraContext> & ExtendedAPI<ExtraContext> & Hooks<ExtraContext> & {
 	extend: <T extends Record<string, any> = object>(fixtures: Fixtures<T, ExtraContext>) => TestAPI<{ [K in keyof T | keyof ExtraContext] : K extends keyof T ? T[K] : K extends keyof ExtraContext ? ExtraContext[K] : never }>;
 	scoped: (fixtures: Fixtures<Partial<ExtraContext>>) => void;
 };
@@ -513,5 +519,121 @@ interface TaskHook<HookListener> {
 type SequenceHooks = "stack" | "list" | "parallel";
 type SequenceSetupFiles = "list" | "parallel";
 
-export { createChainable as c };
-export type { AfterAllListener as A, BeforeAllListener as B, ChainableFunction as C, TaskResultPack as D, TaskState as E, File as F, TestAnnotation as G, TestAnnotationLocation as H, ImportDuration as I, TestAttachment as J, TestContext as K, TestFunction as L, TestOptions as M, OnTestFailedHandler as O, RunMode as R, Suite as S, Task as T, Use as U, Test as a, AfterEachListener as b, BeforeEachListener as d, TaskHook as e, OnTestFinishedHandler as f, SuiteHooks as g, TaskUpdateEvent as h, TestAPI as i, SuiteAPI as j, SuiteCollector as k, Fixture as l, FixtureFn as m, FixtureOptions as n, Fixtures as o, InferFixturesTypes as p, RuntimeContext as q, SequenceHooks as r, SequenceSetupFiles as s, SuiteFactory as t, TaskBase as u, TaskCustomOptions as v, TaskEventPack as w, TaskMeta as x, TaskPopulated as y, TaskResult as z };
+/**
+* Registers a callback function to be executed once before all tests within the current suite.
+* This hook is useful for scenarios where you need to perform setup operations that are common to all tests in a suite, such as initializing a database connection or setting up a test environment.
+*
+* **Note:** The `beforeAll` hooks are executed in the order they are defined one after another. You can configure this by changing the `sequence.hooks` option in the config file.
+*
+* @param {Function} fn - The callback function to be executed before all tests.
+* @param {number} [timeout] - Optional timeout in milliseconds for the hook. If not provided, the default hook timeout from the runner's configuration is used.
+* @returns {void}
+* @example
+* ```ts
+* // Example of using beforeAll to set up a database connection
+* beforeAll(async () => {
+*   await database.connect();
+* });
+* ```
+*/
+declare function beforeAll(fn: BeforeAllListener, timeout?: number): void;
+/**
+* Registers a callback function to be executed once after all tests within the current suite have completed.
+* This hook is useful for scenarios where you need to perform cleanup operations after all tests in a suite have run, such as closing database connections or cleaning up temporary files.
+*
+* **Note:** The `afterAll` hooks are running in reverse order of their registration. You can configure this by changing the `sequence.hooks` option in the config file.
+*
+* @param {Function} fn - The callback function to be executed after all tests.
+* @param {number} [timeout] - Optional timeout in milliseconds for the hook. If not provided, the default hook timeout from the runner's configuration is used.
+* @returns {void}
+* @example
+* ```ts
+* // Example of using afterAll to close a database connection
+* afterAll(async () => {
+*   await database.disconnect();
+* });
+* ```
+*/
+declare function afterAll(fn: AfterAllListener, timeout?: number): void;
+/**
+* Registers a callback function to be executed before each test within the current suite.
+* This hook is useful for scenarios where you need to reset or reinitialize the test environment before each test runs, such as resetting database states, clearing caches, or reinitializing variables.
+*
+* **Note:** The `beforeEach` hooks are executed in the order they are defined one after another. You can configure this by changing the `sequence.hooks` option in the config file.
+*
+* @param {Function} fn - The callback function to be executed before each test. This function receives an `TestContext` parameter if additional test context is needed.
+* @param {number} [timeout] - Optional timeout in milliseconds for the hook. If not provided, the default hook timeout from the runner's configuration is used.
+* @returns {void}
+* @example
+* ```ts
+* // Example of using beforeEach to reset a database state
+* beforeEach(async () => {
+*   await database.reset();
+* });
+* ```
+*/
+declare function beforeEach<ExtraContext = object>(fn: BeforeEachListener<ExtraContext>, timeout?: number): void;
+/**
+* Registers a callback function to be executed after each test within the current suite has completed.
+* This hook is useful for scenarios where you need to clean up or reset the test environment after each test runs, such as deleting temporary files, clearing test-specific database entries, or resetting mocked functions.
+*
+* **Note:** The `afterEach` hooks are running in reverse order of their registration. You can configure this by changing the `sequence.hooks` option in the config file.
+*
+* @param {Function} fn - The callback function to be executed after each test. This function receives an `TestContext` parameter if additional test context is needed.
+* @param {number} [timeout] - Optional timeout in milliseconds for the hook. If not provided, the default hook timeout from the runner's configuration is used.
+* @returns {void}
+* @example
+* ```ts
+* // Example of using afterEach to delete temporary files created during a test
+* afterEach(async () => {
+*   await fileSystem.deleteTempFiles();
+* });
+* ```
+*/
+declare function afterEach<ExtraContext = object>(fn: AfterEachListener<ExtraContext>, timeout?: number): void;
+/**
+* Registers a callback function to be executed when a test fails within the current suite.
+* This function allows for custom actions to be performed in response to test failures, such as logging, cleanup, or additional diagnostics.
+*
+* **Note:** The `onTestFailed` hooks are running in reverse order of their registration. You can configure this by changing the `sequence.hooks` option in the config file.
+*
+* @param {Function} fn - The callback function to be executed upon a test failure. The function receives the test result (including errors).
+* @param {number} [timeout] - Optional timeout in milliseconds for the hook. If not provided, the default hook timeout from the runner's configuration is used.
+* @throws {Error} Throws an error if the function is not called within a test.
+* @returns {void}
+* @example
+* ```ts
+* // Example of using onTestFailed to log failure details
+* onTestFailed(({ errors }) => {
+*   console.log(`Test failed: ${test.name}`, errors);
+* });
+* ```
+*/
+declare const onTestFailed: TaskHook<OnTestFailedHandler>;
+/**
+* Registers a callback function to be executed when the current test finishes, regardless of the outcome (pass or fail).
+* This function is ideal for performing actions that should occur after every test execution, such as cleanup, logging, or resetting shared resources.
+*
+* This hook is useful if you have access to a resource in the test itself and you want to clean it up after the test finishes. It is a more compact way to clean up resources than using the combination of `beforeEach` and `afterEach`.
+*
+* **Note:** The `onTestFinished` hooks are running in reverse order of their registration. You can configure this by changing the `sequence.hooks` option in the config file.
+*
+* **Note:** The `onTestFinished` hook is not called if the test is canceled with a dynamic `ctx.skip()` call.
+*
+* @param {Function} fn - The callback function to be executed after a test finishes. The function can receive parameters providing details about the completed test, including its success or failure status.
+* @param {number} [timeout] - Optional timeout in milliseconds for the hook. If not provided, the default hook timeout from the runner's configuration is used.
+* @throws {Error} Throws an error if the function is not called within a test.
+* @returns {void}
+* @example
+* ```ts
+* // Example of using onTestFinished for cleanup
+* const db = await connectToDatabase();
+* onTestFinished(async () => {
+*   await db.disconnect();
+* });
+* ```
+*/
+declare const onTestFinished: TaskHook<OnTestFinishedHandler>;
+
+export { createChainable as X, afterAll as g, afterEach as h, beforeAll as i, beforeEach as j, onTestFinished as k, onTestFailed as o };
+export type { AfterAllListener as A, BeforeAllListener as B, TaskEventPack as C, TaskHook as D, TaskMeta as E, File as F, TaskPopulated as G, TaskResult as H, ImportDuration as I, TaskResultPack as J, TaskState as K, TestAnnotation as L, TestAnnotationLocation as M, TestAttachment as N, OnTestFailedHandler as O, TestContext as P, TestFunction as Q, RunMode as R, Suite as S, Test as T, TestOptions as U, Use as V, ChainableFunction as W, SuiteHooks as a, TaskUpdateEvent as b, Task as c, TestAPI as d, SuiteAPI as e, SuiteCollector as f, AfterEachListener as l, BeforeEachListener as m, Fixture as n, FixtureFn as p, FixtureOptions as q, Fixtures as r, InferFixturesTypes as s, OnTestFinishedHandler as t, RuntimeContext as u, SequenceHooks as v, SequenceSetupFiles as w, SuiteFactory as x, TaskBase as y, TaskCustomOptions as z };

package/dist/index.d.ts

@@ -1,126 +1,10 @@
-import { A as AfterAllListener, b as AfterEachListener, B as BeforeAllListener, d as BeforeEachListener, e as TaskHook, O as OnTestFailedHandler, f as OnTestFinishedHandler, a as Test, S as Suite, g as SuiteHooks, F as File, h as TaskUpdateEvent, T as Task, i as TestAPI, j as SuiteAPI, k as SuiteCollector } from './tasks.d-B4TVMiFg.js';
-export { l as Fixture, m as FixtureFn, n as FixtureOptions, o as Fixtures, I as ImportDuration, p as InferFixturesTypes, R as RunMode, q as RuntimeContext, r as SequenceHooks, s as SequenceSetupFiles, t as SuiteFactory, u as TaskBase, v as TaskCustomOptions, w as TaskEventPack, x as TaskMeta, y as TaskPopulated, z as TaskResult, D as TaskResultPack, E as TaskState, G as TestAnnotation, H as TestAnnotationLocation, J as TestAttachment, K as TestContext, L as TestFunction, M as TestOptions, U as Use } from './tasks.d-B4TVMiFg.js';
+import { T as Test, S as Suite, a as SuiteHooks, F as File, b as TaskUpdateEvent, c as Task, d as TestAPI, e as SuiteAPI, f as SuiteCollector } from './hooks.d-C0RE9A6t.js';
+export { A as AfterAllListener, l as AfterEachListener, B as BeforeAllListener, m as BeforeEachListener, n as Fixture, p as FixtureFn, q as FixtureOptions, r as Fixtures, I as ImportDuration, s as InferFixturesTypes, O as OnTestFailedHandler, t as OnTestFinishedHandler, R as RunMode, u as RuntimeContext, v as SequenceHooks, w as SequenceSetupFiles, x as SuiteFactory, y as TaskBase, z as TaskCustomOptions, C as TaskEventPack, D as TaskHook, E as TaskMeta, G as TaskPopulated, H as TaskResult, J as TaskResultPack, K as TaskState, L as TestAnnotation, M as TestAnnotationLocation, N as TestAttachment, P as TestContext, Q as TestFunction, U as TestOptions, V as Use, g as afterAll, h as afterEach, i as beforeAll, j as beforeEach, o as onTestFailed, k as onTestFinished } from './hooks.d-C0RE9A6t.js';
 import { Awaitable } from '@vitest/utils';
 import { FileSpecification, VitestRunner } from './types.js';
 export { CancelReason, VitestRunnerConfig, VitestRunnerConstructor, VitestRunnerImportSource } from './types.js';
 import '@vitest/utils/diff';
 
-/**
-* Registers a callback function to be executed once before all tests within the current suite.
-* This hook is useful for scenarios where you need to perform setup operations that are common to all tests in a suite, such as initializing a database connection or setting up a test environment.
-*
-* **Note:** The `beforeAll` hooks are executed in the order they are defined one after another. You can configure this by changing the `sequence.hooks` option in the config file.
-*
-* @param {Function} fn - The callback function to be executed before all tests.
-* @param {number} [timeout] - Optional timeout in milliseconds for the hook. If not provided, the default hook timeout from the runner's configuration is used.
-* @returns {void}
-* @example
-* ```ts
-* // Example of using beforeAll to set up a database connection
-* beforeAll(async () => {
-*   await database.connect();
-* });
-* ```
-*/
-declare function beforeAll(fn: BeforeAllListener, timeout?: number): void;
-/**
-* Registers a callback function to be executed once after all tests within the current suite have completed.
-* This hook is useful for scenarios where you need to perform cleanup operations after all tests in a suite have run, such as closing database connections or cleaning up temporary files.
-*
-* **Note:** The `afterAll` hooks are running in reverse order of their registration. You can configure this by changing the `sequence.hooks` option in the config file.
-*
-* @param {Function} fn - The callback function to be executed after all tests.
-* @param {number} [timeout] - Optional timeout in milliseconds for the hook. If not provided, the default hook timeout from the runner's configuration is used.
-* @returns {void}
-* @example
-* ```ts
-* // Example of using afterAll to close a database connection
-* afterAll(async () => {
-*   await database.disconnect();
-* });
-* ```
-*/
-declare function afterAll(fn: AfterAllListener, timeout?: number): void;
-/**
-* Registers a callback function to be executed before each test within the current suite.
-* This hook is useful for scenarios where you need to reset or reinitialize the test environment before each test runs, such as resetting database states, clearing caches, or reinitializing variables.
-*
-* **Note:** The `beforeEach` hooks are executed in the order they are defined one after another. You can configure this by changing the `sequence.hooks` option in the config file.
-*
-* @param {Function} fn - The callback function to be executed before each test. This function receives an `TestContext` parameter if additional test context is needed.
-* @param {number} [timeout] - Optional timeout in milliseconds for the hook. If not provided, the default hook timeout from the runner's configuration is used.
-* @returns {void}
-* @example
-* ```ts
-* // Example of using beforeEach to reset a database state
-* beforeEach(async () => {
-*   await database.reset();
-* });
-* ```
-*/
-declare function beforeEach<ExtraContext = object>(fn: BeforeEachListener<ExtraContext>, timeout?: number): void;
-/**
-* Registers a callback function to be executed after each test within the current suite has completed.
-* This hook is useful for scenarios where you need to clean up or reset the test environment after each test runs, such as deleting temporary files, clearing test-specific database entries, or resetting mocked functions.
-*
-* **Note:** The `afterEach` hooks are running in reverse order of their registration. You can configure this by changing the `sequence.hooks` option in the config file.
-*
-* @param {Function} fn - The callback function to be executed after each test. This function receives an `TestContext` parameter if additional test context is needed.
-* @param {number} [timeout] - Optional timeout in milliseconds for the hook. If not provided, the default hook timeout from the runner's configuration is used.
-* @returns {void}
-* @example
-* ```ts
-* // Example of using afterEach to delete temporary files created during a test
-* afterEach(async () => {
-*   await fileSystem.deleteTempFiles();
-* });
-* ```
-*/
-declare function afterEach<ExtraContext = object>(fn: AfterEachListener<ExtraContext>, timeout?: number): void;
-/**
-* Registers a callback function to be executed when a test fails within the current suite.
-* This function allows for custom actions to be performed in response to test failures, such as logging, cleanup, or additional diagnostics.
-*
-* **Note:** The `onTestFailed` hooks are running in reverse order of their registration. You can configure this by changing the `sequence.hooks` option in the config file.
-*
-* @param {Function} fn - The callback function to be executed upon a test failure. The function receives the test result (including errors).
-* @param {number} [timeout] - Optional timeout in milliseconds for the hook. If not provided, the default hook timeout from the runner's configuration is used.
-* @throws {Error} Throws an error if the function is not called within a test.
-* @returns {void}
-* @example
-* ```ts
-* // Example of using onTestFailed to log failure details
-* onTestFailed(({ errors }) => {
-*   console.log(`Test failed: ${test.name}`, errors);
-* });
-* ```
-*/
-declare const onTestFailed: TaskHook<OnTestFailedHandler>;
-/**
-* Registers a callback function to be executed when the current test finishes, regardless of the outcome (pass or fail).
-* This function is ideal for performing actions that should occur after every test execution, such as cleanup, logging, or resetting shared resources.
-*
-* This hook is useful if you have access to a resource in the test itself and you want to clean it up after the test finishes. It is a more compact way to clean up resources than using the combination of `beforeEach` and `afterEach`.
-*
-* **Note:** The `onTestFinished` hooks are running in reverse order of their registration. You can configure this by changing the `sequence.hooks` option in the config file.
-*
-* **Note:** The `onTestFinished` hook is not called if the test is canceled with a dynamic `ctx.skip()` call.
-*
-* @param {Function} fn - The callback function to be executed after a test finishes. The function can receive parameters providing details about the completed test, including its success or failure status.
-* @param {number} [timeout] - Optional timeout in milliseconds for the hook. If not provided, the default hook timeout from the runner's configuration is used.
-* @throws {Error} Throws an error if the function is not called within a test.
-* @returns {void}
-* @example
-* ```ts
-* // Example of using onTestFinished for cleanup
-* const db = await connectToDatabase();
-* onTestFinished(async () => {
-*   await db.disconnect();
-* });
-* ```
-*/
-declare const onTestFinished: TaskHook<OnTestFinishedHandler>;
-
 declare function setFn(key: Test, fn: () => Awaitable<void>): void;
 declare function getFn<Task = Test>(key: Task): () => Awaitable<void>;
 declare function setHooks(key: Suite, hooks: SuiteHooks): void;
@@ -257,4 +141,4 @@ declare function createTaskCollector(fn: (...args: any[]) => any, context?: Reco
 
 declare function getCurrentTest<T extends Test | undefined>(): T;
 
-export { AfterAllListener, AfterEachListener, BeforeAllListener, BeforeEachListener, File, FileSpecification, OnTestFailedHandler, OnTestFinishedHandler, Suite, SuiteAPI, SuiteCollector, SuiteHooks, Task, TaskHook, TaskUpdateEvent, Test, TestAPI, VitestRunner, afterAll, afterEach, beforeAll, beforeEach, publicCollect as collectTests, createTaskCollector, describe, getCurrentSuite, getCurrentTest, getFn, getHooks, it, onTestFailed, onTestFinished, setFn, setHooks, startTests, suite, test, updateTask };
+export { File, FileSpecification, Suite, SuiteAPI, SuiteCollector, SuiteHooks, Task, TaskUpdateEvent, Test, TestAPI, VitestRunner, publicCollect as collectTests, createTaskCollector, describe, getCurrentSuite, getCurrentTest, getFn, getHooks, it, setFn, setHooks, startTests, suite, test, updateTask };

package/dist/index.js

@@ -913,6 +913,10 @@ function createTaskCollector(fn, context) {
 			originalWrapper.call(context, formatName(name), optionsOrFn, optionsOrTest);
 		}, _context);
 	};
+	taskFn.beforeEach = beforeEach;
+	taskFn.afterEach = afterEach;
+	taskFn.beforeAll = beforeAll;
+	taskFn.afterAll = afterAll;
 	const _test = createChainable([
 		"concurrent",
 		"sequential",
@@ -1682,8 +1686,8 @@ function createTestContext(test, runner) {
 			type: type || "notice"
 		};
 		if (attachment) {
-			if (!attachment.body && !attachment.path) {
-				throw new TypeError(`Test attachment requires body or path to be set. Both are missing.`);
+			if (attachment.body == null && !attachment.path) {
+				throw new TypeError(`Test attachment requires "body" or "path" to be set. Both are missing.`);
 			}
 			if (attachment.body && attachment.path) {
 				throw new TypeError(`Test attachment requires only one of "body" or "path" to be set. Both are specified.`);

package/dist/types.d.ts

@@ -1,6 +1,6 @@
 import { DiffOptions } from '@vitest/utils/diff';
-import { F as File, a as Test, S as Suite, D as TaskResultPack, w as TaskEventPack, G as TestAnnotation, K as TestContext, I as ImportDuration, r as SequenceHooks, s as SequenceSetupFiles } from './tasks.d-B4TVMiFg.js';
-export { A as AfterAllListener, b as AfterEachListener, B as BeforeAllListener, d as BeforeEachListener, l as Fixture, m as FixtureFn, n as FixtureOptions, o as Fixtures, p as InferFixturesTypes, O as OnTestFailedHandler, f as OnTestFinishedHandler, R as RunMode, q as RuntimeContext, j as SuiteAPI, k as SuiteCollector, t as SuiteFactory, g as SuiteHooks, T as Task, u as TaskBase, v as TaskCustomOptions, e as TaskHook, x as TaskMeta, y as TaskPopulated, z as TaskResult, E as TaskState, h as TaskUpdateEvent, i as TestAPI, H as TestAnnotationLocation, J as TestAttachment, L as TestFunction, M as TestOptions, U as Use } from './tasks.d-B4TVMiFg.js';
+import { F as File, T as Test, S as Suite, J as TaskResultPack, C as TaskEventPack, L as TestAnnotation, P as TestContext, I as ImportDuration, v as SequenceHooks, w as SequenceSetupFiles } from './hooks.d-C0RE9A6t.js';
+export { A as AfterAllListener, l as AfterEachListener, B as BeforeAllListener, m as BeforeEachListener, n as Fixture, p as FixtureFn, q as FixtureOptions, r as Fixtures, s as InferFixturesTypes, O as OnTestFailedHandler, t as OnTestFinishedHandler, R as RunMode, u as RuntimeContext, e as SuiteAPI, f as SuiteCollector, x as SuiteFactory, a as SuiteHooks, c as Task, y as TaskBase, z as TaskCustomOptions, D as TaskHook, E as TaskMeta, G as TaskPopulated, H as TaskResult, K as TaskState, b as TaskUpdateEvent, d as TestAPI, M as TestAnnotationLocation, N as TestAttachment, Q as TestFunction, U as TestOptions, V as Use } from './hooks.d-C0RE9A6t.js';
 import '@vitest/utils';
 
 /**

package/dist/utils.d.ts

@@ -1,5 +1,5 @@
-import { S as Suite, F as File, T as Task, a as Test } from './tasks.d-B4TVMiFg.js';
-export { C as ChainableFunction, c as createChainable } from './tasks.d-B4TVMiFg.js';
+import { S as Suite, F as File, c as Task, T as Test } from './hooks.d-C0RE9A6t.js';
+export { W as ChainableFunction, X as createChainable } from './hooks.d-C0RE9A6t.js';
 import { ParsedStack, Arrayable } from '@vitest/utils';
 
 /**

package/package.json

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