Skip to content

unplugin/unplugin-starter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

3eb6329 Â· Feb 11, 2025

History

45 Commits
Aug 31, 2024
Dec 4, 2023
Feb 11, 2025
Feb 11, 2025
May 19, 2022
Jul 4, 2022
Aug 24, 2021
Aug 24, 2021
Aug 31, 2024
Aug 31, 2024
Feb 11, 2025
Feb 11, 2025
Oct 14, 2022
Dec 4, 2023
Feb 5, 2025

Repository files navigation

unplugin-starter

NPM version

Starter template for unplugin.

Template Usage

To use this template, clone it down using:

npx degit unplugin/unplugin-starter my-unplugin

And do a global replacement of unplugin-starter 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 unplugin-starter
Vite
// vite.config.ts
import Starter from 'unplugin-starter/vite'

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

Example: playground/


Rollup
// rollup.config.js
import Starter from 'unplugin-starter/rollup'

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


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


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

This module works for both Nuxt 2 and Nuxt Vite


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


esbuild
// esbuild.config.js
import { build } from 'esbuild'
import Starter from 'unplugin-starter/esbuild'

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