-
-
Notifications
You must be signed in to change notification settings - Fork 9.3k
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
Tech: do not generate ESM dist for preset files #22330
Merged
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
ndelangen
added
maintenance
User-facing maintenance tasks
patch:yes
Bugfix & documentation PR that need to be picked to main branch
labels
May 1, 2023
ndelangen
changed the title
do not generate ESM for preset entries
Tech: do not generate ESM dist for preset files
May 1, 2023
shilman
reviewed
May 1, 2023
tmeasday
approved these changes
May 2, 2023
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.
Seems like a neat solution
shilman
added
the
patch:done
Patch/release PRs already cherry-picked to main/release branch
label
May 3, 2023
shilman
pushed a commit
that referenced
this pull request
May 3, 2023
Tech: do not generate ESM dist for preset files
8 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
maintenance
User-facing maintenance tasks
patch:done
Patch/release PRs already cherry-picked to main/release branch
patch:yes
Bugfix & documentation PR that need to be picked to main branch
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.
Closes #21316
What I did
When TSup is bundling code, it will add a bit of require polyfill code to the output, when it encounters code referencing
require
in 1 of the entrypoints.It will add the polyfill code to all entrypoints, and will refuse to treeshake it out.
So I made en excemption for preset entries, to never get a mjs file generated, because those often have references to
require
in them.How to test
Run the build process and check for existence of this type of code in dist:
At least within the docs addon this no longer happens.
This code does impact all monorepo packages though, but I think that's fine. AFAIK we never use mjs exports of presets, always the cjs files.
Some day we'll convert everything over to ONLY ESM, and have all packages be type=module, but that's a project for future me.