# virtual-assets-webpack-plugin

> A webpack plugin for dynamical generation assets content!

Latest version **0.0.3** (published 2022-03-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install virtual-assets-webpack-plugin
pnpm add virtual-assets-webpack-plugin
yarn add virtual-assets-webpack-plugin
bun add virtual-assets-webpack-plugin
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2022-03-21 |
| First published | 2022-03-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 36.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | edonet@163.com |
| Maintainers | edonet |
| Keywords | webpack, webpack-plugin, virtual, assets, dynamical |

## Links

- npm: https://www.npmjs.com/package/virtual-assets-webpack-plugin
- Repository: git@github.com:edonet/virtual-assets-webpack-plugin
- npm.io page: https://npm.io/package/virtual-assets-webpack-plugin

## Alternatives

- [raw-loader](https://npm.io/package/raw-loader.md) — 4.3M weekly downloads
- [plop](https://npm.io/package/plop.md) — 1.4M weekly downloads
- [webpack-deadcode-plugin](https://npm.io/package/webpack-deadcode-plugin.md) — 80.3K weekly downloads
- [@storybook/preact-vite](https://npm.io/package/@storybook/preact-vite.md) — 54.2K weekly downloads
- [vite-plugin-transform](https://npm.io/package/vite-plugin-transform.md) — 2.4K weekly downloads

## Recent versions

- 0.0.3 (latest) — 2022-03-21
- 0.0.2 — 2022-03-20
- 0.0.1 — 2022-03-17

## README

# virtual-assets-webpack-plugin
A webpack plugin for dynamical generation assets content!

## Install
``` shell
yarn add virtual-assets-webpack-plugin
```

## Usage
Add plugin in `webpack.config.js`:
``` typescript
import { VirtualAssetsWebpackPlugin } from 'virtual-assets-webpack-plugin';

export default {
    // ...
    plugins: [
        new VirtualAssetsWebpackPlugin({
            './fixtures/data.json': () => fs.promises.readFile('/data.json'),
            './fixtures/index.css': () => fs.promises.readFile('/style.css'),
            'virtual1': { name: 'virtual-1' },
            'virtual2': { name: 'virtual-2' },
        }),
    ],
};
```
Usage in code `./fixtures/index.js`:
``` typescript
import virtual1 from 'virtual1';
import virtual2 from '../node_modules/virtual2';
import data from './data';
import style from './index.css';

// ...
console.log(data, style, virtual1, virtual2);
```

## API
Usage [`loaderContext`](https://webpack.js.org/api/loaders/#the-loader-context):
``` typescript
import { LoaderContext } from 'webpack';
import { Assets, VirtualAssetsWebpackPlugin } from 'virtual-assets-webpack-plugin';

// icons loader
function icons(loaderContext: LoaderContext<Assets>): Promise<string[]> {

    // add dependency
    loaderContext.addContextDependency('/path/to/dir');
    loaderContext.addDependency('/path/to/file');

    // emit file
    loaderContext.emitFile('custom-asset', 'asset content as Buffer|string');

    // return content
    return fs.promises.readdir('./icons');
}

// webpack configuration
export default {
    // ...
    plugins: [
        new VirtualAssetsWebpackPlugin({ icons }),
    ],
};
```

---
_Source: https://npm.io/package/virtual-assets-webpack-plugin · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
