brainly/style-guide

Improve typechecking when working in MDX stories

coderitual opened this issue · 0 comments

Currently, when working with MDX stories in our project, we have noticed that typechecking is not as robust as we would like it to be. This can lead to potential bugs and errors down the line, which we want to avoid.

Following options are considered

  • Update the TypeScript configuration to include stricter type checking rules for MDX files.
  • Enabling vscode plugin for MDX and upgrading MDX to ver 2
  • Improve the documentation for how to work with MDX stories and ensure that developers are aware of the importance of typechecking.
  • If all above fail, we can try MDX-flavoured embedded stories

CleanShot 2023-03-08 at 14 11 57