https://github.com/rollup/rollup-starter-plugin
Starter code for creating a Rollup plugin
https://github.com/rollup/rollup-starter-plugin
rollup rollup-plugin
Last synced: about 1 month ago
JSON representation
Starter code for creating a Rollup plugin
- Host: GitHub
- URL: https://github.com/rollup/rollup-starter-plugin
- Owner: rollup
- License: mit
- Created: 2019-06-24T15:40:03.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-11-17T03:46:10.000Z (over 2 years ago)
- Last Synced: 2025-03-27T14:13:24.641Z (2 months ago)
- Topics: rollup, rollup-plugin
- Language: JavaScript
- Size: 4.88 KB
- Stars: 5
- Watchers: 10
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# rollup-starter-plugin
This repo contains bare-bones code for creating a [Rollup plugin](https://rollupjs.org/guide/en/#plugins).
## Getting started
Clone this repository and install its dependencies:
```bash
npx degit https://github.com/rollup/rollup-starter-plugin my-plugin
cd my-plugin
npm install
```
1. Edit `package.json`
2. Edit `src/index.js`
- rename the `starterPlugin` function
- change `name: 'starter-plugin'` to your plugin name
- implement or delete the function stubs. See [hooks guide](https://rollupjs.org/guide/en#hooks)
3. Add your preferred test framework and implement tests
See [conventions](https://rollupjs.org/guide/en/#conventions) for writing Rollup plugins.