-
Notifications
You must be signed in to change notification settings - Fork 75
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
Replace xdm with MDX v2 #152
Conversation
BREAKING CHANGE: as part of replacing xdm with MDX v2 `xdmOptions` has been renamed to `mdxOptions`.
Resolves #159 When can we expect a release of this Fix/Version bump? |
I think Kent instantly regretted saying this 🤣 😜 |
Running this branch locally and the tests are hanging on coverage, do you get the same thing? I'm happy to rename |
I'd also suggest that we implement the relatively minor #167 in this PR as well so its a single breaking change release. @silvenon I have an uncomitted version of this PR with those changes made if that works for you? Same question to @kentcdodds |
I did not run the tests, I wanted to defer to the CI 😅 It's indeed hanging on the coverage part for me too, but I'm experiencing the same problem on
Absolutely! |
Codecov Report
@@ Coverage Diff @@
## main #152 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 3 3
Lines 280 280
Branches 1 1
=========================================
Hits 280 280
Continue to review full report at Codecov.
|
Looks like we're good to roll here! Will merge this as a breaking change. Thanks so much! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! 👏👏
Awesome! Many thanks for reviewing this ❤️ |
🎉 This PR is included in version 9.0.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
What: xdm is being replaced with MDX v2. The breaking change is that
xdmOptions
has been renamed tomdxOptions
.Why: xdm was created before MDX v2 as a project that contains everything that Titus, the core maintainer of MDX, wanted to have in MDX. With the release of MDX v2 the projects are now "99.99% the same", and Titus will retire xdm.
How: it was enough to replace xdm with
@mdx-js/esbuild
, it even exports theProcessorOptions
needed intypes.d.ts
, so there was no need to install@mdx-js/mdx
as well. The documentation was updated in the way that made sense to me. The only uncomfortable change is renamingxdmOptions
tomdxOptions
, but I believe it's necessary.Checklist:
Resolves #137, #159.