Exports types for resolution in ESM Modules #112
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
ViolanteCodes
requested review from
marcinpece-apptension,
LenardMarcin and
courcelan
and removed request for
LenardMarcin
|
@jmlow Thank you! An issue with a fix is my favorite kind of issue ticket @marcinpece-apptension @courcelan could you take a look? FYI we will need to prefix commit method with |
courcelan
approved these changes
Dec 5, 2024
courcelan
added a commit
that referenced
this pull request
Dec 6, 2024
Merge pull request #112 from jmlow/esm-typings
|
@jmlow thank you, merged and new version released |
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.
While working with the buttercms NPM package in v2.3.0, I kept receiving the following Typescript error:
"Could not find a declaration file for module 'buttercms'. '/home/justi/projects/nv-web-platform/node_modules/buttercms/dist/butter.esm.js' implicitly has an 'any' type.
There are types at '/home/justi/projects/nv-web-platform/node_modules/buttercms/lib/butter.d.ts', but this result could not be resolved when respecting package.json "exports". The 'buttercms' library may need to update its package.json or typings."
From my research, I found an example at https://antfu.me/posts/publish-esm-and-cjs#tsup
It looks like when you split the exports between cjs and esm, you also need to export the types in package.json for the typings to apply to both exports.
I tested this by patching the package.json in my local node_modules and it fixes the issue.
Since I already did the research and it's a one-line fix, I figured I'd just submit a PR instead of an issue. I hope that's alright!