rspack-plugin-virtual-module

An Rspack plugin that allows you to create virtual modules.

[!WARNING] This plugin is no longer maintained as Rspack v1.5 now provides a built-in VirtualModulesPlugin with better performance. Please use the built-in plugin instead of this one.

Installation

# npm
npm install rspack-plugin-virtual-module

# yarn
yarn add rspack-plugin-virtual-module

# pnpm
pnpm add rspack-plugin-virtual-module

Usage

// rspack.config.js
const { RspackVirtualModulePlugin } = require("rspack-plugin-virtual-module");

module.exports = {
  plugins: [
    new RspackVirtualModulePlugin({
      contents: 'export default "Hello World";',
    }),
  ],
};

Then you can import the virtual module in your code:

import hello from "contents";

console.log(hello); // "Hello World"

If you want to dynamically write the contents of the virtual module, you can use the writeModule method:

// rspack.config.js
const { RspackVirtualModulePlugin } = require("rspack-plugin-virtual-module");

const vmp = new RspackVirtualModulePlugin({
  contents: 'export default "Hello World";',
});

// Write the contents of the virtual module after 1 second
setTimeout(() => {
  vmp.writeModule('export default "Hello World 2";');
}, 1000);

module.exports = {
  plugins: [vmp],
};

License

MIT.