Skip to content

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

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 8 commits into from
Jan 2, 2022
Merged

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

Changes from 1 commit
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
clean up links
  • Loading branch information
@aduh95
aduh95 committed Jan 1, 2022
commit 40b46cb6299ae853881ea74ae13f704f4da600d8
5 changes: 2 additions & 3 deletions doc/api/modules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,7 @@ The module system is implemented in the `require('module')` module.
Node.js treats JavaScript code as CommonJS modules by default.
Authors can tell Node.js to treat JavaScript code as CommonJS modules
Copy link
Copy Markdown
Member

@ljharb ljharb Jan 1, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems weird to say “it’s the default, and here’s how you can make it apply”.

For file extensions, .cjs is always CJS, .mjs is always ESM, .js is CJS by default (but type module can make this be ESM), and anything else is either .json, .node, .wasm, or “unknown” (which is treated as CJS). Piped input is CJS by default, but can be made ESM with the input-type flag.

Can we say something basically exactly like that?

Copy link
Copy Markdown
Contributor Author

@aduh95 aduh95 Jan 2, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll remove this section from this PR and move it to a separate PR so it can be discussed separately if that's ok.

via the `.cjs` file extension, the `package.json` [`"type"`][] field, or the
`--input-type` flag. See
[Determining module system](packages.md#determining-module-system) for more
details.
[`--input-type`][] flag. See [Determining module system][] for more details.

## Accessing the main module

Expand Down Expand Up @@ -1059,6 +1057,7 @@ This section was moved to
[GLOBAL_FOLDERS]: #loading-from-the-global-folders
[`"main"`]: packages.md#main
[`"type"`]: packages.md#type
[`--input-type`]: cli.md#--input-typetype
[`ERR_REQUIRE_ESM`]: errors.md#err_require_esm
[`Error`]: errors.md#class-error
[`__dirname`]: #__dirname
Expand Down