fix: Fix ESM distribution for node import usage#819
Open
isaacs wants to merge 1 commit intoalgolia:masterfrom
Open
fix: Fix ESM distribution for node import usage#819isaacs wants to merge 1 commit intoalgolia:masterfrom
isaacs wants to merge 1 commit intoalgolia:masterfrom
Conversation
When loading this module with import() in Node, the CommonJS module was
being loaded, resulting in {default:{default:fn}} instead of just
{default:fn} as intended.
Because the types are only defined for CommonJS, this was further
compounded, meaning that instead of doing this:
```ts
import reactElementToJSXString from 'react-element-to-jsx-string'
```
TypeScript users would have to do this:
```ts
const {
default: { default: reactElementToJSXString },
} = (await import('react-element-to-jsx-string')) as unknown as {
default: typeof import('react-element-to-jsx-string')
}
// wat.
```
- Add conditional exports for import and require, so that the ESM is
served to import() users.
- Add a build script to place a package.json file in dist/esm, setting
it to ESM mode for Node's loader and TypeScript's module resolution.
- Test that require() and import() receive matching objects, when
loading from a mjs file in a folder outside this project.
With this change, `import()` in Node loads the ESM version, properly
typed, without any hassle.
Collaborator
|
@isaacs I will have look. It looks like the smoke test suite it not really well done for modern ESM build |
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
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.
When loading this module with import() in Node, the CommonJS module was being loaded, resulting in {default:{default:fn}} instead of just {default:fn} as intended.
Because the types are only defined for CommonJS, this was further compounded, meaning that instead of doing this:
TypeScript users would have to do this:
With this change,
import()in Node loads the ESM version, properly typed, without any hassle.