Skip to content

doc: packages docs feedback #35370

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
guybedford wants to merge 9 commits into from
Closed

doc: packages docs feedback #35370

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
d054ee0
doc: packages docs feedback
guybedford Sep 27, 2020
4f9495c
fixups
guybedford Sep 27, 2020
0598dc9
pr feedbackg
guybedford Sep 27, 2020
7df9cd7
keep nearest parent phrases
guybedford Sep 28, 2020
896b1ff
package boundary suggestions
guybedford Sep 28, 2020
2a19db1
Apply suggestions from code review
guybedford Sep 28, 2020
3a35054
further feedback
guybedford Sep 28, 2020
272a18c
remove unused definition
guybedford Sep 28, 2020
1ebef9a
Update doc/api/packages.md
guybedford Sep 28, 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
Apply suggestions from code review 
Co-authored-by: Geoffrey Booth <456802+GeoffreyBooth@users.noreply.github.com>
  • Loading branch information
@guybedford @GeoffreyBooth
guybedford and GeoffreyBooth authored Sep 28, 2020
commit 2a19db19ecff716b7df8557e848a7291db2c49a0
9 changes: 5 additions & 4 deletions doc/api/packages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -839,9 +839,10 @@ until a node_modules folder or the volume root is reached.
node my-app.js # Runs as ES module
```

If no `package.json` is found once the volume root is reached, or if the nearest
parent `package.json` lacks a `"type"` field, or contains `"type": "commonjs"`,
`.js` files are treated as [CommonJS][].
If the nearest parent `package.json` lacks a `"type"` field, or contains
`"type": "commonjs"`, `.js` files are treated as [CommonJS][]. If the volume
root is reached and no `package.json` is found, `.js` files are treated as
[CommonJS][].

`import` statements of `.js` files are treated as ES modules if the nearest
parent `package.json` contains `"type": "module"`.
Expand Down Expand Up @@ -958,7 +959,7 @@ where `import '#dep'` would now get the resolution of the external package
`dep-node-native` (including its exports in turn), and instead get the local
file `./dep-polyfill.js` relative to the package in other environments.

Unlike the exports field, import maps permit mapping to external packages,
Unlike the `"exports"` field, import maps permit mapping to external packages,
providing an important use case for conditional loading scenarios.

Apart from the above, the resolution rules for the imports field are otherwise
Expand Down