docs: add note for Babel config #4197
Open
+3
−1
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.
Summary
Update the troubleshooting docs page to include a note that Babel configured with
.babelrc
will not work when trying to compile any part ofnode_modules
, even whentransformIgnorePatterns
is updated. Instead, the Babel config must be renamed tobabel.config.js
. (See Babel docs: https://babeljs.io/docs/configuration#whats-your-use-case)This is not well documented elsewhere, so this could be helpful for folks debugging the fairly common "Cannot use import statement outside a module" error.
Test plan
(n/a, docs update)
Does this PR introduce a breaking change?
Other information
Since this is pretty minor, I just created the PR here, but am happy to open an issue/discussion if preferred! Thank you