Fix exports in package.json #235
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
TypeScript 4.7 introduced the `node16` module resolution. This is more
strict, and more correct than older module resolution options.
According to TypeScript, before this change it is possible to use
`require('ics')`, but not `import 'ics'` from native ESM. This is
because there is an explicit `require` export, that is accompanied by a
`.d.ts` file, but there’s also a default export, which is untyped.
This change fixes it by removing `index.js` altogether. Its only
purpose was to re-export everything from `dist/index.js`. This is now
handled by pointing the main entrypoint and the default export in
`package.json` to `dist/index.js`. The `types` export is necessary,
because the file doesn’t exist in the same place as the dist files.
The `module` option was removed entirely. This is a faux ESM option that
is supposed to point to a module using ESM syntax. It’s pointing to a
CJS file instead, and it would now match the `main` field anyway.
|
Thanks for the explanation @remcohaszing! |
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.
TypeScript 4.7 introduced the
node16module resolution. This is more strict, and more correct than older module resolution options.According to TypeScript, before this change it is possible to use
require('ics'), but notimport 'ics'from native ESM. This is because there is an explicitrequireexport, that is accompanied by a.d.tsfile, but there’s also a default export, which is untyped.This change fixes it by removing
index.jsaltogether. Its only purpose was to re-export everything fromdist/index.js. This is now handled by pointing the main entrypoint and the default export inpackage.jsontodist/index.js. Thetypesexport is necessary, because the file doesn’t exist in the same place as the dist files.The
moduleoption was removed entirely. This is a faux ESM option that is supposed to point to a module using ESM syntax. It’s pointing to a CJS file instead, and it would now match themainfield anyway.