vite-node

Vite as Node runtime.
The engine that powers Vitest and Nuxt 3 Dev SSR.

Features

• On-demand evaluation
• Vite's pipeline, plugins, resolve, aliasing
• Out-of-box ESM & TypeScript support
• Respect vite.config.ts
• Hot module replacement (HMR)
• Separate server/client architecture
• Top-level await
• Shims for __dirname and __filename in ESM
• Access to native node modules like fs, path, etc.

CLI Usage

Run JS/TS file on Node.js using Vite's resolvers and transformers.

1npx vite-node index.ts

Options:

1npx vite-node -h

Options via CLI

All ViteNodeServer options are supported by the CLI. They may be defined through the dot syntax, as shown below:

1npx vite-node --options.deps.inline="module-name" --options.deps.external="/module-regexp/" index.ts

Note that for options supporting RegExps, strings passed to the CLI must start and end with a /;

Hashbang

If you prefer to write scripts that don't need to be passed into Vite Node, you can declare it in the hashbang.

Simply add #!/usr/bin/env vite-node --script at the top of your file:

file.ts

1#!/usr/bin/env vite-node --script
2
3console.log('argv:', process.argv.slice(2))

And make the file executable:

1chmod +x ./file.ts

Now, you can run the file without passing it into Vite Node:

1$ ./file.ts hello
2argv: [ 'hello' ]

Note that when using the --script option, Vite Node forwards every argument and option to the script to execute, even the one supported by Vite Node itself.

Programmatic Usage

In Vite Node, the server and runner (client) are separated, so you can integrate them in different contexts (workers, cross-process, or remote) if needed. The demo below shows a simple example of having both (server and runner) running in the same context

1import { createServer, version as viteVersion } from 'vite'
2import { ViteNodeRunner } from 'vite-node/client'
3import { ViteNodeServer } from 'vite-node/server'
4import { installSourcemapsSupport } from 'vite-node/source-map'
5
6// create vite server
7const server = await createServer({
8  optimizeDeps: {
9    // It's recommended to disable deps optimization
10    disabled: true,
11  },
12})
13// For old Vite, this is need to initialize the plugins.
14if (Number(viteVersion.split('.')[0]) < 6) {
15  await server.pluginContainer.buildStart({})
16}
17
18// create vite-node server
19const node = new ViteNodeServer(server)
20
21// fixes stacktraces in Errors
22installSourcemapsSupport({
23  getSourceMap: source => node.getSourceMap(source),
24})
25
26// create vite-node runner
27const runner = new ViteNodeRunner({
28  root: server.config.root,
29  base: server.config.base,
30  // when having the server and runner in a different context,
31  // you will need to handle the communication between them
32  // and pass to this function
33  fetchModule(id) {
34    return node.fetchModule(id)
35  },
36  resolveId(id, importer) {
37    return node.resolveId(id, importer)
38  },
39})
40
41// execute the file
42await runner.executeFile('./example.ts')
43
44// close the vite server
45await server.close()

Debugging

Debug Transformation

Sometimes you might want to inspect the transformed code to investigate issues. You can set environment variable VITE_NODE_DEBUG_DUMP=true to let vite-node write the transformed result of each module under .vite-node/dump.

If you want to debug by modifying the dumped code, you can change the value of VITE_NODE_DEBUG_DUMP to load and search for the dumped files and use them for executing.

1VITE_NODE_DEBUG_DUMP=load vite-node example.ts

Or programmatically:

1import { ViteNodeServer } from 'vite-node/server'
2
3const server = new ViteNodeServer(viteServer, {
4  debug: {
5    dumpModules: true,
6    loadDumppedModules: true,
7  },
8})

Debug Execution

If the process gets stuck, it might be because there are unresolvable circular dependencies. You can set VITE_NODE_DEBUG_RUNNER=true for vite-node to warn about this.

1VITE_NODE_DEBUG_RUNNER=true vite-node example.ts

Or programmatically:

1import { ViteNodeRunner } from 'vite-node/client'
2
3const runner = new ViteNodeRunner({
4  debug: true,
5})

Credits

Based on @pi0's brilliant idea of having a Vite server as the on-demand transforming service for Nuxt's Vite SSR.

Thanks @brillout for kindly sharing this package name.

Sponsors

License

MIT License © 2021 Anthony Fu