Skip to content
This repository has been archived by the owner on Sep 26, 2024. It is now read-only.

Migrating to TypeScript #205

Open
barrymichaeldoyle opened this issue Sep 7, 2023 · 0 comments
Open

Migrating to TypeScript #205

barrymichaeldoyle opened this issue Sep 7, 2023 · 0 comments

Comments

@barrymichaeldoyle
Copy link

Hello maintainers,

I have been working with the codebase and noticed that the API documentation for the components is currently generated using PropTypes. While PropTypes has served us well, I believe we can enhance the developer experience and potentially catch type errors more efficiently by migrating to TypeScript.

Here are a few benefits that we can obtain from this migration:

  1. Stronger Type Checking - TypeScript offers a robust type-checking system which can help catch type errors during development rather than runtime, promoting code reliability.
  2. Improved Developer Experience - Leveraging TypeScript can enhance auto-completion, and type checking features in various IDEs, which can be a boon for developers.
  3. Better Documentation - With TypeScript, we can utilize tools like TypeDoc to generate detailed API documentation automatically, improving the ease of use for end developers.

I understand that this migration can be a significant change. However, I am more than willing to allocate some of my weekends to initiate this process and perhaps carry out the migration incrementally to lessen the burden on the team. Before proceeding, I'd like to hear your thoughts on this and whether you see potential value in transitioning to TypeScript.

Thank you for considering this enhancement, and I look forward to hearing from you.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant