Skip to content

doc: update to package.exports docs #33074

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

Closed
MylesBorins wants to merge 24 commits into from
Closed

doc: update to package.exports docs #33074

Changes from 1 commit
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
4e4f086
doc: explicitly doc package.exports is breaking
MylesBorins Apr 26, 2020
1068cfb
Update doc/api/esm.md
MylesBorins Apr 27, 2020
c1f5310
Update doc/api/esm.md
MylesBorins Apr 27, 2020
dd2ba5b
Update doc/api/esm.md
MylesBorins Apr 27, 2020
0fc7b73
Update doc/api/esm.md
MylesBorins Apr 27, 2020
5508ad8
Update doc/api/esm.md
MylesBorins Apr 27, 2020
2acd426
Update doc/api/esm.md
MylesBorins Apr 28, 2020
d059abf
Update esm.md
MylesBorins Apr 29, 2020
3785420
fixup: lots of changes
MylesBorins Apr 29, 2020
c3b6f2f
Update doc/api/esm.md
MylesBorins May 1, 2020
e7937e8
Update doc/api/esm.md
MylesBorins May 1, 2020
7e1ac3a
Update doc/api/esm.md
MylesBorins May 1, 2020
a1f4781
Update doc/api/esm.md
MylesBorins May 1, 2020
c4ec3b1
Update doc/api/esm.md
MylesBorins May 1, 2020
fd65c2d
Update doc/api/esm.md
MylesBorins May 1, 2020
991af5d
Update doc/api/esm.md
MylesBorins May 4, 2020
33cdd05
Update doc/api/esm.md
MylesBorins May 4, 2020
a313dbc
fixup: remove note regarding tooling
MylesBorins May 4, 2020
68a09d5
fixup: explicitly enumerate
MylesBorins May 4, 2020
65cdd69
fixup: include folder example
MylesBorins May 4, 2020
a1614cc
fixup: be explicit about other limitations of ./ export
MylesBorins May 4, 2020
bab451c
fixup: fix lint
MylesBorins May 4, 2020
4f97c02
Update doc/api/esm.md
MylesBorins May 5, 2020
b15fc40
fixup: one more doc tweak
MylesBorins May 5, 2020
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
Prev Previous commit
Next Next commit
fixup: fix lint
  • Loading branch information
@MylesBorins
MylesBorins committed May 4, 2020
commit bab451c1e16430c385f74746513fe97c608b50f9
17 changes: 10 additions & 7 deletions doc/api/esm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,17 +189,17 @@ This encapsulation allows module authors to define a public interface for
their package.

If both `"exports"` and `"main"` are defined, the `"exports"` field takes
precedence over `"main"`. It is important to note that `"exports"` are not
specific to ES modules or CommonJS; `"main"` will be overridden by `"exports"`
if it exists. As such `"main"` cannot be used as a fallback for CommonJS
but it can be used as a fallback for legacy versions of Node.js that do not
support the `"exports"` field.
precedence over `"main"`. `"exports"` are not specific to ES modules or
CommonJS; `"main"` will be overridden by `"exports"` if it exists. As such
`"main"` cannot be used as a fallback for CommonJS but it can be used as a
fallback for legacy versions of Node.js that do not support the `"exports"`
field.

[Conditional Exports][] can be used within `"exports"` to define different
package entry points per environment, including whether the package is
referenced via `require` or via `import`. For more information about supporting
both CommonJS and ES Modules in a single package please consult
[the dual CommonJS/ES module packages section][].
[the dual CommonJS/ES module packages section][].

**Warning**: Introducing the `"exports"` field prevents consumers of a package
from using any entry points that are not defined, including the `package.json`
Expand Down Expand Up @@ -245,7 +245,10 @@ Alternatively a project could choose to export entire folders:

As a last resort, package encapsulation can be disabled entirely by creating an
export for the root of the package `"./": "./"`. This will expose every file in
Comment thread
hybrist marked this conversation as resolved.
the package at the cost of disabling encapsulation. As the ES Module loader in Node.js will not resolve file extensions or an `index.js` exporting the root is less expressive than either of the above examples as individuals will be unable to `import feature from 'my-mod/feature'`.
the package at the cost of disabling encapsulation. As the ES Module loader in
Node.js will not resolve file extensions or an `index.js` exporting the root is
less expressive than either of the above examples as individuals will be unable
to `import feature from 'my-mod/feature'`.
Comment thread
MylesBorins marked this conversation as resolved.
Outdated

#### Main Entry Point Export

Expand Down