Socket
Socket
Sign inDemoInstall

vite-node

Package Overview
Dependencies
Maintainers
1
Versions
250
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

vite-node

Vite as Node runtime


Version published
Weekly downloads
6.1M
increased by4.17%
Maintainers
1
Weekly downloads
 
Created

Package description

What is vite-node?

The vite-node package is a tool that allows you to run Node.js scripts with Vite's native ES modules support, providing features such as hot module replacement (HMR) and TypeScript support out of the box. It is designed to work with Vite's ecosystem and can be used for tasks like server-side rendering (SSR) and testing.

What are vite-node's main functionalities?

Running Node.js scripts with ES modules

This feature allows you to run Node.js scripts that use ES module syntax, leveraging Vite's module resolution and transformation capabilities.

import { createServer } from 'vite-node/server';

const server = createServer({
  // Vite's options here
});

server.moduleGraph.ensureEntryFromUrl('/path/to/your/module.js');

Hot Module Replacement (HMR)

vite-node supports HMR, enabling developers to have a more interactive development experience by automatically reloading modules when changes are detected.

import { createServer } from 'vite-node/server';

const server = createServer({
  // Vite's options here
});

server.watcher.on('change', (file) => {
  server.moduleGraph.invalidateModule(file);
});

TypeScript support

With vite-node, you can run TypeScript files directly without pre-compilation, as it integrates with Vite's built-in TypeScript support.

import { createServer } from 'vite-node/server';

const server = createServer({
  // Vite's options here
});

server.moduleGraph.ensureEntryFromUrl('/path/to/your/typescript-module.ts');

Other packages similar to vite-node

Readme

Source

vite-node

NPM version

Vite as Node runtime.

EXPERIMENTAL

Usage

npx vite-node index.ts

Options:

npx vite-node -h

Features

  • Out-of-box ESM & TypeScript support (possible for more with plugins)
  • Top-level await
  • Vite plugins, resolve, aliasing
  • Respect vite.config.ts
  • Shims for __dirname and __filename in ESM
  • Access to native node modules like fs, path, etc.
  • Watch mode (like nodemon)

When NOT to Use

  • Production, yet - in very early stage, check it later
  • Most of the time, when other tools can do that job
    • We need to start a Vite server upon each execution, which inevitably introduces some overhead. Only use it when you want the same behavior as Vite or the powerful plugins system (for example, testing components with a Vite-specific setup).

Why?

It runs Vite's id resolving, module transforming, and most importantly, the powerful plugins system!

How?

It fires up a Vite dev server, transforms the requests, and runs them in Node.

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

Keywords

FAQs

Package last updated on 03 Dec 2021

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc