vitest 3.2.0-beta.1 → 3.2.0-beta.3

package/dist/chunks/{creator.CuL7xDWI.js → creator.C8WKy2eW.js}

@@ -1,11 +1,11 @@
 import { existsSync, writeFileSync, readFileSync } from 'node:fs';
 import { mkdir, writeFile } from 'node:fs/promises';
 import { resolve, dirname, relative } from 'node:path';
-import { detectPackageManager, installPackage } from './index.Bw6JxgX8.js';
-import { p as prompt, f as findUp } from './index.DBIGubLC.js';
+import { detectPackageManager, installPackage } from './index.D3XRDfWc.js';
+import { p as prompt, f as findUp } from './index.X0nbfr6-.js';
 import { x } from 'tinyexec';
 import c from 'tinyrainbow';
-import { c as configFiles } from './constants.BZZyIeIE.js';
+import { c as configFiles } from './constants.DnKduX2e.js';
 import 'node:process';
 import 'node:url';
 import './_commonjsHelpers.BFTU3MAI.js';
@@ -236,14 +236,14 @@ test('renders name', () => {
 };
 function getExampleTest(framework) {
 	switch (framework) {
-		case "solid":
-		case "preact": return {
+		case "solid": return {
 			...jsxExample,
 			test: jsxExample.test.replace("@testing-library/jsx", `@testing-library/${framework}`)
 		};
+		case "preact":
 		case "react": return {
 			...jsxExample,
-			test: jsxExample.test.replace("@testing-library/jsx", "vitest-browser-react")
+			test: jsxExample.test.replace("@testing-library/jsx", `vitest-browser-${framework}`)
 		};
 		case "vue": return vueExample;
 		case "svelte": return svelteExample;
@@ -273,6 +273,7 @@ async function generateExampleFiles(framework, lang) {
 	return testPath;
 }
 
+// eslint-disable-next-line no-console
 const log = console.log;
 function getProviderOptions() {
 	const providers = {
@@ -376,7 +377,7 @@ function getFrameworkTestPackage(framework) {
 		case "svelte": return "vitest-browser-svelte";
 		case "react": return "vitest-browser-react";
 		case "lit": return "vitest-browser-lit";
-		case "preact": return "@testing-library/preact";
+		case "preact": return "vitest-browser-preact";
 		case "solid": return "@solidjs/testing-library";
 		case "marko": return "@marko/testing-library";
 	}
@@ -469,6 +470,7 @@ function getPossibleProvider(dependencies) {
 	if (dependencies.webdriverio || dependencies["@wdio/cli"] || dependencies["@wdio/config"]) {
 		return "webdriverio";
 	}
+	// playwright is the default recommendation
 	return "playwright";
 }
 function getProviderDocsLink(provider) {
@@ -488,32 +490,6 @@ function sort(choices, value) {
 function fail() {
 	process.exitCode = 1;
 }
-async function generateWorkspaceFile(options) {
-	const relativeRoot = relative(dirname(options.configPath), options.rootConfig);
-	const workspaceContent = [
-		`import { defineWorkspace } from 'vitest/config'`,
-		"",
-		"export default defineWorkspace([",
-		"  // If you want to keep running your existing tests in Node.js, uncomment the next line.",
-		`  // '${relativeRoot}',`,
-		`  {`,
-		`    extends: '${relativeRoot}',`,
-		`    test: {`,
-		`      browser: {`,
-		`        enabled: true,`,
-		`        provider: '${options.provider}',`,
-		options.provider !== "preview" && `        // ${getProviderDocsLink(options.provider)}`,
-		`        instances: [`,
-		...options.browsers.map((browser) => `        { browser: '${browser}' },`),
-		`        ],`,
-		`      },`,
-		`    },`,
-		`  },`,
-		`])`,
-		""
-	].filter((c) => typeof c === "string").join("\n");
-	await writeFile(options.configPath, workspaceContent);
-}
 async function generateFrameworkConfigFile(options) {
 	const frameworkImport = options.framework === "svelte" ? `import { svelte } from '${options.frameworkPlugin}'` : `import ${options.framework} from '${options.frameworkPlugin}'`;
 	const configContent = [
@@ -648,19 +624,24 @@ async function create() {
 	let scriptCommand = "vitest";
 	log();
 	if (rootConfig) {
-		let browserWorkspaceFile = resolve(dirname(rootConfig), `vitest.workspace.${lang}`);
-		if (existsSync(browserWorkspaceFile)) {
-			log(c.yellow("⚠"), c.yellow("A workspace file already exists. Creating a new one for the browser tests - you can merge them manually if needed."));
-			browserWorkspaceFile = resolve(process.cwd(), `vitest.workspace.browser.${lang}`);
-		}
-		scriptCommand = `vitest --workspace=${relative(process.cwd(), browserWorkspaceFile)}`;
-		await generateWorkspaceFile({
-			configPath: browserWorkspaceFile,
-			rootConfig,
+		const configPath = resolve(dirname(rootConfig), `vitest.browser.config.${lang}`);
+		scriptCommand = `vitest --config=${relative(process.cwd(), configPath)}`;
+		await generateFrameworkConfigFile({
+			configPath,
+			framework,
+			frameworkPlugin,
 			provider,
 			browsers
 		});
-		log(c.green("✔"), "Created a workspace file for browser tests:", c.bold(relative(process.cwd(), browserWorkspaceFile)));
+		log(
+			c.green("✔"),
+			"Created a new config file for browser tests:",
+			c.bold(relative(process.cwd(), configPath)),
+			// TODO: Can we modify the config ourselves?
+			"\nSince you already have a Vitest config file, it is recommended to copy the contents of the new file ",
+			"into your existing config located at ",
+			c.bold(relative(process.cwd(), rootConfig))
+		);
 	} else {
 		const configPath = resolve(process.cwd(), `vitest.config.${lang}`);
 		await generateFrameworkConfigFile({
@@ -670,7 +651,7 @@ async function create() {
 			provider,
 			browsers
 		});
-		log(c.green("✔"), "Created a config file for browser tests", c.bold(relative(process.cwd(), configPath)));
+		log(c.green("✔"), "Created a config file for browser tests:", c.bold(relative(process.cwd(), configPath)));
 	}
 	log();
 	await updatePkgJsonScripts(pkgJsonPath, scriptCommand);
@@ -691,6 +672,7 @@ async function create() {
 			"inherit"
 		] } });
 	}
+	// TODO: can we do this ourselves?
 	if (lang === "ts") {
 		await updateTsConfig(providerPkg?.types);
 	}

package/dist/chunks/{date.CDOsz-HY.js → date.ByMsSlOr.js}

@@ -1,3 +1,27 @@
+/* Ported from https://github.com/boblauer/MockDate/blob/master/src/mockdate.ts */
+/*
+The MIT License (MIT)
+
+Copyright (c) 2014 Bob Lauer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+*/
 const RealDate = Date;
 let now = null;
 class MockDate extends RealDate {
@@ -43,6 +67,7 @@ function mockDate(date) {
 	if (Number.isNaN(dateObj.getTime())) {
 		throw new TypeError(`mockdate: The time set is an invalid date: ${date}`);
 	}
+	// @ts-expect-error global
 	globalThis.Date = MockDate;
 	now = dateObj.valueOf();
 }

package/dist/chunks/{defaults.DSxsTG0h.js → defaults.DpVH7vbg.js}

@@ -36,6 +36,7 @@ const defaultCoverageExcludes = [
 	"**/vitest.{workspace,projects}.[jt]s?(on)",
 	"**/.{eslint,mocha,prettier}rc.{?(c|m)js,yml}"
 ];
+// These are the generic defaults for coverage. Providers may also set some provider specific defaults.
 const coverageConfigDefaults = {
 	provider: "v8",
 	enabled: false,

package/dist/chunks/{environment.d.D8YDy2v5.d.ts → environment.d.cL3nLXbE.d.ts}

@@ -36,6 +36,7 @@ interface ModuleGraphData {
 	inlined: string[];
 }
 interface ProvidedContext {}
+// These need to be compatible with Tinyrainbow's bg-colors, and CSS's background-color
 type LabelColor = "black" | "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white";
 
 type HappyDOMOptions = Omit<NonNullable<ConstructorParameters<typeof happyDomTypes.Window>[0]>, "console">;

package/dist/chunks/{execute.BpmIjFTD.js → execute.B3q-2LPV.js}

@@ -187,6 +187,8 @@ const basename = function(p, extension) {
 const { existsSync, readdirSync, statSync } = fs;
 function findMockRedirect(root, mockPath, external) {
 	const path = external || mockPath;
+	// it's a node_module alias
+	// all mocks should be inside <root>/__mocks__
 	if (external || isNodeBuiltin(mockPath) || !existsSync(mockPath)) {
 		const mockDirname = dirname(path);
 		const mockFolder = join(root, "__mocks__", mockDirname);
@@ -200,9 +202,11 @@ function findMockRedirect(root, mockPath, external) {
 				const baseFile = basename(file, extname(file));
 				if (baseFile === baseOriginal) {
 					const path = resolve(mockFolder, file);
+					// if the same name, return the file
 					if (statSync(path).isFile()) {
 						return path;
 					} else {
+						// find folder/index.{js,ts}
 						const indexFile = findFile(path, "index");
 						if (indexFile) {
 							return indexFile;
@@ -235,6 +239,7 @@ const builtins = new Set([
 	"util/types",
 	"wasi"
 ]);
+// https://nodejs.org/api/modules.html#built-in-modules-with-mandatory-node-prefix
 const prefixedBuiltins = new Set([
 	"node:sea",
 	"node:sqlite",
@@ -337,6 +342,7 @@ class VitestMocker {
 		try {
 			[id, fsPath] = await this.executor.originalResolveUrl(rawId, importer);
 		} catch (error) {
+			// it's allowed to mock unresolved modules
 			if (error.code === "ERR_MODULE_NOT_FOUND") {
 				const { id: unresolvedId } = error[Symbol.for("vitest.error.not_found.data")];
 				id = unresolvedId;
@@ -345,6 +351,8 @@ class VitestMocker {
 				throw error;
 			}
 		}
+		// external is node_module or unresolved module
+		// for example, some people mock "vscode" and don't have it installed
 		const external = !isAbsolute$1(fsPath) || this.isModuleDirectory(fsPath) ? rawId : null;
 		return {
 			id,
@@ -375,6 +383,7 @@ class VitestMocker {
 		const exports = await mock.resolve();
 		const moduleExports = new Proxy(exports, { get: (target, prop) => {
 			const val = target[prop];
+			// 'then' can exist on non-Promise objects, need nested instanceof check for logic to work
 			if (prop === "then") {
 				if (target instanceof Promise) {
 					return target.then.bind(target);
@@ -396,9 +405,11 @@ class VitestMocker {
 		this.moduleCache.set(dep, { exports: moduleExports });
 		return moduleExports;
 	}
+	// public method to avoid circular dependency
 	getMockContext() {
 		return this.mockContext;
 	}
+	// path used to store mocked dependencies
 	getMockPath(dep) {
 		return `mock:${dep}`;
 	}
@@ -444,6 +455,7 @@ class VitestMocker {
 				registry.register("automock", originalId, id, id);
 			}
 		}
+		// every time the mock is registered, we remove the previous one from the cache
 		this.deleteCachedItem(id);
 	}
 	async importActual(rawId, importer, callstack) {
@@ -485,6 +497,7 @@ class VitestMocker {
 				return cache.exports;
 			}
 			const exports = {};
+			// Assign the empty exports object early to allow for cycles to work. The object will be filled by mockObject()
 			this.moduleCache.set(mockPath, { exports });
 			const mod = await this.executor.directRequest(url, url, callstack);
 			this.mockObject(mod, exports, mock.type);
@@ -493,6 +506,9 @@ class VitestMocker {
 		if (mock.type === "manual" && !callstack.includes(mockPath) && !callstack.includes(url)) {
 			try {
 				callstack.push(mockPath);
+				// this will not work if user does Promise.all(import(), import())
+				// we can also use AsyncLocalStorage to store callstack, but this won't work in the browser
+				// maybe we should improve mock API in the future?
 				this.mockContext.callstack = callstack;
 				return await this.callFunctionMock(mockPath, mock);
 			} finally {
@@ -548,11 +564,11 @@ function listenForErrors(state) {
 	dispose.length = 0;
 	function catchError(err, type, event) {
 		const worker = state();
-		if (worker.current?.type === "test") {
-			const listeners = process.listeners(event);
-			if (listeners.length > 1) {
-				return;
-			}
+		const listeners = process.listeners(event);
+		// if there is another listener, assume that it's handled by user code
+		// one is Vitest's own listener
+		if (listeners.length > 1) {
+			return;
 		}
 		const error = processError(err);
 		if (!isPrimitive(error)) {
@@ -578,6 +594,8 @@ function getVitestImport(id, state) {
 	if (externalizeMap.has(id)) {
 		return { externalize: externalizeMap.get(id) };
 	}
+	// always externalize Vitest because we import from there before running tests
+	// so we already have it cached by Node.js
 	const root = state().config.root;
 	const relativeRoot = relativeIds[root] ?? (relativeIds[root] = normalizedDistDir.slice(root.length));
 	if (id.includes(distDir) || id.includes(normalizedDistDir) || relativeRoot && relativeRoot !== "/" && id.startsWith(relativeRoot)) {
@@ -715,6 +733,7 @@ class VitestExecutor extends ViteNodeRunner {
 		return this.primitives;
 	}
 	get state() {
+		// @ts-expect-error injected untyped global
 		return globalThis.__vitest_worker__ || this.options.state;
 	}
 	get moduleExecutionInfo() {
@@ -725,6 +744,8 @@ class VitestExecutor extends ViteNodeRunner {
 			return false;
 		}
 		const transformMode = this.state.environment?.transformMode ?? "ssr";
+		// do not try and resolve node builtins in Node
+		// import('url') returns Node internal even if 'url' package is installed
 		return transformMode === "ssr" ? !isNodeBuiltin$1(id) : !id.startsWith("node:");
 	}
 	async originalResolveUrl(id, importer) {
@@ -756,6 +777,7 @@ class VitestExecutor extends ViteNodeRunner {
 		if (!vmContext || !this.externalModules) {
 			return super.runModule(context, transformed);
 		}
+		// add 'use strict' since ESM enables it by default
 		const codeDefinition = `'use strict';async (${Object.keys(context).join(",")})=>{{`;
 		const code = `${codeDefinition}${transformed}\n}}`;
 		const options = {
@@ -787,6 +809,7 @@ class VitestExecutor extends ViteNodeRunner {
 		return super.dependencyRequest(id, fsPath, callstack);
 	}
 	prepareContext(context) {
+		// support `import.meta.vitest` for test entry
 		if (this.state.filepath && normalize$1(this.state.filepath) === normalize$1(context.__filename)) {
 			const globalNamespace = this.options.context || globalThis;
 			Object.defineProperty(context.__vite_ssr_import_meta__, "vitest", { get: () => globalNamespace.__vitest_index__ });

package/dist/chunks/{global.d.BCOHQEpR.d.ts → global.d.BNLIi6yo.d.ts}

@@ -2,7 +2,7 @@ import { PromisifyAssertion, Tester, ExpectStatic } from '@vitest/expect';
 import { Plugin } from '@vitest/pretty-format';
 import { SnapshotState } from '@vitest/snapshot';
 import { B as BenchmarkResult } from './benchmark.d.BwvBVTda.js';
-import { U as UserConsoleLog } from './environment.d.D8YDy2v5.js';
+import { U as UserConsoleLog } from './environment.d.cL3nLXbE.js';
 
 type RawErrsMap = Map<string, TscErrorInfo[]>;
 interface TscErrorInfo {
@@ -29,6 +29,7 @@ type Context = RootAndTarget & {
 };
 
 declare global {
+	// eslint-disable-next-line ts/no-namespace
 	namespace Chai {
 		interface Assertion {
 			containSubset: (expected: any) => Assertion;
@@ -39,12 +40,12 @@ declare global {
 	}
 }
 interface SnapshotMatcher<T> {
-	<U extends { [P in keyof T] : any }>(snapshot: Partial<U>, message?: string): void;
-	(message?: string): void;
+	<U extends { [P in keyof T] : any }>(snapshot: Partial<U>, hint?: string): void;
+	(hint?: string): void;
 }
 interface InlineSnapshotMatcher<T> {
-	<U extends { [P in keyof T] : any }>(properties: Partial<U>, snapshot?: string, message?: string): void;
-	(message?: string): void;
+	<U extends { [P in keyof T] : any }>(properties: Partial<U>, snapshot?: string, hint?: string): void;
+	(hint?: string): void;
 }
 declare module "@vitest/expect" {
 	interface MatcherState {
@@ -66,41 +67,42 @@ declare module "@vitest/expect" {
 		addSnapshotSerializer: (plugin: Plugin) => void;
 	}
 	interface Assertion<T> {
+		// Snapshots are extended in @vitest/snapshot and are not part of @vitest/expect
 		matchSnapshot: SnapshotMatcher<T>;
 		toMatchSnapshot: SnapshotMatcher<T>;
 		toMatchInlineSnapshot: InlineSnapshotMatcher<T>;
 		/**
 		* Checks that an error thrown by a function matches a previously recorded snapshot.
 		*
-		* @param message - Optional custom error message.
+		* @param hint - Optional custom error message.
 		*
 		* @example
 		* expect(functionWithError).toThrowErrorMatchingSnapshot();
 		*/
-		toThrowErrorMatchingSnapshot: (message?: string) => void;
+		toThrowErrorMatchingSnapshot: (hint?: string) => void;
 		/**
 		* Checks that an error thrown by a function matches an inline snapshot within the test file.
 		* Useful for keeping snapshots close to the test code.
 		*
 		* @param snapshot - Optional inline snapshot string to match.
-		* @param message - Optional custom error message.
+		* @param hint - Optional custom error message.
 		*
 		* @example
 		* const throwError = () => { throw new Error('Error occurred') };
 		* expect(throwError).toThrowErrorMatchingInlineSnapshot(`"Error occurred"`);
 		*/
-		toThrowErrorMatchingInlineSnapshot: (snapshot?: string, message?: string) => void;
+		toThrowErrorMatchingInlineSnapshot: (snapshot?: string, hint?: string) => void;
 		/**
 		* Compares the received value to a snapshot saved in a specified file.
 		* Useful for cases where snapshot content is large or needs to be shared across tests.
 		*
 		* @param filepath - Path to the snapshot file.
-		* @param message - Optional custom error message.
+		* @param hint - Optional custom error message.
 		*
 		* @example
 		* await expect(largeData).toMatchFileSnapshot('path/to/snapshot.json');
 		*/
-		toMatchFileSnapshot: (filepath: string, message?: string) => Promise<void>;
+		toMatchFileSnapshot: (filepath: string, hint?: string) => Promise<void>;
 	}
 }
 declare module "@vitest/runner" {

package/dist/chunks/{globals.Cg4NtV4P.js → globals.CI21aWXF.js}

@@ -1,24 +1,24 @@
-import { g as globalApis } from './constants.BZZyIeIE.js';
-import { V as VitestIndex } from './index.BPc7M5ni.js';
-import './vi.BFR5YIgu.js';
+import { g as globalApis } from './constants.DnKduX2e.js';
+import { V as VitestIndex } from './index.DNgLEKsQ.js';
+import './vi.pkoYCV6A.js';
 import '@vitest/expect';
 import '@vitest/runner';
 import '@vitest/runner/utils';
 import 'chai';
-import './utils.CgTj3MsC.js';
+import './utils.BlI4TC7Y.js';
 import '@vitest/utils';
 import './_commonjsHelpers.BFTU3MAI.js';
 import '@vitest/snapshot';
 import '@vitest/utils/error';
 import '@vitest/spy';
 import '@vitest/utils/source-map';
-import './date.CDOsz-HY.js';
-import './run-once.Dimr7O9f.js';
-import './benchmark.BoF7jW0Q.js';
+import './date.ByMsSlOr.js';
+import './benchmark.Cf_PACH1.js';
 import 'expect-type';
 
 function registerApiGlobally() {
 	globalApis.forEach((api) => {
+		// @ts-expect-error I know what I am doing :P
 		globalThis[api] = VitestIndex[api];
 	});
 }

package/dist/chunks/{index.DFXFpH3w.js → index.2jgTs_Q5.js}

@@ -1,5 +1,6 @@
 import { Console } from 'node:console';
 
+// SEE https://github.com/jsdom/jsdom/blob/master/lib/jsdom/living/interfaces.js
 const LIVING_KEYS = [
 	"DOMException",
 	"URL",
@@ -291,6 +292,7 @@ function populateGlobal(global, win, options = {}) {
 	if (global.global) {
 		global.global = global;
 	}
+	// rewrite defaultView to reference the same global context
 	if (global.document && global.document.defaultView) {
 		Object.defineProperty(global.document, "defaultView", {
 			get: () => global,
@@ -320,7 +322,9 @@ var edge = {
 			getVmContext() {
 				return vm.context;
 			},
-			teardown() {}
+			teardown() {
+				// nothing to teardown
+			}
 		};
 	},
 	async setup(global) {
@@ -365,7 +369,9 @@ var happy = {
 				disableErrorCapturing: true
 			}
 		});
+		// TODO: browser doesn't expose Buffer, but a lot of dependencies use it
 		win.Buffer = Buffer;
+		// inject structuredClone if it exists
 		if (typeof structuredClone !== "undefined" && !win.structuredClone) {
 			win.structuredClone = structuredClone;
 		}
@@ -380,6 +386,8 @@ var happy = {
 		};
 	},
 	async setup(global, { happyDOM = {} }) {
+		// happy-dom v3 introduced a breaking change to Window, but
+		// provides GlobalWindow as a way to use previous behaviour
 		const { Window, GlobalWindow } = await import('happy-dom');
 		const win = new (GlobalWindow || Window)({
 			...happyDOM,
@@ -452,8 +460,11 @@ var jsdom = {
 			...restOptions
 		});
 		const clearWindowErrors = catchWindowErrors(dom.window);
+		// TODO: browser doesn't expose Buffer, but a lot of dependencies use it
 		dom.window.Buffer = Buffer;
 		dom.window.jsdom = dom;
+		// inject web globals if they missing in JSDOM but otherwise available in Nodejs
+		// https://nodejs.org/dist/latest/docs/api/globals.html
 		const globalNames = [
 			"structuredClone",
 			"fetch",
@@ -510,6 +521,7 @@ var jsdom = {
 	}
 };
 
+// some globals we do not want, either because deprecated or we set it ourselves
 const denyList = new Set([
 	"GLOBAL",
 	"root",
@@ -540,7 +552,9 @@ var node = {
 						configurable: true,
 						enumerable: descriptor.enumerable,
 						get() {
+							// @ts-expect-error: no index signature
 							const val = globalThis[nodeGlobalsKey];
+							// override lazy getter
 							Object.defineProperty(global, nodeGlobalsKey, {
 								configurable: true,
 								enumerable: descriptor.enumerable,
@@ -550,6 +564,7 @@ var node = {
 							return val;
 						},
 						set(val) {
+							// override lazy getter
 							Object.defineProperty(global, nodeGlobalsKey, {
 								configurable: true,
 								enumerable: descriptor.enumerable,
@@ -578,6 +593,9 @@ var node = {
 		global.global = global;
 		global.Buffer = Buffer;
 		global.ArrayBuffer = ArrayBuffer;
+		// TextEncoder (global or via 'util') references a Uint8Array constructor
+		// different than the global one used by users in tests. This makes sure the
+		// same constructor is referenced by both.
 		global.Uint8Array = Uint8Array;
 		return {
 			getVmContext() {