fix(gatsby): Add FAST_REFRESH config flag
#28409
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
LekoArts
added
topic: hot reloading*
and removed
status: triage needed
pieh
reviewed
Dec 1, 2020
KyleAMathews
previously approved these changes
Dec 1, 2020
pieh
reviewed
Dec 1, 2020
Comment on lines
8
to
+11
| if (process.env.GATSBY_HOT_LOADER) return process.env.GATSBY_HOT_LOADER | ||
|
|
||
| // If the config flag is true, return fast-refresh | ||
| if (process.env.GATSBY_FAST_REFRESH) return `fast-refresh` |
There was a problem hiding this comment.
This order of conditions has confusing impact on terminal output when user adds FAST_REFRESH to config flags, but still use GATSBY_HOT_LOADER=react-hot-loader:
➜ gatsby-starter-blog git:(master) ✗ GATSBY_HOT_LOADER=react-hot-lodear gatsby develop
info The following flags are active:
- FAST_REFRESH · (Umbrella Issue (https://github.com/gatsbyjs/gatsby/discussions/28390)) · Use React Fast Refresh instead of the legacy react-hot-loader for instantaneous feedback in your development
server. Recommended for versions of React >= 17.0.
but in the end react-hot-loader will be used because this code as-is prefers it
It's tricky because it feels like env vars should have priority over config (same as cli toggles over any config in file). So the order now seems correct - just the message is confusing :/
There was a problem hiding this comment.
maybe before we handle flags we need to do some hacky stuff like change
gatsby/packages/gatsby/src/services/initialize.ts
Lines 186 to 187 in 7577e3f
to be something like
if (config && config.flags) {
if(config.flags.?FAST_REFRESH && process.env.GATSBY_HOT_LOADER) {
delete config.flags.FAST_REFRESH
reporter.warn(`Both FAST_REFRESH config flag and GATSBY_HOT_LOADER env var is used. Will use env var`)
}
const availableFlags = require(`../utils/flags`).default
There was a problem hiding this comment.
I like hacky! Well temporarily hacky that we have nice TODOs about fixing but that unblocks us to ship.
…ar is set to something else than fast-refresh
pieh
previously approved these changes
Dec 1, 2020
pieh
approved these changes
Dec 1, 2020
pieh
pushed a commit
that referenced
this pull request
Dec 1, 2020
* add FAST_REFRESH flag * update desc * handle case when FAST_REFRESH flag is set and GATSBY_HOT_LOADER env var is set to something else than fast-refresh Co-authored-by: Michal Piechowiak <[email protected]> (cherry picked from commit ce090e5)
pieh
pushed a commit
that referenced
this pull request
Dec 1, 2020
* add FAST_REFRESH flag * update desc * handle case when FAST_REFRESH flag is set and GATSBY_HOT_LOADER env var is set to something else than fast-refresh Co-authored-by: Michal Piechowiak <[email protected]> (cherry picked from commit ce090e5)
pieh
pushed a commit
that referenced
this pull request
Dec 1, 2020
* add FAST_REFRESH flag * update desc * handle case when FAST_REFRESH flag is set and GATSBY_HOT_LOADER env var is set to something else than fast-refresh Co-authored-by: Michal Piechowiak <[email protected]> (cherry picked from commit ce090e5) Co-authored-by: Lennart <[email protected]>
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
Adds a
FAST_REFRESHconfig flag so that users can more easily enable it. Previously they had to setREACT_HOT_LOADER=fast-refresh(this still works).This PR also adds a small improvement to app.js for reloading.
[ch19923]