murongg / unplugin-preset-vue

Integrate useful preset for unplugin vue

unplugin-preset-vue

This is a preset library for Vue's unplugin, which integrates commonly used unplugin libraries such as unplugin-vue, unplugin-auto-import, unplugin-vue-components, etc. You can flexibly enable a specific plugin based on your needs and maintain compatibility with the original configuration of the plugin.

Inspire by: unocss-preset-useful

Install

npm i unplugin-preset-vue

Vite

// vite.config.ts
import VuePresets from 'unplugin-preset-vue/vite'

export default defineConfig({
  plugins: [
    VuePresets({ /* options */ }),
  ],
})

Example: playground/

Rollup

// rollup.config.js
import VuePresets from 'unplugin-preset-vue/rollup'

export default {
  plugins: [
    VuePresets({ /* options */ }),
  ],
}

Webpack

// webpack.config.js
module.exports = {
  /* ... */
  plugins: [
    require('unplugin-preset-vue/webpack')({ /* options */ })
  ]
}

Nuxt

// nuxt.config.js
export default defineNuxtConfig({
  modules: [
    ['unplugin-preset-vue/nuxt', { /* options */ }],
  ],
})

This module works for both Nuxt 2 and Nuxt Vite

Vue CLI

// vue.config.js
module.exports = {
  configureWebpack: {
    plugins: [
      require('unplugin-preset-vue/webpack')({ /* options */ }),
    ],
  },
}

esbuild

// esbuild.config.js
import { build } from 'esbuild'
import VuePresets from 'unplugin-preset-vue/esbuild'

build({
  plugins: [VuePresets()],
})

Usage

Vue

The documents: unplugin-vue

Auto Import

Default options:

const DEFAULT_OPTIONS = {
  imports: ['vue'],
  dts: 'src/auto-imports.d.ts',
  vueTemplate: true,
}

The documents: unplugin-auto-import

Vue Components

Default options:

const DEFAULT_OPTIONS = {
  // allow auto load markdown components under `./src/components/`
  extensions: ['vue', 'md'],
  // allow auto import and register components used in markdown
  include: [/\.vue$/, /\.vue\?vue/, /\.md$/],
  dts: 'src/components.d.ts',
}

The documents: unplugin-vue-components

Icons

The documents: unplugin-icons