Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vtrbo/starter-unplugin
💿 Template For Unplugin.
https://github.com/vtrbo/starter-unplugin
starter unplugin
Last synced: 20 days ago
JSON representation
💿 Template For Unplugin.
- Host: GitHub
- URL: https://github.com/vtrbo/starter-unplugin
- Owner: vtrbo
- License: mit
- Created: 2022-08-05T03:06:05.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-07-29T01:39:57.000Z (over 1 year ago)
- Last Synced: 2024-11-04T00:23:34.814Z (2 months ago)
- Topics: starter, unplugin
- Language: TypeScript
- Homepage:
- Size: 396 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# ---plugin-name---
[](https://www.npmjs.com/package/---plugin-name---)
---plugin-name--- for [unplugin](https://github.com/unjs/unplugin).
Forked from [antfu/unplugin-starter](https://github.com/antfu/unplugin-starter)
## Template Usage
> example use [@vtrbo/cli](https://github.com/vtrbo/cli)
>
> example use [@vtrbo/ni](https://github.com/vtrbo/ni)
Clone this template
```bash
vtr
# select Unplugin
# or
# vtr vtrbo/starter-unplugin my-plugin
```
Globally replace `---plugin-name---` with your plugin name.
Globally replace `---PluginName---` with your plugin name (big camel case).
Then you can start developing your plugin.
To test your plugin, run `nr dev`.
To release your plugin, run `nr release`.
## Install
```bash
npm i ---plugin-name---
```
Vite
```js
// vite.config.js
import ---PluginName--- from '---plugin-name---/vite'
export default defineConfig({
plugins: [---PluginName---({ /* options */ })],
})
```
Rollup
```js
// rollup.config.js
import ---PluginName--- from '---plugin-name---/rollup'
export default {
plugins: [---PluginName---({ /* options */ })],
}
```
Webpack
```js
// webpack.config.js
module.exports = {
/* ... */
plugins: [
require('---plugin-name---/webpack')({ /* options */ })
]
}
```
Nuxt
```js
// nuxt.config.js
export default {
buildModules: [
['---plugin-name---/nuxt', { /* options */ }],
],
}
```
> This module works for both Nuxt 2 and [Nuxt Vite](https://github.com/nuxt/vite)
Vue CLI
```js
// vue.config.js
module.exports = {
configureWebpack: {
plugins: [
require('---plugin-name---/webpack')({ /* options */ }),
],
},
}
```
Esbuild
```js
// esbuild.config.js
import { build } from 'esbuild'
import ---PluginName--- from '---plugin-name---/esbuild'
build({
plugins: [---PluginName---({ /* options */ })],
})
```
## License
[MIT](./LICENSE) License © 2022 [Victor Bo](https://github.com/vtrbo)