-
Notifications
You must be signed in to change notification settings - Fork 33
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
fix(types): build types from JS source #376
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
mcous
force-pushed
the
build-types
branch
5 times, most recently
from
May 28, 2024 02:42
5643c59
to
5192455
Compare
mcous
commented
May 31, 2024
mcous
commented
May 31, 2024
mcous
force-pushed
the
build-types
branch
2 times, most recently
from
June 9, 2024 19:00
22bd3d5
to
2fcc251
Compare
mcous
force-pushed
the
testing-core-mod
branch
2 times, most recently
from
June 9, 2024 19:02
70f6d81
to
18b118b
Compare
mcous
force-pushed
the
testing-core-mod
branch
3 times, most recently
from
June 19, 2024 18:31
ba6f67f
to
6533bb3
Compare
mcous
force-pushed
the
build-types
branch
2 times, most recently
from
June 22, 2024 16:30
979431a
to
a2a5039
Compare
mcous
force-pushed
the
build-types
branch
3 times, most recently
from
June 26, 2024 00:11
5df1128
to
06644b9
Compare
mcous
changed the title
refactor(types): build types from JS source
fix(types): build types from JS source
Jun 26, 2024
🎉 This PR is included in version 5.2.0-next.2 🎉 The release is available on: Your semantic-release bot 📦🚀 |
🎉 This PR is included in version 5.2.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
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