Skip to content
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

fix: Fix ESM distribution for node import usage #819

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Commits on Sep 28, 2023

  1. fix: Fix ESM distribution for node import usage

    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.
    isaacs committed Sep 28, 2023
    Configuration menu
    Copy the full SHA
    ae21b7c View commit details
    Browse the repository at this point in the history