Vite Plugin for Node.js Standard Library Browser Polyfills

0.2.1 · active · verified Wed Apr 22

vite-plugin-node-stdlib-browser, currently at version 0.2.1, is a Vite plugin designed to integrate `node-stdlib-browser` into Vite projects. Its primary function is to provide browser polyfills for Node.js built-in modules, enabling web applications to run code that implicitly or explicitly relies on these Node.js APIs within a browser environment. The plugin maintains a relatively slow release cadence, typical for a utility plugin that wraps another library, and its current version is still in an early development stage, as indicated by the author's disclaimer regarding limited testing in complex projects. A key differentiator is its explicit design choice to *not* support `node:` protocol imports and to *only* polyfill dependencies, not direct user code. This intentional limitation sets it apart from alternatives like `vite-plugin-node-polyfills`, which does offer `node:` protocol support. Developers should be aware of these architectural decisions when choosing a polyfill solution.

Common errors

```
ReferenceError: Buffer is not defined
```
cause A browser environment attempted to execute code that relies on Node.js global objects or built-in modules (e.g., `Buffer`, `process`, `global`) without proper polyfilling.

fix Ensure `vite-plugin-node-stdlib-browser` is correctly installed as a dev dependency and `node-stdlib-browser` as a regular dependency. Verify the plugin is correctly configured and added to the `plugins` array in your `vite.config.js`.
```
Failed to resolve import "node:fs" from "..."
```
cause The application code or a dependency is attempting to use a `node:` protocol import (e.g., `node:fs`, `node:path`), which is explicitly not supported by `vite-plugin-node-stdlib-browser`.

fix Refactor the code to avoid `node:` protocol imports. If `node:` protocol support is essential for your project, consider using an alternative plugin like `vite-plugin-node-polyfills` which offers this functionality.

Warnings

gotcha This plugin explicitly does NOT support `node:` protocol imports (e.g., `import fs from 'node:fs'`). If your code or dependencies use this syntax, they will not be polyfilled.
Fix: Refactor code to avoid `node:` protocol imports. If `node:` protocol support is critical, consider using an alternative plugin like `vite-plugin-node-polyfills`.
gotcha The plugin is intentionally designed to polyfill Node.js built-in libraries only within your project's *dependencies*, not directly within your user-written application code.
Fix: Ensure your application-level code is browser-compatible and avoids direct reliance on Node.js built-ins unless they are provided by a dependency that the plugin is configured to polyfill.
gotcha The plugin's author notes that it has only been tested in 'simple projects.' This implies potential unforeseen issues or instability when integrated into more complex or edge-case Vite configurations.
Fix: Thoroughly test your application when integrating this plugin, particularly in production builds or complex setups. Report any encountered issues to the project's GitHub repository to contribute to its stability.

Install

npm install vite-plugin-node-stdlib-browser npm
yarn add vite-plugin-node-stdlib-browser yarn
pnpm add vite-plugin-node-stdlib-browser pnpm

Imports

nodePolyfills
wrong:
```
const nodePolyfills = require('vite-plugin-node-stdlib-browser')
```
correct:
```
import nodePolyfills from 'vite-plugin-node-stdlib-browser'
```
The plugin is typically imported as a default export in `vite.config.js`, which is generally an ESM context.
defineConfig
wrong:
```
const { defineConfig } = require('vite')
```
correct:
```
import { defineConfig } from 'vite'
```
Required for defining your Vite configuration, commonly used alongside this plugin.

Quickstart

This quickstart demonstrates how to configure `vite-plugin-node-stdlib-browser` in your `vite.config.js` to enable Node.js standard library polyfills for your Vite project's browser build. It shows the necessary import and plugin registration.

import { defineConfig } from 'vite'
import nodePolyfills from 'vite-plugin-node-stdlib-browser'

export default defineConfig({
  plugins: [
    nodePolyfills()
  ]
})

view raw JSON →