Skip to content

Commit b3225a3

Browse files
committed
docs: deprecate includeDependencies
[Closes #26]
1 parent 23b0f0e commit b3225a3

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
# Rollup Plugin Peer Deps External
44
Automatically externalize `peerDependencies` in a `rollup` bundle.
5-
Also optionally externalize `dependencies` in a `rollup` bundle.
65

76
## Motivation
87
When bundling a library using [`rollup`](https://github.com/rollup/rollup), we generally want to keep from including [`peerDependencies`](https://nodejs.org/en/blog/npm/peer-dependencies/) since they are expected to be provided by the consumer of the library. By excluding these dependencies, we keep bundle size down and avoid bundling duplicate dependencies.
@@ -44,8 +43,8 @@ export default {
4443
}
4544
```
4645

47-
### includeDependencies
48-
Sometimes it's necessary to include a package as a direct dependency instead of a peer dependency. This can happen if your package has a very specific requirement on the dependency and cannot accept another version. In this case set `includeDependencies` to `true` and all of your package's dependencies will also be included as externals
46+
### includeDependencies \*\**deprecated*\*\*
47+
Set `includeDependencies` to `true` to also externalize regular dependencies in addition to peer deps.
4948

5049
```javascript
5150
// Add to plugins array in rollup.config.js

0 commit comments

Comments
 (0)