Skip to content

Latest commit

 

History

History
128 lines (91 loc) · 1.96 KB

README.md

File metadata and controls

128 lines (91 loc) · 1.96 KB

boot-unplugin

NPM version

Starter template for unplugin.

Template Usage

To use this template, clone it down using:

npx degit kirklin/boot-unplugin my-unplugin

And do a global replace of boot-unplugin with your plugin name.

Then you can start developing your unplugin 🔥

To test your plugin, run: pnpm run dev To release a new version, run: pnpm run release

Install

npm i boot-unplugin
Vite
// vite.config.ts
import Starter from "boot-unplugin/vite";

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

Example: playground/


Rollup
// rollup.config.js
import Starter from "boot-unplugin/rollup";

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


Webpack
// webpack.config.js
module.exports = {
  /* ... */
  plugins: [
    require("boot-unplugin/webpack")({ /* options */ })
  ]
};


Nuxt
// nuxt.config.js
export default {
  buildModules: [
    ["boot-unplugin/nuxt", { /* options */ }],
  ],
};

This module works for both Nuxt 2 and Nuxt Vite


Vue CLI
// vue.config.js
module.exports = {
  configureWebpack: {
    plugins: [
      require("boot-unplugin/webpack")({ /* options */ }),
    ],
  },
};


esbuild
// esbuild.config.js
import { build } from "esbuild";
import Starter from "boot-unplugin/esbuild";

build({
  plugins: [Starter()],
});


License

MIT License © 2022 Kirk Lin