refactor: Switch to .d.ts for types#100
Merged
rschristian merged 4 commits intomasterfrom Sep 3, 2025
Merged
Conversation
023b787 to
1842fb5
Compare
marvinhagemeister
approved these changes
Sep 3, 2025
Member
marvinhagemeister
left a comment
There was a problem hiding this comment.
LGTM, going with jsconfig.json is the right approach 👍
1842fb5 to
365bfa1
Compare
ad2abe3 to
63cfbae
Compare
This was referenced Sep 4, 2025
Merged
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.
Currently Microbundle is generating types for us from the JSDoc types which, IMO, probably isn't ideal. Builds are slightly slower, they're a bit harder to read, and Microbundle keeps the original JSDoc type comments in the generated
.d.tswhich are entirely redundant and makes it quite hard for consumers to read if they ever need to.Our types are so simple that a manual
.d.tsI think is a pretty objective improvement.Also adds a
jsconfig.json-- I don't know about other folks but my editor won't type check without it or atsconfig.jsonw/allowJSandcheckJSset. There's a few type errors that are mostly expected, but also caught one that could be easily addressed while writing this (_propswas missing, but consumed, fromPreactCustomElement)