fix: fix CommonJS type resolution#608
Merged
Merged
Conversation
Member
|
Hey @wojtekmaj thank you! Merging this into main. I still have a few tests to run on main before releasing 4.6, which I'm planning to finish this weekend. |
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.
The package currently points both ESM and CJS consumers at the same declaration file:
That breaks typed CommonJS consumers using Node16/NodeNext-style resolution. For example, this is a normal way to consume a CommonJS package from a
.ctsfile:With the current package metadata, TypeScript rejects it with:
Static imports in a CommonJS TypeScript file fail too:
The package does have a CommonJS runtime entry (
dist/node-cron.cjs), so consumers should not need to switch to dynamicimport()just to satisfy TypeScript. The problem is that TypeScript sees the shareddist/node-cron.d.tsfile as ESM because this package has"type": "module".This PR gives the
importandrequirebranches their own type declarations:Rollup now emits
dist/node-cron.d.ctsalongsidedist/node-cron.d.ts. After that, theimport cron = require("node-cron")example type-checks correctly.Previously,
arethetypeswrongreturned:Now it returns:
Checked with: