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

[draft] migrate react-docgen to v6 #45028

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

alexfauquette
Copy link
Member

This is the temptative to bump react-docgen.

The version bump has nice benefits:

  • The library is now using typescript, allowing to drop our own typing of the lib
  • They now support typescript

I did not managed to make the script fully run from start to end. But while working on it, I've seen some concerning issues on their github, like Missing support for Pick<> and Omit<>. And I'm not sure about how active the community is about maintaining the lib.

The alternative could be to use TSDocs

mui/mui-x#15836

Next step

I will do a comparison of what is accessible form react-docgen and TSDocs to test is they both provide the same content, or if one is "better" than the other

@alexfauquette alexfauquette marked this pull request as draft January 15, 2025 13:20
@mui-bot
Copy link

mui-bot commented Jan 15, 2025

Netlify deploy preview

https://deploy-preview-45028--material-ui.netlify.app/

Bundle size report

No bundle size changes (Toolpad)
No bundle size changes

Generated by 🚫 dangerJS against d6ead82

@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Jan 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR: out-of-date The pull request has merge conflicts and can't be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants