fix(gatsby-plugin-mdx): enable hmr when importing mdx #31288
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gatsbot
bot
added
the
status: triage needed
pieh
added
topic: hot reloading
and removed
status: triage needed
pieh
commented
May 7, 2021
pieh
commented
May 10, 2021
vladar
previously approved these changes
May 11, 2021
vladar
pushed a commit
that referenced
this pull request
May 11, 2021
* save MDXContent to different file * tmp: skip mdx loader unit tests * test(e2e-mdx): upgrade cypress, setup running dev * test(e2e-mdx): add hmr test case * only apply hmr workaround to develop stage * don't save mdx component to fs, use webpack tricks with query params * wait for hmr in mdx/develop * drop passthrough fs location * revert unneeded change * more reverts * revert devtool debugging change * adjust unit tests * add more e2e test - editing prop in markdown, editing component imported by mdx (cherry picked from commit c8db78f)
This was referenced Mar 14, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Currently HMR with fast-refresh doesn't work with mdx files. The reason is that mdx loader generate modules with 2 exports (
MDXContentthat is actual react component andfrontmatter) which doesn't satisfy restrictions of fast refresh for there to be single export.This is workaround preserving current frontmatter export (no breaking changes) by moving
MDXContentcomponent to different file (which will allow to refresh it).This workaround mimics https://github.com/vuejs/vue-loader and creates separate module for
MDXcomponent (by importing same file with?type=componentquery param) which allow fast-refresh webpack plugin to attach HMR handler for module that exports justMDXConentcomponentRelated Issues
fixes #30062
[ch28635]