feat: follow symlinks in dependency graph #76
Merged
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.
What?
This adds a call to
require.resolve
withindependency-graph
, asrequire.resolve
will canonicalize any symlinks within the path, to get the fully qualified path.Why?
This allows us to use symlinks (such as npm link or yarn workspaces) and have the dependency graph resolve to the fully qualified files on disk. Without this change the dependency graph will only read the path, where the linter will lookup and resolve the existing files, and so there becomes a mismatch. Resolving symlinks resolves the mismatch.
We could optionally avoid using
require.resolve
and usefs.readlink
- butfs.readlink
will not canonicalize paths, in other words ifnode_modules/foo
was a symlink thenfs.readlink('node_modules/foo')
would resolve, butfs.readlink('node_modules/foo/bar.js')
would throw (other methods likefs.readFile('node_modules/foo/bar.js')
will resolve as they do canonicalise symlinks).