fix: treefmt . no longer segfaults if . is root and symlink
#595
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
In short, the old code would massage the given paths to relative paths (in the `resolvePaths` function I removed). It operated under an impossible-to-satisfy requirement: to return relative paths that when joined with the project root would create paths to regular files/folders (*not* symlinks). This is possible for all paths except `.`: if your project root is a symlink, then `join(root, ".") == root`, which is still a symlink. Rather than try to fix that flawed assumption, I opted to refactor things. I think that was the right call: excluding the tests I added, this is a net reduction in code! Basically, I moved moved `resolvePath` into `walk.go`, and interleaved the remaining `resolvePaths` logic into `walk.go::NewCompositeReader`. A happy side effect of this is that we no longer have 2 functions with very similar names (`resolvePaths` and `resolvePath`) that do different things. This fixes numtide#594
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.
In short, the old code would massage the given paths to relative paths (in the
resolvePathsfunction I removed). It operated under an impossible-to-satisfy requirement: to return relative paths that when joined with the project root would create paths to regular files/folders (not symlinks). This is possible for all paths except.: if your project root is a symlink, thenjoin(root, ".") == root, which is still a symlink.Rather than try to fix that flawed assumption, I opted to refactor things. I think that was the right call: excluding the tests I added, this is a net reduction in code!
Basically, I moved moved
resolvePathintowalk.go, and interleaved the remainingresolvePathslogic intowalk.go::NewCompositeReader. A happy side effect of this is that we no longer have 2 functions with very similar names (resolvePathsandresolvePath) that do different things.This fixes #594