Have package.json point to correct type file #89
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
aarsilv
commented
Jun 24, 2024
| @@ -8,7 +8,7 @@ | |||
| "/src", | |||
| "!*.spec.ts" | |||
| ], | |||
| "typings": "dist/js-client-sdk.d.ts", | |||
| "types": "dist/index.d.ts", | |||
There was a problem hiding this comment.
index.d.ts is what is generated for our top-level index.ts
|
🎉 |
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.
Eppo Internal:
🎟️ *Ticket: FF-2505 - Could not find a declaration file for module
🗨️ *Slack: "...signals about the declaration file being missing..."
Motivation and Context
Typescript allows including type information with an npm package using the
types(ortypings) field inpackage.json. (docs)However, our entry for this field pointed to a non-existent file, which would result in typescript-loader generate the following warning error:
Description
To fix this, we point our type file at the correct top-level type file,
index.d.ts.To better follow convention, we've also renamed the
typingsfield totypes.How has this been tested?
Installing the updated and rebuilt package in a simple test application no-longer has the error.