vite-node 4.0.0-beta.9 → 5.0.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021-Present VoidZero Inc. and Vitest contributors
+Copyright (c) 2021-PRESENT Anthony Fu <https://github.com/antfu>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,17 +1,21 @@
 <p align="center">
-<img src="https://github.com/vitest-dev/vitest/blob/main/packages/vite-node/assets/vite-node.svg?raw=true" height="120">
+<img src="https://github.com/antfu/vite-node/blob/main/assets/vite-node.svg?raw=true" height="120">
 </p>
 
 <h1 align="center">
 vite-node
 </h1>
 <p align="center">
-Vite as Node runtime.<br>The engine that powers <a href="https://github.com/vitest-dev/vitest">Vitest</a> and <a href="https://github.com/nuxt/nuxt">Nuxt 3 Dev SSR</a>.
+Vite as Node runtime.<br>The engine that powers <a href="https://github.com/nuxt/nuxt">Nuxt 3 Dev SSR</a> and <i><a href="https://github.com/vitest-dev/vitest/pull/8208">used to</a></i> power <a href="https://github.com/vitest-dev/vitest">Vitest</a>.
+
 <p>
 <p align="center">
-  <a href="https://www.npmjs.com/package/vitest"><img src="https://img.shields.io/npm/v/vite-node?color=FCC72B&label="></a>
+  <a href="https://www.npmjs.com/package/vite-node"><img src="https://img.shields.io/npm/v/vite-node?color=FCC72B&label="></a>
 <p>
 
+> [!NOTE]
+> This project is firstly inspired by [Nuxt 3's SSR](https://antfu.me/posts/dev-ssr-on-nuxt) implementation made by [@pi0](https://github.com/pi0), as a PoC. Later, it made [Vitest](https://github.com/vitest-dev/vitest) possible by providing the same pipeline as in Vite. It served the ecosystem well for a few years and later became a more generalized built-in solution as [Vite Environment Module Runner](https://vite.dev/guide/api-environment.html). Vitest has [migrated to the new official solution](https://github.com/vitest-dev/vitest/pull/8208), which means `vite-node` has finished its mission. We will still keep it around for the ecosystem that built around it, but for new projects, please consider using the builtin Vite one instead.
+
 ## Features
 
 - On-demand evaluation
@@ -40,7 +44,7 @@ npx vite-node -h
 
 ### Options via CLI
 
-[All `ViteNodeServer` options](https://github.com/vitest-dev/vitest/blob/main/packages/vite-node/src/types.ts#L92-L111) are supported by the CLI. They may be defined through the dot syntax, as shown below:
+[All `ViteNodeServer` options](https://github.com/antfu-collective/vite-node/blob/main/src/types.ts#L92-L111) are supported by the CLI. They may be defined through the dot syntax, as shown below:
 
 ```bash
 npx vite-node --options.deps.inline="module-name" --options.deps.external="/module-regexp/" index.ts

package/dist/{chunk-hmr.mjs → chunk-hmr.js}

@@ -1,11 +1,11 @@
 import { EventEmitter } from 'node:events';
+import process from 'node:process';
 import createDebug from 'debug';
-import { s } from './chunk-browser.mjs';
-import { normalizeRequestId } from './utils.mjs';
+import { C } from './chunk-index.js';
+import { normalizeRequestId } from './utils.js';
 
 function createHmrEmitter() {
-	const emitter = new EventEmitter();
-	return emitter;
+	return new EventEmitter();
 }
 function viteNodeHmrPlugin() {
 	const emitter = createHmrEmitter();
@@ -13,24 +13,31 @@ function viteNodeHmrPlugin() {
 		name: "vite-node:hmr",
 		config() {
 			// chokidar fsevents is unstable on macos when emitting "ready" event
-			if (process.platform === "darwin" && false);
+			if (process.platform === "darwin" && process.env.VITE_TEST_WATCHER_DEBUG) return { server: { watch: {
+				useFsEvents: false,
+				usePolling: false
+			} } };
 		},
 		configureServer(server) {
 			const _send = server.ws.send;
-			server.emitter = emitter, server.ws.send = function(payload) {
-				_send(payload), emitter.emit("message", payload);
+			server.emitter = emitter;
+			server.ws.send = function(payload) {
+				_send(payload);
+				emitter.emit("message", payload);
 			};
 			// eslint-disable-next-line ts/ban-ts-comment
 			// @ts-ignore Vite 6 compat
 			const environments = server.environments;
 			if (environments) environments.ssr.hot.send = function(payload) {
-				_send(payload), emitter.emit("message", payload);
+				_send(payload);
+				emitter.emit("message", payload);
 			};
 		}
 	};
 }
 
-const debugHmr = createDebug("vite-node:hmr"), cache = /* @__PURE__ */ new WeakMap();
+const debugHmr = createDebug("vite-node:hmr");
+const cache = /* @__PURE__ */ new WeakMap();
 function getCache(runner) {
 	if (!cache.has(runner)) cache.set(runner, {
 		hotModulesMap: /* @__PURE__ */ new Map(),
@@ -48,28 +55,37 @@ function getCache(runner) {
 }
 function sendMessageBuffer(runner, emitter) {
 	const maps = getCache(runner);
-	maps.messageBuffer.forEach((msg) => emitter.emit("custom", msg)), maps.messageBuffer.length = 0;
+	maps.messageBuffer.forEach((msg) => emitter.emit("custom", msg));
+	maps.messageBuffer.length = 0;
 }
 async function reload(runner, files) {
-	return Array.from(runner.moduleCache.keys()).forEach((fsPath) => {
+	// invalidate module cache but not node_modules
+	Array.from(runner.moduleCache.keys()).forEach((fsPath) => {
 		if (!fsPath.includes("node_modules")) runner.moduleCache.delete(fsPath);
-	}), Promise.all(files.map((file) => runner.executeId(file)));
+	});
+	return Promise.all(files.map((file) => runner.executeId(file)));
 }
 async function notifyListeners(runner, event, data) {
-	const maps = getCache(runner), cbs = maps.customListenersMap.get(event);
+	const cbs = getCache(runner).customListenersMap.get(event);
 	if (cbs) await Promise.all(cbs.map((cb) => cb(data)));
 }
 async function queueUpdate(runner, p) {
 	const maps = getCache(runner);
-	if (maps.queued.push(p), !maps.pending) {
-		maps.pending = true, await Promise.resolve(), maps.pending = false;
+	maps.queued.push(p);
+	if (!maps.pending) {
+		maps.pending = true;
+		await Promise.resolve();
+		maps.pending = false;
 		const loading = [...maps.queued];
-		maps.queued = [], (await Promise.all(loading)).forEach((fn) => fn && fn());
+		maps.queued = [];
+		(await Promise.all(loading)).forEach((fn) => fn && fn());
 	}
 }
 async function fetchUpdate(runner, { path, acceptedPath }) {
-	path = normalizeRequestId(path), acceptedPath = normalizeRequestId(acceptedPath);
-	const maps = getCache(runner), mod = maps.hotModulesMap.get(path);
+	path = normalizeRequestId(path);
+	acceptedPath = normalizeRequestId(acceptedPath);
+	const maps = getCache(runner);
+	const mod = maps.hotModulesMap.get(path);
 	if (!mod)
  // In a code-splitting project,
 	// it is common that the hot-updating module is not loaded yet.
@@ -91,7 +107,7 @@ async function fetchUpdate(runner, { path, acceptedPath }) {
 	return () => {
 		for (const { deps, fn } of qualifiedCallbacks) fn(deps.map((dep) => dep === acceptedPath ? fetchedModule : void 0));
 		const loggedPath = isSelfUpdate ? path : `${acceptedPath} via ${path}`;
-		console.log(`${s.cyan("[vite-node]")} hot updated: ${loggedPath}`);
+		console.log(`${C.cyan("[vite-node]")} hot updated: ${loggedPath}`);
 	};
 }
 function warnFailedFetch(err, path) {
@@ -105,18 +121,26 @@ async function handleMessage(runner, emitter, files, payload) {
 			sendMessageBuffer(runner, emitter);
 			break;
 		case "update":
-			await notifyListeners(runner, "vite:beforeUpdate", payload), await Promise.all(payload.updates.map((update) => {
-				return update.type === "js-update" ? queueUpdate(runner, fetchUpdate(runner, update)) : (console.error(`${s.cyan("[vite-node]")} no support css hmr.}`), null);
-			})), await notifyListeners(runner, "vite:afterUpdate", payload);
+			await notifyListeners(runner, "vite:beforeUpdate", payload);
+			await Promise.all(payload.updates.map((update) => {
+				if (update.type === "js-update") return queueUpdate(runner, fetchUpdate(runner, update));
+				// css-update
+				console.error(`${C.cyan("[vite-node]")} no support css hmr.}`);
+				return null;
+			}));
+			await notifyListeners(runner, "vite:afterUpdate", payload);
 			break;
 		case "full-reload":
-			await notifyListeners(runner, "vite:beforeFullReload", payload), maps.customListenersMap.delete("vite:beforeFullReload"), await reload(runner, files);
+			await notifyListeners(runner, "vite:beforeFullReload", payload);
+			maps.customListenersMap.delete("vite:beforeFullReload");
+			await reload(runner, files);
 			break;
 		case "custom":
 			await notifyListeners(runner, payload.event, payload.data);
 			break;
 		case "prune":
-			await notifyListeners(runner, "vite:beforePrune", payload), payload.paths.forEach((path) => {
+			await notifyListeners(runner, "vite:beforePrune", payload);
+			payload.paths.forEach((path) => {
 				const fn = maps.pruneMap.get(path);
 				if (fn) fn(maps.dataMap.get(path));
 			});
@@ -124,7 +148,7 @@ async function handleMessage(runner, emitter, files, payload) {
 		case "error": {
 			await notifyListeners(runner, "vite:error", payload);
 			const err = payload.err;
-			console.error(`${s.cyan("[vite-node]")} Internal Server Error\n${err.message}\n${err.stack}`);
+			console.error(`${C.cyan("[vite-node]")} Internal Server Error\n${err.message}\n${err.stack}`);
 			break;
 		}
 	}
@@ -147,9 +171,10 @@ function createHotContext(runner, emitter, files, ownerPath) {
 		mod.callbacks.push({
 			deps,
 			fn: callback
-		}), maps.hotModulesMap.set(ownerPath, mod);
+		});
+		maps.hotModulesMap.set(ownerPath, mod);
 	}
-	const hot = {
+	return {
 		get data() {
 			return maps.dataMap.get(ownerPath);
 		},
@@ -173,18 +198,21 @@ function createHotContext(runner, emitter, files, ownerPath) {
 			maps.pruneMap.set(ownerPath, cb);
 		},
 		invalidate() {
-			return notifyListeners(runner, "vite:invalidate", {
+			notifyListeners(runner, "vite:invalidate", {
 				path: ownerPath,
 				message: void 0,
 				firstInvalidatedBy: ownerPath
-			}), reload(runner, files);
+			});
+			return reload(runner, files);
 		},
 		on(event, cb) {
 			const addToMap = (map) => {
 				const existing = map.get(event) || [];
-				existing.push(cb), map.set(event, existing);
+				existing.push(cb);
+				map.set(event, existing);
 			};
-			addToMap(maps.customListenersMap), addToMap(newListeners);
+			addToMap(maps.customListenersMap);
+			addToMap(newListeners);
 		},
 		off(event, cb) {
 			const removeFromMap = (map) => {
@@ -197,17 +225,18 @@ function createHotContext(runner, emitter, files, ownerPath) {
 				}
 				map.set(event, pruned);
 			};
-			removeFromMap(maps.customListenersMap), removeFromMap(newListeners);
+			removeFromMap(maps.customListenersMap);
+			removeFromMap(newListeners);
 		},
 		send(event, data) {
 			maps.messageBuffer.push(JSON.stringify({
 				type: "custom",
 				event,
 				data
-			})), sendMessageBuffer(runner, emitter);
+			}));
+			sendMessageBuffer(runner, emitter);
 		}
 	};
-	return hot;
 }
 
 export { createHotContext as a, createHmrEmitter as c, getCache as g, handleMessage as h, reload as r, sendMessageBuffer as s, viteNodeHmrPlugin as v };

package/dist/{chunk-browser.mjs → chunk-index.js}

@@ -1,5 +1,5 @@
 // src/index.ts
-var f = {
+var d = {
   reset: [0, 0],
   bold: [1, 22, "\x1B[22m\x1B[1m"],
   dim: [2, 22, "\x1B[22m\x1B[2m"],
@@ -41,41 +41,42 @@ var f = {
   bgMagentaBright: [105, 49],
   bgCyanBright: [106, 49],
   bgWhiteBright: [107, 49]
-}, h = Object.entries(f);
-function a(n) {
-  return String(n);
+};
+function g(e) {
+  return String(e);
 }
-a.open = "";
-a.close = "";
-function C(n = false) {
-  let e = typeof process != "undefined" ? process : void 0, i = (e == null ? void 0 : e.env) || {}, g = (e == null ? void 0 : e.argv) || [];
-  return !("NO_COLOR" in i || g.includes("--no-color")) && ("FORCE_COLOR" in i || g.includes("--color") || (e == null ? void 0 : e.platform) === "win32" || n && i.TERM !== "dumb" || "CI" in i) || typeof window != "undefined" && !!window.chrome;
+g.open = "";
+g.close = "";
+function h() {
+  let e = typeof process != "undefined" ? process : void 0, n = (e == null ? void 0 : e.env) || {}, a = n.FORCE_TTY !== "false", i = (e == null ? void 0 : e.argv) || [];
+  return !("NO_COLOR" in n || i.includes("--no-color")) && ("FORCE_COLOR" in n || i.includes("--color") || (e == null ? void 0 : e.platform) === "win32" || a && n.TERM !== "dumb" || "CI" in n) || typeof window != "undefined" && !!window.chrome;
 }
-function p(n = false) {
-  let e = C(n), i = (r, t, c, o) => {
+function f() {
+  let e = h(), n = (r, t, u, o) => {
     let l = "", s = 0;
     do
-      l += r.substring(s, o) + c, s = o + t.length, o = r.indexOf(t, s);
+      l += r.substring(s, o) + u, s = o + t.length, o = r.indexOf(t, s);
     while (~o);
     return l + r.substring(s);
-  }, g = (r, t, c = r) => {
+  }, a = (r, t, u = r) => {
     let o = (l) => {
       let s = String(l), b = s.indexOf(t, r.length);
-      return ~b ? r + i(s, t, c, b) + t : r + s + t;
+      return ~b ? r + n(s, t, u, b) + t : r + s + t;
     };
     return o.open = r, o.close = t, o;
-  }, u = {
+  }, i = {
     isColorSupported: e
-  }, d = (r) => `\x1B[${r}m`;
-  for (let [r, t] of h)
-    u[r] = e ? g(
-      d(t[0]),
-      d(t[1]),
+  }, c = (r) => `\x1B[${r}m`;
+  for (let r in d) {
+    let t = d[r];
+    i[r] = e ? a(
+      c(t[0]),
+      c(t[1]),
       t[2]
-    ) : a;
-  return u;
+    ) : g;
+  }
+  return i;
 }
+var C = f();
 
-var s = p();
-
-export { s };
+export { C };

package/dist/cli.d.ts

@@ -1,4 +1,4 @@
-import { V as ViteNodeServerOptions } from './index.d-CvIJUDRh.js';
+import { V as ViteNodeServerOptions } from './index.d-D6Pqey3g.js';
 import './trace-mapping.d-BWFx6tPc.js';
 
 interface CliOptions {

package/dist/{cli.mjs → cli.js}

@@ -1,30 +1,37 @@
 import { resolve } from 'node:path';
+import process from 'node:process';
 import cac from 'cac';
-import { s } from './chunk-browser.mjs';
+import { C } from './chunk-index.js';
 import { createServer, version as version$1, loadEnv } from 'vite';
-import { ViteNodeRunner } from './client.mjs';
-import { ViteNodeServer } from './server.mjs';
-import { installSourcemapsSupport } from './source-map.mjs';
-import { toArray } from './utils.mjs';
-import { v as viteNodeHmrPlugin, a as createHotContext, h as handleMessage } from './chunk-hmr.mjs';
+import { ViteNodeRunner } from './client.js';
+import { ViteNodeServer } from './server.js';
+import { installSourcemapsSupport } from './source-map.js';
+import { toArray } from './utils.js';
+import { v as viteNodeHmrPlugin, a as createHotContext, h as handleMessage } from './chunk-hmr.js';
 import 'node:module';
 import 'node:url';
 import 'node:vm';
 import 'debug';
+import 'node:buffer';
 import 'pathe';
 import 'node:fs';
 import 'node:assert';
 import 'node:perf_hooks';
 import 'es-module-lexer';
-import './constants.mjs';
+import './constants.js';
 import 'node:events';
 
-var version = "4.0.0-beta.9";
+var version = "5.0.0";
 
 const cli = cac("vite-node");
-if (cli.option("-r, --root <path>", "Use specified root directory").option("-c, --config <path>", "Use specified config file").option("-m, --mode <mode>", "Set env mode").option("-w, --watch", "Restart on file changes, similar to \"nodemon\"").option("--script", "Use vite-node as a script runner").option("--options <options>", "Use specified Vite server options").option("-v, --version", "Output the version number").option("-h, --help", "Display help for command"), cli.command("[...files]").allowUnknownOptions().action(run), cli.parse(process.argv, { run: false }), cli.args.length === 0) cli.runMatchedCommand();
+cli.option("-r, --root <path>", "Use specified root directory").option("-c, --config <path>", "Use specified config file").option("-m, --mode <mode>", "Set env mode").option("-w, --watch", "Restart on file changes, similar to \"nodemon\"").option("--script", "Use vite-node as a script runner").option("--options <options>", "Use specified Vite server options").option("-v, --version", "Output the version number").option("-h, --help", "Display help for command");
+cli.command("[...files]").allowUnknownOptions().action(run);
+cli.parse(process.argv, { run: false });
+if (cli.args.length === 0) cli.runMatchedCommand();
 else {
-	const i = cli.rawArgs.indexOf(cli.args[0]) + 1, scriptArgs = cli.rawArgs.slice(i).filter((it) => it !== "--"), executeArgs = [
+	const i = cli.rawArgs.indexOf(cli.args[0]) + 1;
+	const scriptArgs = cli.rawArgs.slice(i).filter((it) => it !== "--");
+	const executeArgs = [
 		...cli.rawArgs.slice(0, i),
 		"--",
 		...scriptArgs
@@ -33,16 +40,31 @@ else {
 }
 async function run(files, options = {}) {
 	var _server$emitter;
-	if (options.script) files = [files[0]], options = {}, process.argv = [
-		process.argv[0],
-		resolve(files[0]),
-		...process.argv.slice(2).filter((arg) => arg !== "--script" && arg !== files[0])
-	];
-	else process.argv = [...process.argv.slice(0, 2), ...options["--"] || []];
-	if (options.version) cli.version(version), cli.outputVersion(), process.exit(0);
-	if (options.help) cli.version(version).outputHelp(), process.exit(0);
-	if (!files.length) console.error(s.red("No files specified.")), cli.version(version).outputHelp(), process.exit(1);
-	const serverOptions = options.options ? parseServerOptions(options.options) : {}, server = await createServer({
+	if (options.script) {
+		files = [files[0]];
+		options = {};
+		process.argv = [
+			process.argv[0],
+			resolve(files[0]),
+			...process.argv.slice(2).filter((arg) => arg !== "--script" && arg !== files[0])
+		];
+	} else process.argv = [...process.argv.slice(0, 2), ...options["--"] || []];
+	if (options.version) {
+		cli.version(version);
+		cli.outputVersion();
+		process.exit(0);
+	}
+	if (options.help) {
+		cli.version(version).outputHelp();
+		process.exit(0);
+	}
+	if (!files.length) {
+		console.error(C.red("No files specified."));
+		cli.version(version).outputHelp();
+		process.exit(1);
+	}
+	const serverOptions = options.options ? parseServerOptions(options.options) : {};
+	const server = await createServer({
 		logLevel: "error",
 		configFile: options.config,
 		root: options.root,
@@ -81,11 +103,33 @@ async function run(files, options = {}) {
 	await runner.executeId("/@vite/env");
 	for (const file of files) await runner.executeFile(file);
 	if (!options.watch) await server.close();
-	if ((_server$emitter = server.emitter) === null || _server$emitter === void 0 || _server$emitter.on("message", (payload) => {
+	(_server$emitter = server.emitter) === null || _server$emitter === void 0 || _server$emitter.on("message", (payload) => {
 		handleMessage(runner, server.emitter, files, payload);
-	}), options.watch) process.on("uncaughtException", (err) => {
-		console.error(s.red("[vite-node] Failed to execute file: \n"), err);
 	});
+	if (options.watch) {
+		process.on("uncaughtException", (err) => {
+			console.error(C.red("[vite-node] Failed to execute file: \n"), err);
+		});
+		if (process.env.VITE_TEST_WATCHER_DEBUG) {
+			// manually check `watcher.getWatched()` to make sure entry files are ready
+			// since watcher.on('ready', ...) event is not reliable since 5.1.
+			// https://github.com/vitejs/vite/blob/63a39c244b08cf1f2299bc2c3cfddcb82070d05b/playground/hmr-ssr/__tests__/hmr.spec.ts#L1065
+			const nodePath = await import('node:path');
+			async function waitForWatched(files) {
+				while (!files.every((file) => isWatched(file))) await new Promise((resolve) => setTimeout(resolve, 20));
+			}
+			function isWatched(file) {
+				var _watched$dir;
+				const watched = server.watcher.getWatched();
+				const resolved = nodePath.resolve(file);
+				const dir = nodePath.dirname(resolved);
+				const base = nodePath.basename(resolved);
+				return (_watched$dir = watched[dir]) === null || _watched$dir === void 0 ? void 0 : _watched$dir.includes(base);
+			}
+			await waitForWatched(files);
+			console.log("[debug] watcher is ready");
+		}
+	}
 }
 function parseServerOptions(serverOptions) {
 	var _serverOptions$deps, _serverOptions$deps2, _serverOptions$deps3, _serverOptions$deps4, _serverOptions$deps5, _serverOptions$deps6, _serverOptions$transf, _serverOptions$transf2;

package/dist/client.d.ts

@@ -1,2 +1,2 @@
 import './trace-mapping.d-BWFx6tPc.js';
-export { e as DEFAULT_REQUEST_STUBS, M as ModuleCacheMap, f as ModuleExecutionInfo, g as ModuleExecutionInfoEntry, a as ViteNodeRunner } from './index.d-CvIJUDRh.js';
+export { e as DEFAULT_REQUEST_STUBS, M as ModuleCacheMap, f as ModuleExecutionInfo, g as ModuleExecutionInfoEntry, a as ViteNodeRunner } from './index.d-D6Pqey3g.js';