Docs: Fix stale symlink rationale in local development guide - #1904
Draft
robhogan wants to merge 1 commit into
Draft
Docs: Fix stale symlink rationale in local development guide#1904robhogan wants to merge 1 commit into
robhogan wants to merge 1 commit into
Conversation
Summary: The local development guide tells you to configure `watchFolders` "as it will not automatically follow the symlinks". Metro does follow symlinks, and has for some time - `metro-file-map` is constructed with `enableSymlinks: true` unconditionally, and there's no longer a config option to turn it off: https://github.com/react/metro/blob/v0.87.0/packages/metro/src/node-haste/DependencyGraph/createFileMap.js#L106 The step itself is still needed, but the reason is that a symlink's target must itself be under `projectRoot` or `watchFolders` to be resolvable, which is how it's already put under [`watchFolders`](https://metrobundler.dev/docs/configuration/#watchfolders). Worth fixing because the old wording sends anyone debugging a half-working `yarn link`ed package after the wrong thing - looking for a way to make Metro follow the link, rather than checking whether its target is watched. That's the same root cause as the `SHA-1 for file ... is not computed` reports. Changelog: [Internal] Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
meta-cla
Bot
added
the
CLA Signed
robhogan
marked this pull request as draft
September 5, 2026 22:24
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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:
The local development guide tells you to configure
watchFolders"as it will not automatically follow the symlinks". Metro does follow symlinks, the requirement is that the symlink's target must itself be underprojectRootorwatchFoldersto be resolvable, which is how it's already put under [watchFolders](https://metrobundler.dev/docs/configuration/#watchfoldersChangelog: Internal