-
Notifications
You must be signed in to change notification settings - Fork 14
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
Convert JS to TypeScript #57
Comments
The methodical conversion to TypeScript should be done as we implement the new modular packages described in #58. To ensure best practices and solidarity in code styling, we will use a combination of ESLint, Prettier, and Husky in our TypeScript configuration. Configurationtsconfig.jsonThis is the file where we define the rules for our TypeScript project. For best practices, it is recommended to be as strict as possible with the rules. Strict rules may lead to more "development" time, but will save time in the long run by catching possible errors as soon as possible. ESLintESLint statically analyzes your code to quickly find problems. ESLint is built into most text editors and you can run ESLint as part of your continuous integration pipeline. Many problems ESLint finds can be automatically fixed. ESLint fixes are syntax-aware so you won't experience errors introduced by traditional find-and-replace algorithms. Preprocess code, use custom parsers, and write your own rules that work alongside ESLint's built-in rules. You can customize ESLint to work exactly the way you need it for your project. We will use this in the ZEBRA project to find errors in our TypeScript code before it is run. It will also be configured with Prettier to enforce consistent code styling on save. PrettierThis is an opinionated code formatter that supports many languages, integrates with most editors, and has few options HuskyThis command interface can be used to lint your commit messages, run tests, lint code, etc... when you commit or push. This adds another layer of CI/CD on the client side to ensure that the code is safe and good to go before even reaching GitHub. Goals
|
@behives I would like contribute for this migration and starting work with migrating some files |
I'd like to work on this migration work. |
Sure will post here |
@jsanter27 please add high level description and specific target for 22PI1 here....thank you!
The text was updated successfully, but these errors were encountered: