-
-
Notifications
You must be signed in to change notification settings - Fork 56
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Generate CJS version of otpauth.d.ts file #447
Merged
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
hectorm
requested changes
Dec 1, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for your contribution! I don't usually work with TypeScript, but I've reviewed your changes and although they look good, I think they could be improved with the suggested changes.
hectorm
reviewed
Dec 2, 2023
@hectorm I think I've addressed all your comments now |
hectorm
approved these changes
Dec 6, 2023
LGTM, thanks! |
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.
I use your library in a TypeScript project and have just been updating my build. When I changed my TSConfig option
module
fromcommonjs
tonode16
I started getting the following error when importing your library:After a lot of digging it turns out this is because while your library does specify an export for Node CommonJS libraries (
https://github.com/hectorm/otpauth/blob/master/package.json#L44), it doesn't specify a CommonJS type definition file. TypeScript assumes that because the type definition file ends
d.ts
rather thand.cts
the package is an ESM package and fails (more info here: microsoft/TypeScript#53045)This PR adds the relevant lines that tells TypeScript that it can treat this as a CommonJS library. Note moving
types
down inexports
is necessary because otherwise it matches the firsttypes
before getting to the Node CommonJS specific one.