JSdoc in htmx.js + generated TypeScript definition #2336
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.
Highlights
npm run type-declarations
htmx
object itself astsc
would otherwise generate invalid TypeScript codetypedef
s in the global scope so thattsc
properly exports them, and at the bottom of the file as I thought it would be pretty annoying to have to scroll past 150~ lines of JSDoc to start reading the code// @ts-ignore
in places where code is valid but tsc is too strictTests pass, also ran the tests in the extensions repo, all clear
Going further
If this is accepted, I would recommend going further with the following:
tsc
in thenpm t
script to have the pipeline check the code is correctly typed before merging PRs