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

Other Packages Found Here

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 --filter ./packages/<name> add <package>

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 publish <name> [flags]

Where <name> is the portion of the plugin package name following @rollup/plugin-. (e.g. beep)

The publish script performs the following actions:

• Gathers commits from the last release tag
• Determines the next appropriate version bump (major, minor, or patch)
• Updates package.json
• Generates a new ChangeLog entry
• Updates CHANGELOG.md for the target plugin
• Commits package.json and CHANGELOG.md, with a commit message is in the form chore(release): <name>-v<version>
• Publishes to NPM
• Tags the release in the form <name>-v<version> (e.g. beep-v0.1.0)
• Pushes the commit and tag to Github

Flags

The following flags are available to modify the publish process:

• --dry tells the script to perform a dry-run, skipping any file modifications, NPM, or Git Actions. Results from version determination and new ChangeLog additions are displayed.
• --major, --minor, --patch can be used to force a particular type of semver bump.
• --no-push will instruct the script not to push changes and tags to Git.
• --no-tag will instruct the script not to tag the release.

Running Tests:

To run tests on all packages which have changes:

$ pnpm test

To run tests on a specific package:

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

Linting:

To lint all packages which have changes:

$ pnpm lint

To lint a specific package:

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

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 <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 (MIT)