fix: deprecate default export in favor of named export #641
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
This deprecates the default export in favor of the new named export `sveltePreprocess`. It's done to ensure a better interop between CJS and ESM without resorting to hacks in the future. It also enables people using `"module": "NodeNext"` in their `tsconfig.json` to import without type errors. The sub exports were also adjusted so that the transpiled TS output doesn't include `__importDefault` wrappers, which makes Node's static analysis miss those named exports.
kaisermann
reviewed
Jun 14, 2024
kaisermann
reviewed
Jun 14, 2024
|
|
||
| // both for backwards compat with old svelte-preprocess versions | ||
| // (was only default export once, now is named export because of transpilation causing node not to detect the named exports of 'svelte-preprocess' otherwise) | ||
| export default babel; |
There was a problem hiding this comment.
Do we still need the default export here? IIRC these were re-exported with names in the package entrypoint.
There was a problem hiding this comment.
I'm doing this out of fear that someone may have done import babel from 'svelte-preprocess/.../babel'. We should definitely remove it in the next major
There was a problem hiding this comment.
I find that a tad unlikely, but that's an unfortunately good point 🥲
kaisermann
approved these changes
Jun 14, 2024
IanGallacher
added a commit
to IanGallacher/svelte-preprocess
that referenced
this pull request
Jul 28, 2024
update documentation example to correctly use changes from PR sveltejs#641
4 tasks
dummdidumm
pushed a commit
that referenced
this pull request
Jul 28, 2024
update documentation example to correctly use changes from PR #641
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.
This deprecates the default export in favor of the new named export
sveltePreprocess. It's done to ensure a better interop between CJS and ESM without resorting to hacks in the future. It also enables people using"module": "NodeNext"in theirtsconfig.jsonto import without type errors. The sub exports were also adjusted so that the transpiled TS output doesn't include__importDefaultwrappers, which makes Node's static analysis miss those named exports.Related: #591 (comment)
Before submitting the PR, please make sure you do the following
pnpm lint!)Tests
npm testorpnpm test