Skip to content
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

Improve type-safety: automate generation of API-related TypeScript types #3332

Open
Tracked by #3338
brojd opened this issue Nov 13, 2023 · 0 comments
Open
Tracked by #3338

Comments

@brojd
Copy link
Contributor

brojd commented Nov 13, 2023

Problem

Problem and context are described in #3330 .

This issue is about step 3):
Automate generation of types (e.g. on prepush Git hook or similar). This way if changes in API breaks frontend, frontend build will automatically fail preventing us from introducing the bug

Acceptance criteria

  • anytime Python models are changed, API-related TypeScript types are regenerated and saved in grafana-plugin directory

Outcome

  • better type-safety in code
  • being able to catch type errors during development before they reach prod (shift left)
  • better developer experience thanks to increased number of type declarations and improved intellisense
@brojd brojd changed the title Improve type-safety: Automate generation of API-related TypeScript types Improve type-safety: automate generation of API-related TypeScript types Nov 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants