Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/patak-dev/vite-rollup-plugins

A compatibility list of rollup plugins for Vite 2 and test playground
https://github.com/patak-dev/vite-rollup-plugins

rollup-plugin vite

Last synced: 4 days ago
JSON representation

A compatibility list of rollup plugins for Vite 2 and test playground

Awesome Lists containing this project

README

        

# โšก๏ธ Vite Rollup Plugins ๐Ÿฃ

A compatibility list and test playground

https://vite-rollup-plugins.patak.dev

> [!IMPORTANT]
> This resource is archived and won't be updated anymore. Vite represents now more than 55% of the npm downloads of Rollup. To properly scale and keep the compat info always up-to-date it makes more sense for Rollup plugins to document their compatibility status directly in their docs.

โœ… status for each official plugin

โš ๏ธ enforce needed badge

๐Ÿ› ๏ธ install instructions

๐Ÿงช compatible plugins are used in the page

## Run it locally

These instructions will get you a copy of the project up and running on your local machine for development

### Clone the repo

Use ssh

```bash
git clone [email protected]:matias-capeletto/vite-rollup-plugins.git
```

Or https

```bash
git clone https://github.com/matias-capeletto/vite-rollup-plugins.git
```

In the repo folder run

```bash
yarn
yarn dev
```

Your dev server will start and be running at

```bash
> Local: http://localhost:3000/
```

To build

```bash
yarn build
```

## Contributing

This is work in progress, there are some official plugins that remain untested. PRs welcomed.

### Adding a Plugin
Start by adding your plugin to `src/plugins` folder. If you'd like your plugin to
display a test component, then create a new file for it as `YourPlugin.ts`.
Otherwise you can add it to `OfficalPlugins.ts` if it is an offical plugin or
`CommunityPlugins.ts` if it is a community plugin.

When writing a plugin make sure you use the `definePlugin` function to define your plugin.

**Example Plugin**
```ts
import { definePlugin, PluginStatus, PluginCategory } from '~/util'
import PluginBeep from '~/components/official/PluginBeep.vue'

export default definePlugin({
name: 'beep',
description: 'System beeps on errors and warnings',
category: PluginCategory.Official,
status: PluginStatus.Compatible,
demo: PluginBeep,
})
```

## Links

- [Vite](https://github.com/vitejs/vite)
- [Vite Plugin API](https://vitejs.dev/guide/api-plugin.html)
- [Rollup plugins](https://github.com/rollup/plugins)
- [Awesome Vite](https://github.com/vitejs/awesome-vite)

## License

MIT