fix: package types exports for ESM projects #970
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
cseas
requested review from
chaitanyadeorukhkar,
kamleshchandnani,
anuraghazra,
dhruvdutt,
nashcheez,
divyanshu013 and
saurabhdaware
as code owners
🦋 Changeset detectedLatest commit: 3223527 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 3223527:
|
cseas
force-pushed
the
fix-web-declaration
branch
from
7e52187
to
4dd7df2
Compare
cseas
changed the title
|
✅ PR title follows Conventional Commits specification. |
|
can you test this on react native project and confirm? AFAIK the exports field has no effect on RN projects yet. |
kamleshchandnani
approved these changes
Jan 30, 2023
|
Ack. Will test on React Native soon as I get some time. |
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.
Fixes #960
Description
TypeScript requires types to be declared in the
"types"property under"exports"section ofpackage.jsonof npm packages to detect declaration files in a project setup that outputs ESM.(combination of
type:modulein project'spackage.jsonandmodule:NodeNextintsconfig.json)I've added the missing fields. These fields are only used by TypeScript in an ESM setup so backwards compatibility shouldn't be affected.
Note: An alternate shorter solution is to rename the generated types files for web from
index.d.tstoindex.web.d.ts. While that would work for the above config, it will break types formoduleResolution:node. Since the automatic detection of TypeScript varies based on the moduleResolution used, it's better to tell TypeScript explicitly where the types are for each export instead of relying on automatic detection. Renaming the generated file will also cause a backwards compatibility issue as pointed out by this code comment:https://github.com/razorpay/blade/blob/master/packages/blade/rollup.config.js#L127
Testing
Tested the below combinations in a web project.
Note: Haven't tested this solution for a react-native project.
Screenshots
References