docs(devTools): Clarify node env logic for devtools #2711
Merged
Conversation
This file contains hidden or 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
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/tannerlinsley/react-query/4u7GEAseDk5uBwK6vsMZumpqfKEf |
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 2ed944f:
|
citypaul
force-pushed
the
devtools-docs-node-env
branch
from
5596825 to
3c20b26
Compare
Clarify node env logic for devTools to make it clear that the environment should be set to 'development'
citypaul
force-pushed
the
devtools-docs-node-env
branch
from
3c20b26 to
2ed944f
Compare
Member
|
🎉 This PR is included in version 3.24.5 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
I was struggling to understand why the devTools were not rendering in our application. The docs currently state that if
process.env.NODE_ENV === 'production', they will not be included in the build.However, this is misleading, because the actual logic as you can see here is to only include the devTools if
process.env.NODE_ENV === 'development'.In the app I was working on, during development, our
NODE_ENVwas actually set todev. While I understand it's a convention in the node world to useprocess.env.NODE_ENV === 'development', for whatever reason this app was setup slightly differently, and the docs were somewhat misleading here. Hopefully this should prevent someone else from experiencing the same confusion.