Ignore symlinks and hidden (dot) files during --recursive.
#644
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
allevato
force-pushed
the
no-dot-files
branch
from
5cbf37f to
410ba4b
Compare
dylansturg
approved these changes
Oct 2, 2023
| case .directory: | ||
| dirIterator = FileManager.default.enumerator( | ||
| at: next, | ||
| includingPropertiesForKeys: nil, |
There was a problem hiding this comment.
You could prefetch the fileResourceTypeKey here. I'm not sure how much it'll speed up the iteration, but I think it'll combine the later look-up into whenever the iterator does file IO.
There was a problem hiding this comment.
Unfortunately it looks like the whole URL.resourceValues API is busted on Linux. Switched over to FileManager.attributesOfItem, which doesn't have the issue (but also doesn't benefit from pre-fetching).
Note that hidden files will *always* be honored if they are specified explicitly among the paths on the command line. Symlinks encountered during recursive traversal *or* passed on the command line will only be followed if the flag `--follow-symlinks` is passed. This is meant to avoid symlinks being hidden by shell expansions; for example, running `swift-format *` where the current directory contains a symlink and following that symlink might be surprising to users. This PR also adds a new test target for code in the `swift-format` binary in order to test `FileIterator` without factoring the binary's code out to a separate library target. We should use this in the future to expand coverage of other functionality like the frontends and commands.
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.
Note that hidden files will always be honored if they are specified explicitly among the paths on the command line. Symlinks encountered during recursive traversal or passed on the command line will only be followed if the flag
--follow-symlinksis passed. This is meant to avoid symlinks being hidden by shell expansions; for example, runningswift-format *where the current directory contains a symlink and following that symlink might be surprising to users.This PR also adds a new test target for code in the
swift-formatbinary in order to testFileIteratorwithout factoring the binary's code out to a separate library target. We should use this in the future to expand coverage of other functionality like the frontends and commands.Fixes #643.