chore(core): Add type declaration files for core packages #224
Conversation
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
1 participant
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.
Closes #223
What
Adds type declaration file for each core package.
Why
TypeScript consumers of makeup-js must provide ambient module declarations for makeup exports.
How
I used an LLM to consider the README and implementations of each export to infer correct type definitions. Definitions are documented via TSDoc conventions.
Types are included in
/distdir of each package. Each package config defines "types" to point to its respective type file.Ideal solution involves migrating libraries to TS. The team plans to migrate to new repo in the future, so this low effort patch seems more appropriate.