https://github.com/rspack-contrib/rspack-plugin-virtual-module
An Rspack plugin that allows you to create virtual modules.
https://github.com/rspack-contrib/rspack-plugin-virtual-module
plugins rspack webpack
Last synced: 3 days ago
JSON representation
An Rspack plugin that allows you to create virtual modules.
- Host: GitHub
- URL: https://github.com/rspack-contrib/rspack-plugin-virtual-module
- Owner: rspack-contrib
- License: mit
- Created: 2023-03-27T09:44:54.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-11T16:29:44.000Z (5 days ago)
- Last Synced: 2025-04-14T10:13:41.497Z (3 days ago)
- Topics: plugins, rspack, webpack
- Language: TypeScript
- Homepage:
- Size: 323 KB
- Stars: 42
- Watchers: 3
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-rspack - rspack-plugin-virtual-module
README
# rspack-plugin-virtual-module
An Rspack plugin that allows you to create virtual modules.
## Installation
```bash
# npm
npm install rspack-plugin-virtual-module
# yarn
yarn add rspack-plugin-virtual-module
# pnpm
pnpm add rspack-plugin-virtual-module
```
## Usage
```js
// 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:
```js
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:
```js
// 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](./LICENSE).