fix(types): build types from JS source #376
Merged
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.
Overview
This PR moves the source of truth for typing from a separately maintained
types/index.d.ts
file to JSDoc comments insrc
. I'm hopeful this will ease the maintenance burden of types, especially as we're supporting three major versions of Svelte.Svelte itself is undergoing some major-ish typing changes, so I'm keeping this as a draft for now
Change log
types/index.d.ts
tosrc/**
tsc
andenableJs
Future work
For now, I think vanilla JS is the best fit for this project, so I don't see any compelling reason to do anything drastic like switch to TS and introduce a build step. That being said, I do see this as a potential first step in introducing type-checking to the codebase via TS's
checkJs
option