Skip to content
Closed
Changes from 1 commit
Commits
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
Next Next commit
doc: explicitly doc package.exports is breaking
If package authors don't explicitly include all previously supported
entry points introducing package.exports will be a Semver-Major change.

Add a warning about this behavior and offer two potential solutions
for module authors.

Refs: then/is-promise#20
  • Loading branch information
MylesBorins committed Apr 26, 2020
commit 4e4f086794be10b33e721749f579615d5ba3799e
6 changes: 6 additions & 0 deletions doc/api/esm.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,12 @@ also be used within `"exports"` to define different package entry points per
environment, including whether the package is referenced via `require` or via
`import`.

***Warning***: Introducing the exports field prevents consumers of a package
Comment thread
MylesBorins marked this conversation as resolved.
Outdated
for using any entry points that is not defined, including the `package.json`.
Comment thread
MylesBorins marked this conversation as resolved.
Outdated
This is a Semver-Major change. To make the introduction of `"exports"`
Comment thread
MylesBorins marked this conversation as resolved.
Outdated
Comment thread
MylesBorins marked this conversation as resolved.
Outdated
Semver-Minor either ensure that every previously supported entry point is
Comment thread
MylesBorins marked this conversation as resolved.
Outdated
exported or include a export of the root of the package `"./"; "./"`.
Comment thread
MylesBorins marked this conversation as resolved.
Outdated

If both `"exports"` and `"main"` are defined, the `"exports"` field takes
precedence over `"main"`.

Expand Down