README.md

Rollup Plugins

🍣 The one-stop shop for official Rollup plugins

This repository houses plugins that Rollup considers critical to every day use of Rollup, plugins which the organization has adopted maintenance of, and plugins that the project recommends to its users.

Plugins Found Here

alias Define and resolve aliases for bundle dependencies auto-install Automatically install dependencies that are imported by a bundle. beep System beeps on errors and warnings buble Compile ES2015 with buble dsv Convert .csv and .tsv files into JavaScript modules with d3-dsv image Import JPG, PNG, GIF, SVG, and WebP files inject Scan modules for global variables and injects import statements where necessary json Convert .json files to ES6 modules replace Replace strings in files while bundling strip Remove debugger statements and functions like assert.equal and console.log from your code url Import files as data-URIs or ES Modules virtual Load virtual modules from memory wasm Import WebAssembly code with Rollup yaml Convert YAML files to ES6 modules

Other Packages Found Here

pluginutils A set of utility functions commonly used by Rollup plugins

Contributing

This repository is a monorepo which leverages pnpm for dependency management.

To begin, please install pnpm:

$ npm install pnpm -g

Working with Plugin Packages

All plugin packages are kept in the /packages directory.

Adding dependencies:

$ pnpm add <package> --filter ./packages/<name>

Where <package> is the name of the NPM package you wish to add for a plugin package, and <name> is the proper name of the plugin. e.g. @rollup/plugin-beep.

Publishing:

$ pnpm run publish -- <name>

Where <name> is the portion of the plugin package name following @rollup/plugin-. e.g. beep. Publishing will create a new tag in the form of <name>-v<version> (e.g. beep-v0.1.0) and push the tag to the repo upon successful publish.

Commits for release should be in the form of chore(release): <name>-v<version>.

Running Tests:

To run tests on all packages which have changes:

$ pnpm run test

To run tests on a specific package:

$ pnpm run test --filter ./packages/<name>

Linting:

To lint all packages which have changes:

$ pnpm run lint

To lint a specific package:

$ pnpm run lint --filter ./packages/<name>

Note: Scripts in the repository will run the root test and lint script on those packages which have changes. This is also how the CI pipelines function. To run either on a package outside of that pipeline, use pnpm run <script> -- @rollup/plugin-<name>.

Adding Plugins

While we don't have an official procedure for adding third-party plugins to this repository, we are absolutely open to the idea. If you'd like to speak about your project being a part of this repo, please reach out to @RollupJS on Twitter.

Meta

CONTRIBUTING

LICENSE (Mozilla Public License)