Skip to content

docs: clarify use cases for Rollup plugin type #183

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
thescientist13 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: clarify use cases for Rollup plugin type #183

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion src/pages/docs/reference/plugins-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -710,7 +710,7 @@ Below is an example from [Greenwood's codebase](https://github.com/ProjectEvergr

## Rollup

Though rare, there may be cases for tapping into the bundling process for Greenwood. If so, this plugin type allow users to tap into Greenwood's [**Rollup**](https://rollupjs.org/) configuration to provide any custom Rollup behaviors you may need.
Though rare, there may be some cases for tapping into the bundling phase of Greenwood's build pipeline, like [externalizing dependencies](https://rollupjs.org/configuration-options/#external) (e.g. the AWS SDK) or [pre-fixing specifiers](https://docs.deno.com/runtime/fundamentals/node/) for certain runtimes (e.g. `npm:`, `node:`). For these kinds of use cases, this plugin type allow users to tap into Greenwood's [**Rollup**](https://rollupjs.org/) bundling configuration to provide any custom Rollup behaviors you may need.

Simply use the `provider` method to return an array of Rollup plugins:

Expand Down Expand Up @@ -741,6 +741,8 @@ Simply use the `provider` method to return an array of Rollup plugins:

<!-- prettier-ignore-end -->

> Reminder: this plugin type will only to production builds, and _not_ during development. Resource plugins are the best way to handle transformations for development and production.

## Server

Server plugins allow developers to start and stop custom servers as part of the _development_ lifecycle of Greenwood.
Expand Down