Add TypeScript types for JavaScript components #413
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.
🛠 Summary of changes
Includes TypeScript types in the published NPM package for JavaScript components.
This basically republishes
@uswds/uswds
DefinitelyTyped types, with corrected LGDS aliases and missing type definitions for newer components. There were a handful of different errors with the DefinitelyTyped types, and I may work to propose an upstream patch to resolve these, which would hopefully allow the typings of this package to be simplified.This doesn't include enforcement that the typings exactly reflect the exported components, which I'd like to add in future iterations to provide similar guarantees to what's asserted in
test/components/index.test.js
.📜 Testing Plan
I tested this in
identity-idp
by changing its@18f/identity-design-system
dependency to point to the local filesystem copy and verifying that component references include autocompletion and type validation.In
identity-idp
:rm -rf node_modules && yarn
yarn typecheck
Example (
app/javascript/packages/clipboard-button/clipboard-button-element.ts
):