-
Notifications
You must be signed in to change notification settings - Fork 164
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
Rewrite repo in typescript #72
Conversation
…hen using the git repo as a target on the typescript branch, attempting to work out why.
In order to enhance the developer experience for both the ViroCommunity maintainers and also the end developer, I've converted the repo to typescript. There were many instances where common event handlers were copy/pasted across Viro Components. This makes the repo hard to maintain. The end user can also get types, commends, and docs while developing using an IDE. This also will help the end user avoid usage mistakes, which in turn should reduce the load on the maintainers.
Adds an output directory to the tsconfig so the source code is separate from the generated js and d.ts files. This will help with ease of development
@doranteseduardo I've considered this complete. I've tested everything in my starter kit, but I think it's ready to go. The issues I've found (#74 and #75) were replicated in my typescript repo and in the latest released version of viro. There might be more documentation or scripts I need to update - essentially, tsc needs to be run to generate the dist folder before the repo can be uploaded to NPM |
|
Without the Resources folder being copied by tsc, this would not resolve the dependencies correctly, since there are a few default placeholder images.
ViroVideo was broken on the ts branch since main hadn't been merged into it 😅 Merging in main and adding the resources folder to dist fixed the issue! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
TODO
Possible TODO Items
Lingering Questions
The following list is things which I was not sure about when I came across them, or were not intuitive types for me to figure out.