vitest 3.2.0-beta.2 → 3.2.0

package/dist/chunks/{reporters.d.CLC9rhKy.d.ts → reporters.d.C1ogPriE.d.ts}

@@ -1,13 +1,13 @@
-import { Task, TaskMeta, Suite, File, TaskResultPack, SequenceSetupFiles, SequenceHooks, CancelReason } from '@vitest/runner';
-import { b as Awaitable, U as UserConsoleLog, c as Arrayable$1, A as AfterSuiteRunMeta, L as LabelColor, f as EnvironmentOptions, P as ProvidedContext } from './environment.d.D8YDy2v5.js';
+import { Task, TaskMeta, Suite, File, TestAnnotation, ImportDuration, TaskResultPack, TaskEventPack, SequenceSetupFiles, SequenceHooks, CancelReason } from '@vitest/runner';
+import { b as Awaitable, U as UserConsoleLog, c as Arrayable$1, A as AfterSuiteRunMeta, L as LabelColor, f as EnvironmentOptions, P as ProvidedContext } from './environment.d.cL3nLXbE.js';
 import { ParsedStack, TestError, SerializedError, ErrorWithDiff, Arrayable, Awaitable as Awaitable$1 } from '@vitest/utils';
 import { Writable } from 'node:stream';
 import { TransformResult as TransformResult$1, UserConfig as UserConfig$1, DepOptimizationConfig, ServerOptions, ConfigEnv, AliasOptions, ViteDevServer, ModuleNode } from 'vite';
 import { Console } from 'node:console';
 import { MockedModule } from '@vitest/mocker';
 import { StackTraceParserOptions } from '@vitest/utils/source-map';
-import { T as TestExecutionMethod } from './worker.d.CoCI7hzP.js';
-import { a as SerializedConfig, F as FakeTimerInstallOpts } from './config.d.UqE-KR0o.js';
+import { T as TestExecutionMethod } from './worker.d.tQu2eJQy.js';
+import { a as SerializedConfig, F as FakeTimerInstallOpts } from './config.d.D2ROskhv.js';
 import { PrettyFormatOptions } from '@vitest/pretty-format';
 import { SnapshotSummary, SnapshotStateOptions } from '@vitest/snapshot';
 import { SerializedDiffOptions } from '@vitest/utils/diff';
@@ -133,6 +133,10 @@ declare class TestCase extends ReportedTaskImplementation {
 	*/
 	result(): TestResult;
 	/**
+	* Test annotations added via the `task.annotate` API during the test execution.
+	*/
+	annotations(): ReadonlyArray<TestAnnotation>;
+	/**
 	* Useful information about the test like duration, memory usage, etc.
 	* Diagnostic is only available after the test has finished.
 	*/
@@ -373,6 +377,10 @@ interface ModuleDiagnostic {
 	* This value is only available if the test was executed with `logHeapUsage` flag.
 	*/
 	readonly heap: number | undefined;
+	/**
+	* The time spent importing every non-externalized dependency that Vitest has processed.
+	*/
+	readonly importDurations: Record<string, ImportDuration>;
 }
 
 type BuiltinPool = "browser" | "threads" | "forks" | "vmThreads" | "vmForks" | "typescript";
@@ -573,7 +581,7 @@ interface Reporter {
 	/**
 	* @deprecated use `onTestModuleQueued`, `onTestModuleStart`, `onTestModuleEnd`, `onTestCaseReady`, `onTestCaseResult` instead
 	*/
-	onTaskUpdate?: (packs: TaskResultPack[]) => Awaitable<void>;
+	onTaskUpdate?: (packs: TaskResultPack[], events: TaskEventPack[]) => Awaitable<void>;
 	onTestRemoved?: (trigger?: string) => Awaitable<void>;
 	onWatcherStart?: (files?: File[], errors?: unknown[]) => Awaitable<void>;
 	onWatcherRerun?: (files: string[], trigger?: string) => Awaitable<void>;
@@ -615,6 +623,10 @@ interface Reporter {
 	*/
 	onTestCaseResult?: (testCase: TestCase) => Awaitable<void>;
 	/**
+	* Called when annotation is added via the `task.annotate` API.
+	*/
+	onTestCaseAnnotate?: (testCase: TestCase, annotation: TestAnnotation) => Awaitable<void>;
+	/**
 	* Called when test suite is ready to run.
 	* Called before the `beforeAll` hooks for the test are run.
 	*/
@@ -666,6 +678,7 @@ declare abstract class BaseReporter implements Reporter {
 	protected getTestName(test: Task, separator?: string): string;
 	protected formatShortError(error: ErrorWithDiff): string;
 	protected getTestIndentation(_test: Task): string;
+	protected printAnnotations(test: TestCase, console: "log" | "error", padding?: number): void;
 	protected getDurationPrefix(task: Task): string;
 	onWatcherStart(files?: File[], errors?: unknown[]): void;
 	onWatcherRerun(files: string[], trigger?: string): void;
@@ -714,7 +727,6 @@ declare class DefaultReporter extends BaseReporter {
 	onHookStart(hook: ReportedHookContext): void;
 	onHookEnd(hook: ReportedHookContext): void;
 	onInit(ctx: Vitest): void;
-	onPathsCollected(paths?: string[]): void;
 	onTestRunEnd(): void;
 }
 
@@ -826,6 +838,9 @@ declare class FileCoverage implements FileCoverageData {
     b: { [key: string]: number[] };
 }
 
+// for compatibility reasons, the reporter produces a JSON similar to the one produced by the Jest JSON reporter
+// the following types are extracted from the Jest repository (and simplified)
+// the commented-out fields are the missing ones
 type Status = "passed" | "failed" | "skipped" | "pending" | "todo" | "disabled";
 type Milliseconds = number;
 interface Callsite {
@@ -946,9 +961,15 @@ declare class DotReporter extends BaseReporter {
 	private createSummary;
 }
 
+interface GithubActionsReporterOptions {
+	onWritePath?: (path: string) => string;
+}
 declare class GithubActionsReporter implements Reporter {
 	ctx: Vitest;
+	options: GithubActionsReporterOptions;
+	constructor(options?: GithubActionsReporterOptions);
 	onInit(ctx: Vitest): void;
+	onTestCaseAnnotate(testCase: TestCase, annotation: TestAnnotation): void;
 	onFinished(files?: File[], errors?: unknown[]): void;
 }
 
@@ -1425,6 +1446,7 @@ interface Thresholds {
 }
 
 type BuiltinEnvironment = "node" | "jsdom" | "happy-dom" | "edge-runtime";
+// Record is used, so user can get intellisense for builtin environments, but still allow custom environments
 type VitestEnvironment = BuiltinEnvironment | (string & Record<never, never>);
 
 type CSSModuleScopeStrategy = "stable" | "scoped" | "non-scoped";
@@ -1974,7 +1996,7 @@ interface InlineConfig {
 	maxConcurrency?: number;
 	/**
 	* Options for configuring cache policy.
-	* @default { dir: 'node_modules/.vite/vitest' }
+	* @default { dir: 'node_modules/.vite/vitest/{project-hash}' }
 	*/
 	cache?: false | {
 		/**
@@ -2132,6 +2154,12 @@ interface InlineConfig {
 	* @default false
 	*/
 	includeTaskLocation?: boolean;
+	/**
+	* Directory path for storing attachments created by `context.annotate`
+	*
+	* @default '.vitest-attachments'
+	*/
+	attachmentsDir?: string;
 }
 interface TypecheckConfig {
 	/**
@@ -2173,6 +2201,11 @@ interface TypecheckConfig {
 	* Path to tsconfig, relative to the project root.
 	*/
 	tsconfig?: string;
+	/**
+	* Minimum time in milliseconds it takes to spawn the typechecker.
+	* @default 10_000
+	*/
+	spawnTimeout?: number;
 }
 interface UserConfig extends InlineConfig {
 	/**
@@ -2351,6 +2384,7 @@ interface BrowserProvider {
 	openPage: (sessionId: string, url: string, beforeNavigate?: () => Promise<void>) => Promise<void>;
 	getCDPSession?: (sessionId: string) => Promise<CDPSession>;
 	close: () => Awaitable$1<void>;
+	// eslint-disable-next-line ts/method-signature-style -- we want to allow extended options
 	initialize(ctx: TestProject, options: BrowserProviderInitializationOptions): Awaitable$1<void>;
 }
 interface BrowserProviderModule {
@@ -2613,6 +2647,8 @@ declare class TestProject {
 	* It is based on the root of the project (not consistent between OS) and its name.
 	*/
 	get hash(): string;
+	// "provide" is a property, not a method to keep the context when destructed in the global setup,
+	// making it a method would be a breaking change, and can be done in Vitest 3 at minimum
 	/**
 	* Provide a value to the test context. This value will be available to all tests with `inject`.
 	*/
@@ -2664,6 +2700,7 @@ declare class TestProject {
 	teardownGlobalSetup(): Promise<void>;
 	/** @deprecated use `vitest.logger` instead */
 	get logger(): Logger;
+	// it's possible that file path was imported with different queries (?raw, ?url, etc)
 	/** @deprecated use `.vite` or `.browser.vite` directly */
 	getModulesByFilepath(file: string): Set<ModuleNode>;
 	/** @deprecated use `.vite` or `.browser.vite` directly */
@@ -2879,7 +2916,7 @@ declare class Vitest {
 	private _cache?;
 	private _snapshot?;
 	private _workspaceConfigPath?;
-	constructor(mode: VitestRunMode, options?: VitestOptions);
+	constructor(mode: VitestRunMode, cliOptions: UserConfig, options?: VitestOptions);
 	private _onRestartListeners;
 	private _onClose;
 	private _onSetServer;
@@ -2914,7 +2951,7 @@ declare class Vitest {
 	*/
 	get cache(): VitestCache;
 	/** @deprecated internal */
-	setServer(options: UserConfig, server: ViteDevServer, cliOptions: UserConfig): Promise<void>;
+	setServer(options: UserConfig, server: ViteDevServer): Promise<void>;
 	/**
 	* Inject new test projects into the workspace.
 	* @param config Glob, config path or a custom config options.
@@ -3046,6 +3083,7 @@ declare class Vitest {
 	*/
 	resetGlobalTestNamePattern(): void;
 	private _rerunTimer;
+	// we can't use a single `triggerId` yet because vscode extension relies on this
 	private scheduleRerun;
 	/**
 	* Invalidate a file in all projects.

package/dist/chunks/{rpc.D9_013TY.js → rpc.Iovn4oWe.js}

@@ -1,6 +1,6 @@
 import { getSafeTimers } from '@vitest/utils';
 import { c as createBirpc } from './index.CJ0plNrh.js';
-import { g as getWorkerState } from './utils.CgTj3MsC.js';
+import { g as getWorkerState } from './utils.XdZDrNZV.js';
 
 const { get } = Reflect;
 function withSafeTimers(fn) {
@@ -15,9 +15,7 @@ function withSafeTimers(fn) {
 		globalThis.clearTimeout = clearTimeout;
 		globalThis.setImmediate = setImmediate;
 		globalThis.clearImmediate = clearImmediate;
-		if (globalThis.process) {
-			globalThis.process.nextTick = nextTick;
-		}
+		if (globalThis.process) globalThis.process.nextTick = nextTick;
 		const result = fn();
 		return result;
 	} finally {
@@ -25,18 +23,14 @@ function withSafeTimers(fn) {
 		globalThis.clearTimeout = currentClearTimeout;
 		globalThis.setImmediate = currentSetImmediate;
 		globalThis.clearImmediate = currentClearImmediate;
-		if (globalThis.process) {
-			nextTick(() => {
-				globalThis.process.nextTick = currentNextTick;
-			});
-		}
+		if (globalThis.process) nextTick(() => {
+			globalThis.process.nextTick = currentNextTick;
+		});
 	}
 }
-const promises = new Set();
+const promises = /* @__PURE__ */ new Set();
 async function rpcDone() {
-	if (!promises.size) {
-		return;
-	}
+	if (!promises.size) return;
 	const awaitable = Array.from(promises);
 	return Promise.all(awaitable);
 }
@@ -53,12 +47,9 @@ function createRuntimeRpc(options) {
 		],
 		onTimeoutError(functionName, args) {
 			let message = `[vitest-worker]: Timeout calling "${functionName}"`;
-			if (functionName === "fetch" || functionName === "transform" || functionName === "resolveId") {
-				message += ` with "${JSON.stringify(args)}"`;
-			}
-			if (functionName === "onUnhandledError") {
-				message += ` with "${args[0]?.message || args[0]}"`;
-			}
+			if (functionName === "fetch" || functionName === "transform" || functionName === "resolveId") message += ` with "${JSON.stringify(args)}"`;
+			// JSON.stringify cannot serialize Error instances
+			if (functionName === "onUnhandledError") message += ` with "${args[0]?.message || args[0]}"`;
 			throw new Error(message);
 		},
 		...options

package/dist/chunks/{runBaseTests.Dn2vyej_.js → runBaseTests.Dd85QTll.js}

@@ -1,9 +1,9 @@
 import { performance } from 'node:perf_hooks';
 import { startTests, collectTests } from '@vitest/runner';
-import { a as resolveSnapshotEnvironment, s as setupChaiConfig, r as resolveTestRunner } from './index.DswW_LEs.js';
-import { c as setupCommonEnv, s as startCoverageInsideWorker, a as stopCoverageInsideWorker } from './setup-common.CYo3Y0dD.js';
-import { a as globalExpect, v as vi } from './vi.BFR5YIgu.js';
-import { c as closeInspector } from './inspector.DbDkSkFn.js';
+import { a as resolveSnapshotEnvironment, s as setupChaiConfig, r as resolveTestRunner } from './index.BbB8_kAK.js';
+import { c as setupCommonEnv, s as startCoverageInsideWorker, a as stopCoverageInsideWorker } from './setup-common.Dd054P77.js';
+import { a as globalExpect, v as vi } from './vi.bdSIJ99Y.js';
+import { c as closeInspector } from './inspector.C914Efll.js';
 import { createRequire } from 'node:module';
 import timers from 'node:timers';
 import timersPromises from 'node:timers/promises';
@@ -11,15 +11,15 @@ import util from 'node:util';
 import { getSafeTimers } from '@vitest/utils';
 import { KNOWN_ASSET_TYPES } from 'vite-node/constants';
 import { installSourcemapsSupport } from 'vite-node/source-map';
-import { V as VitestIndex } from './index.CfXMNXHg.js';
-import { g as getWorkerState, r as resetModules } from './utils.CgTj3MsC.js';
+import { V as VitestIndex } from './index.CdQS2e2Q.js';
+import { g as getWorkerState, r as resetModules } from './utils.XdZDrNZV.js';
 import 'chai';
 import 'node:path';
 import '../path.js';
 import 'node:url';
-import './rpc.D9_013TY.js';
+import './rpc.Iovn4oWe.js';
 import './index.CJ0plNrh.js';
-import './coverage.0iPg4Wrz.js';
+import './coverage.DVF1vEu8.js';
 import '@vitest/snapshot';
 import '@vitest/expect';
 import '@vitest/runner/utils';
@@ -27,10 +27,11 @@ import './_commonjsHelpers.BFTU3MAI.js';
 import '@vitest/utils/error';
 import '@vitest/spy';
 import '@vitest/utils/source-map';
-import './date.CDOsz-HY.js';
-import './benchmark.BoF7jW0Q.js';
+import './date.Bq6ZW5rf.js';
+import './benchmark.CYdenmiT.js';
 import 'expect-type';
 
+// this should only be used in Node
 let globalSetup = false;
 async function setupGlobalEnv(config, { environment }, executor) {
 	await setupCommonEnv(config);
@@ -39,35 +40,30 @@ async function setupGlobalEnv(config, { environment }, executor) {
 		enumerable: false
 	});
 	const state = getWorkerState();
-	if (!state.config.snapshotOptions.snapshotEnvironment) {
-		state.config.snapshotOptions.snapshotEnvironment = await resolveSnapshotEnvironment(config, executor);
-	}
-	if (globalSetup) {
-		return;
-	}
+	if (!state.config.snapshotOptions.snapshotEnvironment) state.config.snapshotOptions.snapshotEnvironment = await resolveSnapshotEnvironment(config, executor);
+	if (globalSetup) return;
 	globalSetup = true;
 	if (environment.transformMode === "web") {
 		const _require = createRequire(import.meta.url);
+		// always mock "required" `css` files, because we cannot process them
 		_require.extensions[".css"] = resolveCss;
 		_require.extensions[".scss"] = resolveCss;
 		_require.extensions[".sass"] = resolveCss;
 		_require.extensions[".less"] = resolveCss;
+		// since we are using Vite, we can assume how these will be resolved
 		KNOWN_ASSET_TYPES.forEach((type) => {
 			_require.extensions[`.${type}`] = resolveAsset;
 		});
 		process.env.SSR = "";
-	} else {
-		process.env.SSR = "1";
-	}
+	} else process.env.SSR = "1";
+	// @ts-expect-error not typed global for patched timers
 	globalThis.__vitest_required__ = {
 		util,
 		timers,
 		timersPromises
 	};
 	installSourcemapsSupport({ getSourceMap: (source) => state.moduleCache.getSourceMap(source) });
-	if (!config.disableConsoleIntercept) {
-		await setupConsoleLogSpy();
-	}
+	if (!config.disableConsoleIntercept) await setupConsoleLogSpy();
 }
 function resolveCss(mod) {
 	mod.exports = "";
@@ -76,22 +72,25 @@ function resolveAsset(mod, url) {
 	mod.exports = url;
 }
 async function setupConsoleLogSpy() {
-	const { createCustomConsole } = await import('./console.K1NMVOSc.js');
+	const { createCustomConsole } = await import('./console.CtFJOzRO.js');
 	globalThis.console = createCustomConsole();
 }
 async function withEnv({ environment }, options, fn) {
+	// @ts-expect-error untyped global
 	globalThis.__vitest_environment__ = environment.name;
 	globalExpect.setState({ environment: environment.name });
 	const env = await environment.setup(globalThis, options);
 	try {
 		await fn();
 	} finally {
+		// Run possible setTimeouts, e.g. the onces used by ConsoleLogSpy
 		const { setTimeout } = getSafeTimers();
 		await new Promise((resolve) => setTimeout(resolve));
 		await env.teardown(globalThis);
 	}
 }
 
+// browser shouldn't call this!
 async function run(method, files, config, environment, executor) {
 	const workerState = getWorkerState();
 	const isIsolatedThreads = config.pool === "threads" && (config.poolOptions?.threads?.isolate ?? true);
@@ -99,9 +98,7 @@ async function run(method, files, config, environment, executor) {
 	const isolate = isIsolatedThreads || isIsolatedForks;
 	await setupGlobalEnv(config, environment, executor);
 	await startCoverageInsideWorker(config.coverage, executor, { isolate });
-	if (config.chaiConfig) {
-		setupChaiConfig(config.chaiConfig);
-	}
+	if (config.chaiConfig) setupChaiConfig(config.chaiConfig);
 	const runner = await resolveTestRunner(config, executor);
 	workerState.onCancel.then((reason) => {
 		closeInspector(config);
@@ -117,12 +114,11 @@ async function run(method, files, config, environment, executor) {
 				resetModules(workerState.moduleCache, true);
 			}
 			workerState.filepath = file.filepath;
-			if (method === "run") {
-				await startTests([file], runner);
-			} else {
-				await collectTests([file], runner);
-			}
+			if (method === "run") await startTests([file], runner);
+			else await collectTests([file], runner);
+			// reset after tests, because user might call `vi.setConfig` in setupFile
 			vi.resetConfig();
+			// mocks should not affect different files
 			vi.restoreAllMocks();
 		}
 		await stopCoverageInsideWorker(config.coverage, executor, { isolate });

package/dist/chunks/{setup-common.CYo3Y0dD.js → setup-common.Dd054P77.js}

@@ -1,26 +1,20 @@
-import { r as resolveCoverageProviderModule } from './coverage.0iPg4Wrz.js';
+import { r as resolveCoverageProviderModule } from './coverage.DVF1vEu8.js';
 import { addSerializer } from '@vitest/snapshot';
 import { setSafeTimers } from '@vitest/utils';
 
 async function startCoverageInsideWorker(options, loader, runtimeOptions) {
 	const coverageModule = await resolveCoverageProviderModule(options, loader);
-	if (coverageModule) {
-		return coverageModule.startCoverage?.(runtimeOptions);
-	}
+	if (coverageModule) return coverageModule.startCoverage?.(runtimeOptions);
 	return null;
 }
 async function takeCoverageInsideWorker(options, loader) {
 	const coverageModule = await resolveCoverageProviderModule(options, loader);
-	if (coverageModule) {
-		return coverageModule.takeCoverage?.({ moduleExecutionInfo: loader.moduleExecutionInfo });
-	}
+	if (coverageModule) return coverageModule.takeCoverage?.({ moduleExecutionInfo: loader.moduleExecutionInfo });
 	return null;
 }
 async function stopCoverageInsideWorker(options, loader, runtimeOptions) {
 	const coverageModule = await resolveCoverageProviderModule(options, loader);
-	if (coverageModule) {
-		return coverageModule.stopCoverage?.(runtimeOptions);
-	}
+	if (coverageModule) return coverageModule.stopCoverage?.(runtimeOptions);
 	return null;
 }
 
@@ -28,56 +22,36 @@ let globalSetup = false;
 async function setupCommonEnv(config) {
 	setupDefines(config.defines);
 	setupEnv(config.env);
-	if (globalSetup) {
-		return;
-	}
+	if (globalSetup) return;
 	globalSetup = true;
 	setSafeTimers();
-	if (config.globals) {
-		(await import('./globals.CpxW8ccg.js')).registerApiGlobally();
-	}
+	if (config.globals) (await import('./globals.DEHgCU4V.js')).registerApiGlobally();
 }
 function setupDefines(defines) {
-	for (const key in defines) {
-		globalThis[key] = defines[key];
-	}
+	for (const key in defines) globalThis[key] = defines[key];
 }
 function setupEnv(env) {
-	if (typeof process === "undefined") {
-		return;
-	}
+	if (typeof process === "undefined") return;
+	// same boolean-to-string assignment as VitestPlugin.configResolved
 	const { PROD, DEV,...restEnvs } = env;
 	process.env.PROD = PROD ? "1" : "";
 	process.env.DEV = DEV ? "1" : "";
-	for (const key in restEnvs) {
-		process.env[key] = env[key];
-	}
+	for (const key in restEnvs) process.env[key] = env[key];
 }
 async function loadDiffConfig(config, executor) {
-	if (typeof config.diff === "object") {
-		return config.diff;
-	}
-	if (typeof config.diff !== "string") {
-		return;
-	}
+	if (typeof config.diff === "object") return config.diff;
+	if (typeof config.diff !== "string") return;
 	const diffModule = await executor.executeId(config.diff);
-	if (diffModule && typeof diffModule.default === "object" && diffModule.default != null) {
-		return diffModule.default;
-	} else {
-		throw new Error(`invalid diff config file ${config.diff}. Must have a default export with config object`);
-	}
+	if (diffModule && typeof diffModule.default === "object" && diffModule.default != null) return diffModule.default;
+	else throw new Error(`invalid diff config file ${config.diff}. Must have a default export with config object`);
 }
 async function loadSnapshotSerializers(config, executor) {
 	const files = config.snapshotSerializers;
 	const snapshotSerializers = await Promise.all(files.map(async (file) => {
 		const mo = await executor.executeId(file);
-		if (!mo || typeof mo.default !== "object" || mo.default === null) {
-			throw new Error(`invalid snapshot serializer file ${file}. Must export a default object`);
-		}
+		if (!mo || typeof mo.default !== "object" || mo.default === null) throw new Error(`invalid snapshot serializer file ${file}. Must export a default object`);
 		const config = mo.default;
-		if (typeof config.test !== "function" || typeof config.serialize !== "function" && typeof config.print !== "function") {
-			throw new TypeError(`invalid snapshot serializer in ${file}. Must have a 'test' method along with either a 'serialize' or 'print' method.`);
-		}
+		if (typeof config.test !== "function" || typeof config.serialize !== "function" && typeof config.print !== "function") throw new TypeError(`invalid snapshot serializer in ${file}. Must have a 'test' method along with either a 'serialize' or 'print' method.`);
 		return config;
 	}));
 	snapshotSerializers.forEach((serializer) => addSerializer(serializer));