Skip to content

Commit 6a626e4

Browse files
committed
Switch package to ESM only and Rollup 3 compatibility only
1 parent 3c5ebf9 commit 6a626e4

File tree

11 files changed

+481
-898
lines changed

11 files changed

+481
-898
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# rollup-plugin-node-externals
22
A Rollup plugin that automatically declares NodeJS built-in modules as `external`. Also handles npm dependencies, devDependencies, peerDependencies and optionalDependencies.
33

4-
Works in monorepos too!
4+
Works in npm/yarn/pnpm/lerna monorepos too!
55

66
## Why you need this
77
<details><summary>(click to expand)</summary>
@@ -24,7 +24,7 @@ npm install --save-dev rollup-plugin-node-externals
2424
```
2525

2626
## Usage
27-
When bundling an application or library, you want to have your **runtime dependencies** listed under `dependencies` in `package.json`, and **development dependencies** listed under `devDependencies`.
27+
You generally want to have your **runtime dependencies** listed under `dependencies` in `package.json`, and your **development dependencies** listed under `devDependencies`.
2828

2929
If you follow this simple rule, then the defaults are just what you need:
3030
```js
@@ -162,7 +162,12 @@ Rollup's own `external` configuration option always takes precedence over this p
162162

163163

164164
## Breaking changes
165-
<details><summary>(click to expand)</summary>
165+
166+
### Breaking changes in version 6
167+
- This package is now esm-only and requires NodeJS v16+.<br />*If you need CommonJS or older NodeJS support, please stick to v5.*
168+
- This plugin now has a **peer-dependency** on Rollup ^3.0.0.<br />*If you need Rollup 2 support, please stick to v5.*
169+
170+
<details><summary>Previous versions -- click to expand</summary>
166171

167172
### Breaking changes in version 5
168173
- In previous versions, the `devDeps` option defaulted to `true`.<br>This was practical, but often wrong: devDependencies are meant just for that: being used when developping. Therefore, the `devDeps` option now defaults to `false`, meaning Rollup will include them in your bundle.

0 commit comments

Comments
 (0)