-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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.
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
esm: use specific option for import vs require for support code #1931
Merged
Conversation
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
Still need to add and update some docs but feedback on the what and why would be great. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good
No objections so far; I'll update the documentation tonight and merge tomorrow. |
This was referenced Apr 4, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
🤔 Motivation and changes
As part of the initial work to support ESM, I made it so that all support code was
import
ed by default, except sometimes --- based on heuristics around file extension and whether--require-module
had been specified --- it fell back torequire
. It was a kind of aggressive move towards the new module system.On reflection I think this was a mistake. The heuristics are bound to be wrong some of the time and potentially leave users with a breaking change that's difficult to work around. A future major release where we go ESM-only is probably not far away and so it makes sense to drop
require
entirely at that point.Fortunately the ESM support has only gone as far as the 8.x RC so it's not too late to pivot. This PR makes it so that:
--require
does the same as it always did before, no breaking changes--import
, a new option, works like--require
but imports instead, so we'd expect ESM projects taking advantage of the new support in 8.x to use this--require
or--import
are specified, the automaticrequire
ing does what it did before based on feature paths, but also any.mjs
files found in the same way areimport
ed - this is a backwards-compatible change because.mjs
files didn't work at all previouslyNot rowing back on formatters and snippets using
import
- I think this still right because it's much more predictable and there's no just-in-time transpilation involved to complicate things.🏷️ What kind of change is this?
📋 Checklist: