This repository has been archived by the owner on Sep 2, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 43
doc: first pass at minimal-kernel #180
Merged
Merged
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
a40b8a9
doc: first pass at minimal-kernel
MylesBorins aa9a20b
Edit of minimal kernel doc (#2)
GeoffreyBooth 3632b6a
fixup: update to point to new pr
MylesBorins 8bf0a5a
fixup: minor tweaks
MylesBorins b50ad7e
fixup: remove vm + loader as per jdd
MylesBorins efa87ef
fixup: explicitly mention builtins
MylesBorins File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
# Plan for New Modules Implementation | ||
|
||
This document outlines the plan for building a new implementation to support ECMAScript modules in Node.js. The general idea is to start with a “minimal kernel” as Phase 1, which consists of features that the @nodejs/modules group have agreed will be necessary for all potential iterations of our ESM implementation. Phase 1 does _not_ include features that preclude other potential features or implementation approaches; and Phase 1 also does not include some features that should naturally be built in a later phase of development, for example because those features depend on features planned for Phase 1. The minimal kernel/phase 1 is _not_ intended to be merged into Node core or released; it is only a starting point for gradually building layers of consensus. | ||
|
||
At every phase, the following standards must be maintained: | ||
|
||
* Spec compliance ([#132](https://github.com/nodejs/modules/issues/132)): We must always follow the ES spec. | ||
* Browser equivalence ([#133](https://github.com/nodejs/modules/issues/133)): There’s room for debate in specific cases, but in general if Node is doing something that browsers also do, Node should do it in the same way. Alternatively, code that executes in both environments should produce identical results. | ||
* Don’t break CommonJS ([#112](https://github.com/nodejs/modules/issues/112)): We cannot cause breaking changes with regards to CommonJS. | ||
|
||
See also the [features list in the README](https://github.com/nodejs/modules#features). | ||
|
||
## Phase 1: The Minimal Kernel | ||
|
||
These features will be part of the first phase of development: | ||
|
||
* `module.createRequireFromPath` ([nodejs/node#19360](https://github.com/nodejs/node/pull/19360)) is the only way to import CommonJS into an ES module, for now. | ||
- `import.meta.require` fails at runtime as opposed to import time. This is not desireable to all committee members | ||
- Hold off on `import` statements for CommonJS until more progress is made on the dynamic modules spec. | ||
- landed in https://github.com/nodejs/node/commit/246f6332e5a5f395d1e39a3594ee5d6fe869d622 | ||
|
||
* `import` statements will only support files with an `.mjs` extension, and will import only ES modules, for now. | ||
- In a later phase, the intention is to move forward with format databases to map extensions and support multiple use cases. | ||
- No JSON or native modules; `createRequireFunction` can be used to get these. | ||
|
||
* `import.meta.url`. | ||
- Already in the existing implementation. | ||
|
||
* Dynamic `import()`. | ||
- Already in the existing implementation. | ||
|
||
|
||
### How will we get from where we are to Phase 1 | ||
|
||
* Remove support in the `import` statement of formats other than ESM: | ||
- No CommonJS. | ||
- No JSON. | ||
- No native modules. | ||
- Implemented in https://github.com/nodejs/ecmascript-modules/pull/3 | ||
|
||
* Remove dynamic path searching: | ||
- No extension adding. | ||
- No directory resolution, including no support for `index.js` or `index.mjs`. | ||
- No support for `main` field for ESM. | ||
- Implemented in https://github.com/nodejs/ecmascript-modules/pull/2 | ||
|
||
|
||
## Later Phases | ||
|
||
There **will** be future phases. We will **not** ship the code produced by Phase 1. This first phase lacks support for important use cases and will not be released as the new modules implementation. |
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.
This comment was marked as off-topic.
Sorry, something went wrong.
This comment was marked as off-topic.
Sorry, something went wrong.