https://github.com/sxzz/unplugin-starter

Starter template for unplugin.
https://github.com/sxzz/unplugin-starter

Last synced: 2 months ago
JSON representation

Starter template for unplugin.

• Host: GitHub
• URL: https://github.com/sxzz/unplugin-starter
• Owner: sxzz
• License: mit
• Created: 2022-06-20T10:30:08.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-09T09:27:40.000Z (9 months ago)
• Last Synced: 2024-04-13T14:41:10.307Z (9 months ago)
• Language: TypeScript
• Homepage:
• Size: 554 KB
• Stars: 8
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# unplugin-starter [![npm](https://img.shields.io/npm/v/unplugin-starter.svg)](https://npmjs.com/package/unplugin-starter)

[![Unit Test](https://github.com/sxzz/unplugin-starter/actions/workflows/unit-test.yml/badge.svg)](https://github.com/sxzz/unplugin-starter/actions/workflows/unit-test.yml)

Starter template for [unplugin](https://github.com/unjs/unplugin).

## Template Usage

To use this template, clone it down using:

```bash

npx degit sxzz/unplugin-starter unplugin-my-plugin

```

And do a global replacement of `unplugin-starter` with your plugin name.

Then you can start developing your unplugin 🔥

To run unit tests, run: `pnpm run test`.

To release a new version, run: `pnpm run release`.

## Installation

```bash

npm i -D unplugin-starter

```

Vite


```ts

// vite.config.ts

import UnpluginStarter from 'unplugin-starter/vite'

export default defineConfig({

  plugins: [UnpluginStarter()],

})

```




Rollup


```ts

// rollup.config.js

import UnpluginStarter from 'unplugin-starter/rollup'

export default {

  plugins: [UnpluginStarter()],

}

```




Rolldown


```ts

// rolldown.config.js

import UnpluginStarter from 'unplugin-starter/rolldown'

export default {

  plugins: [UnpluginStarter()],

}

```




esbuild


```ts

// esbuild.config.js

import { build } from 'esbuild'

build({

  plugins: [require('unplugin-starter/esbuild')()],

})

```




Webpack


```ts

// webpack.config.js

module.exports = {

  /* ... */

  plugins: [require('unplugin-starter/webpack')()],

}

```




## Sponsors



  

    

  



## License

[MIT](./LICENSE) License © 2024-PRESENT [三咲智子](https://github.com/sxzz)