Skip to content

doc: clarify module system selection #41383

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

Merged
aduh95 merged 14 commits into from
Jan 17, 2022
Merged

doc: clarify module system selection #41383

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
1b1159a
doc: clarify module system selection
aduh95 Jan 2, 2022
dd7140f
Address review comments
aduh95 Jan 5, 2022
97515fd
fixup!
aduh95 Jan 7, 2022
c19d161
fixup!
aduh95 Jan 7, 2022
ce3edd0
fixup!
aduh95 Jan 8, 2022
be6f791
fixup!
aduh95 Jan 10, 2022
e9c0b15
fixup!
aduh95 Jan 11, 2022
4c697b7
Apply suggestions from code review
aduh95 Jan 13, 2022
2cea6a8
fixup!
aduh95 Jan 13, 2022
21b45bf
fixup!
aduh95 Jan 13, 2022
93d6a23
fixup!
aduh95 Jan 14, 2022
fe05b72
fixup!
aduh95 Jan 14, 2022
5de6698
fixup!
aduh95 Jan 16, 2022
b08ec87
fixup!
aduh95 Jan 16, 2022
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 <[email protected]>
  • Loading branch information
@aduh95 @GeoffreyBooth
aduh95 and GeoffreyBooth authored Jan 13, 2022
commit 4c697b748e3e4f81e61793cf9a7181abd526447a
2 changes: 1 addition & 1 deletion doc/api/modules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ By default, Node.js will treat the following as CommonJS modules:

See [Determining module system][] for more details.

Calling `require()` always use the CommonJS module loader, calling `import()`
Calling `require()` always use the CommonJS module loader. Calling `import()`
always use the ECMAScript module loader.

## Accessing the main module
Expand Down
18 changes: 10 additions & 8 deletions doc/api/packages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ files in the package should be interpreted.

### Modules loaders

Node.js has two system for resolving a specifier and load modules.
Node.js has two systems for resolving a specifier and loading modules.

There is the CommonJS module loader:

Expand All @@ -99,7 +99,7 @@ There is the CommonJS module loader:
* It treats `.json` as JSON text files.
* `.node` files are interpreted as compiled addon modules loaded with
`process.dlopen()`.
* It treats files that do not have `.json` or `.node` extension as JavaScript
* It treats all files that lack `.json` or `.node` extensions as JavaScript
text files.
* It cannot be used to load ECMAScript modules. Attempting to do so will result
in a [`ERR_REQUIRE_ESM`][] error.
Expand All @@ -111,14 +111,16 @@ There is the ECMAScript module loader:
* It is not monkey patchable, can be customized using [loader hooks][].
* No extension searching, the specifier must point to the exact URL of the file.
* It does not support folders as modules.
* Import assertion are needed to load JSON modules (behind
* It can load JSON modules, but an import assertion is required (behind
`--experimental-json-modules` flag).
* It only accepts `.js`, `.mjs`, and `.cjs` extensions for JavaScript text
* It accepts only `.js`, `.mjs`, and `.cjs` extensions for JavaScript text
files.
* It can be used to load (JavaScript) CommonJS modules. It passes the module
content through the `es-module-lexer` to assess what are its exports, convert
its URL to an absolute path and load it using the CommonJS module loader.
* It can be accessed using `import`.
* It can be used to load JavaScript CommonJS modules. Such modules
are passed through the `es-module-lexer` to try to identify named exports,
which are available if they can be determined through static analysis.
Imported CommonJS modules have their URLs converted to absolute
paths and are then loaded via the CommonJS module loader.
* It is responsible for handling `import` statements and `import()` expressions.

### `package.json` and file extensions

Expand Down