Registry / devops / esbuild-plugin-virtual

esbuild-plugin-virtual

library0.1.0jsnpmunverified

An esbuild plugin for loading virtual modules from memory, inspired by @rollup/plugin-virtual. Version 0.1.0 is designed for esbuild's plugin system, enabling in-memory module resolution during bundling. Releases are stable but infrequent. Key differentiators: simple API (object map of module names to content), works with both Node and Deno, virtual modules are resolved with a 'virtual:' prefix internally. Compared to file-based alternatives, it eliminates filesystem I/O for tests or dynamic content. Currently ships TypeScript definitions, but lacks advanced features like virtual directories or lazy loading.

devops testing web-framework

npm install esbuild-plugin-virtual

package ↗

INSTALL

IMPORT

SIG · ESBUILD-PLUGIN-VIR

esbuild-plugin-virtual

devopsjavascriptv0.1.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

default

✓ import virtual from 'esbuild-plugin-virtual'

✗ const virtual = require('esbuild-plugin-virtual')

Package is ESM-only; default export is the plugin factory function. For CommonJS, use dynamic import or a bundler.

virtual type

✓ import type { VirtualPlugin } from 'esbuild-plugin-virtual'

TypeScript types are included; the default export is a function returning an esbuild Plugin. You can also import the type for parameter definitions.

Plugin as named

✓ import { virtual } from 'esbuild-plugin-virtual'

✗ import { default as virtual } from 'esbuild-plugin-virtual'

The package also exports a named export 'virtual' identical to default. Avoid mixing default and named in same line.

Shows basic usage: creating virtual modules and bundling an entry point that imports them.

import * as esbuild from 'esbuild'; import virtual from 'esbuild-plugin-virtual'; await esbuild.build({ entryPoints: ['src/entry.ts'], bundle: true, outfile: 'out.js', plugins: [ virtual({ 'my-module': `export const msg = 'Hello from virtual!';`, 'another-module': `export default 42;`, }), ], }).then(() => console.log('Built successfully'));

Debug

Known issues

gotchaVirtual module names must not contain the 'virtual:' prefix in the plugin object keys; internal resolution adds it automatically.

fix

Use bare module names (e.g., 'my-module') without 'virtual:' prefix.

affects: >=0.0.0

gotchaVirtual modules are resolved only for the entry points and files in the build graph; they cannot be used as plugins or loaders for other resources.

fix

Use virtual modules for JavaScript/TypeScript content only; for other file types, use different plugins.

affects: >=0.0.0

breakingNo known breaking changes in current version; package is simple and stable.

fix

N/A

affects: >=0.0.0

Errors

Common errors & fixes

Error: Cannot find module 'esbuild-plugin-virtual'

Missing install or wrong import syntax (e.g., using require in ESM-only package).

fix

Ensure package is installed: npm install --save-dev esbuild-plugin-virtual. Use import, not require.

TypeError: virtual is not a function

Importing the default export incorrectly, or using an older Node version without ESM support.

fix

Use 'import virtual from "esbuild-plugin-virtual"' and ensure Node >= 12.20 for ESM.

The plugin "virtual" must be an object with a "name" property

Passing an object directly as a plugin instead of calling the virtual() factory function.

fix

Correct: plugins: [virtual({...})]. Incorrect: plugins: [{...}].

Upgrade

Version history

0.1.0latest on npm

Audit

Dependencies

esbuildoptionalPeer dependency; provides the plugin system and build API.

Agent activity

2 hits · last 30 days

node

Resources

packagehttps://www.npmjs.com/package/esbuild-plugin-virtual ↗