Skip to content

Commit 365b7de

Browse files
committed
Updare readme for V7
1 parent bd22c4b commit 365b7de

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,6 @@ import { nodeExternals } from 'rollup-plugin-node-externals'
4444

4545
will both work.
4646

47-
> Note: an undocumented named export `externals` also exists that is kept in v6.1 for backwards compatibility only and will be removed in the next major version.
4847

4948
### Options
5049
You generally want to have your **runtime dependencies** (those that will be imported/required at runtime) listed under `dependencies` in `package.json`, and your **development dependencies** (those that should be bundled in by Rollup) listed under `devDependencies`.
@@ -189,24 +188,30 @@ Rollup's own `external` configuration option always takes precedence over this p
189188

190189
## Breaking changes
191190

192-
### Breaking changes in version 6
193-
- This package is now esm-only and requires NodeJS v16+.<br />*If you need CommonJS or older NodeJS support, please stick to v5.*
194-
- This plugin now has a **peer-dependency** on Rollup `^3.0.0 || ^4.0.0`.<br />*If you need Rollup 2 support, please stick to v5.*
191+
### Breaking changes in version 7
192+
- This package now supports the latest release of [any major version that is supported by Node.js itself](https://github.com/nodejs/Release#release-schedule).
193+
- The undocumented `externals` named export has been removed.
195194

195+
### Breaking changes in previous versions
196196
<details><summary>Previous versions -- click to expand</summary>
197197

198-
### Breaking changes in version 5
198+
#### Breaking changes in version 6
199+
- This package is now esm-only and requires NodeJS v16+.<br />*If you need CommonJS or older NodeJS support, please stick to v5.*
200+
- This plugin now has a **peer-dependency** on Rollup `^3.0.0 || ^4.0.0`.<br />*If you need Rollup 2 support, please stick to v5.*
201+
202+
#### Breaking changes in version 5
199203
- 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.
200204
- As anticipated since v4, the `builtinsPrefix` option now defaults to `'add'`.
201205
- The deprecated `prefixedBuiltins` option has been removed. Use `builtinsPrefix` instead.
202206
- `rollup-plugin-node-externals` no longer depends on the Find-Up package (while this is not a breaking change per se, it can be in some edge situations).
203207
- The plugin now has a _peer dependency_ on `rollup ^2.60.0 || ^3.0.0`.
204208

205-
### Breaking changes in version 4
209+
#### Breaking changes in version 4
206210
- In previous versions, the `deps` option defaulted to `false`.<br>This was practical, but often wrong: when bundling for distribution, you want your own dependencies to be installed by the package manager alongside your package, so they should not be bundled in the code. Therefore, the `deps` option now defaults to `true`.
207211
- Now requires Node 14 (up from Node 12 for previous versions).
208212
- Now has a _peer dependency_ on `rollup ^2.60.0`.
209-
</summary>
213+
214+
</details>
210215

211216

212217
## Licence

0 commit comments

Comments
 (0)