doc: correct module loading descriptions #60346
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Review requested:
|
joyeecheung
force-pushed
the
fix-package-loader
branch
from
5d4be39 to
d823b9d
Compare
The existing description is outdated, and exposes too many details that are subject to change. - There is no point conceptualizing "two module loaders", in reality the boundary is blurred since the two invoke each other to support require(esm) and import(cjs). The distinction lies not in what kind of module is being requested/which loader is used, but only in how the the module request is initiated (via `require()` or `import()`). The inner working of the loaders are subject to change and not suitable to be documented. - It should not mention monkey patching in the documentation, as publicly supported universal hooks are already provided through `module.registerHooks()`, and so there's no need to single out any of them in terms of loader hooks support either. - Remove the description about whether they are asynchronous or synchronous, which is also implementation detail subject to change. - Add missing descriptions about how .ts, .mts and .cts are treated, and `.node` is also supported in import now. - There is no need to specially mention .node treatment in cli.md, link to the explanations about loading from `import` in packages.md instead.
joyeecheung
force-pushed
the
fix-package-loader
branch
from
d823b9d to
b79756e
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The existing description is outdated, and exposes too many details that are subject to change.
require()orimport()). The inner working of the loaders are subject to change and not suitable to be documented..nodeis also supported in import now.importin packages.md instead.