Skip to content
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

Jump to bottom

doc: clarify require behavior with non .js extensions #41345

Merged
merged 8 commits into from Jan 2, 2022
Merged

doc: clarify require behavior with non .js extensions #41345

Changes from 3 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
79a6c9a
doc: clarify `require` behavior with non `.js` extensions
aduh95 Dec 28, 2021
9d02904
Update doc/api/modules.md
aduh95 Dec 28, 2021
761197c
parse goal
aduh95 Dec 29, 2021
046e102
`.cjs` and `.mjs` in CJS
aduh95 Dec 30, 2021
5ed7e1c
`.cjs` files always need their extension to be included
aduh95 Jan 1, 2022
40b46cb
clean up links
aduh95 Jan 1, 2022
7639c2f
Remove enbling section as it doesn't have consensus
aduh95 Jan 2, 2022
9407cd5
remove repetition
aduh95 Jan 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 6 additions & 3 deletions doc/api/modules.md
View file
Open in desktop
Expand Up @@ -377,9 +377,11 @@ If the exact filename is not found, then Node.js will attempt to load the
required filename with the added extensions: `.js`, `.json`, and finally
`.node`.

`.js` files are interpreted as JavaScript text files, and `.json` files are
parsed as JSON text files. `.node` files are interpreted as compiled addon
modules loaded with `process.dlopen()`.
`.json` files are parsed as JSON text files, `.node` files are interpreted as
compiled addon modules loaded with `process.dlopen()`. Files using any other
extension (or no extension at all) are parsed as JavaScript text files. Refer to
the [Determining module system][] section to understand what parse goal will be
used.

aduh95 marked this conversation as resolved.
Show resolved Hide resolved
A required module prefixed with `'/'` is an absolute path to the file. For
example, `require('/home/marco/foo.js')` will load the file at
Expand Down Expand Up @@ -1036,6 +1038,7 @@ This section was moved to
* <a id="modules_sourcemap_payload" href="module.html#sourcemappayload">`sourceMap.payload`</a>
* <a id="modules_sourcemap_findentry_linenumber_columnnumber" href="module.html#sourcemapfindentrylinenumber-columnnumber">`sourceMap.findEntry(lineNumber, columnNumber)`</a>

[Determining module system]: packages.md#determining-module-system
[ECMAScript Modules]: esm.md
[GLOBAL_FOLDERS]: #loading-from-the-global-folders
[`"main"`]: packages.md#main
Expand Down