An open API service indexing awesome lists of open source software.

https://github.com/rspack-contrib/rsbuild-plugin-unplugin-vue


https://github.com/rspack-contrib/rsbuild-plugin-unplugin-vue

Last synced: 5 months ago
JSON representation

Awesome Lists containing this project

README

          

# rsbuild-plugin-unplugin-vue

Rsbuild plugin that integrates [unplugin-vue](https://github.com/unplugin/unplugin-vue) for Vue SFC compilation. Works seamlessly with both [Rsbuild](https://rsbuild.dev) and [Rslib](https://lib.rslib.dev). This plugin could be used with Rsbuild project as an alternative to [@rsbuild/plugin-vue](https://rsbuild.dev/guide/framework/vue).

> [!CAUTION]
> HMR is not supported with Rsbuild yet. Track the issue [here](https://github.com/unplugin/unplugin-vue/issues/162). This plugin is mainly used for building Vue components with Rslib as of now.

This plugin is recommended for projects using Rslib to build Vue components for the time being.



npm version

license
downloads

## Usage

Install:

```bash
npm add rsbuild-plugin-unplugin-vue -D
```

Add plugin to your `rsbuild.config.ts`:

```ts
// rsbuild.config.ts / rslib.config.ts
import { pluginUnpluginVue } from 'rsbuild-plugin-unplugin-vue'

export default {
plugins: [pluginUnpluginVue()],
}
```

## Options

### unpluginVueOptions

Some description.

- Type: `import('unplugin-vue/api').Options`
- Default: `undefined`
- Example:

```js
pluginUnpluginVue({
unpluginVueOptions: {
include: ['**/*.vue'],
},
})
```

## License

[MIT](./LICENSE).