brainly / brainly/style-guide

Improve typechecking when working in MDX stories

Open
#2,687 0 comments 0 reactions 0 assignees View on GitHub
Type: Enhancement
Dominant language
TypeScript
Stars
165
Forks
31
PR merge metrics
No merged PRs in 30d

Description

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](https://user-images.githubusercontent.com/8572321/223721993-ec6e0dc8-62e2-45f8-9bb3-5274292adf10.png)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.