Add docs and tests for ignoring .git #1403
Merged
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
marcospb19
reviewed
Oct 22, 2023
doc/fd.1
Outdated
Comment on lines
46
to
47
| is also used. The .git directory is excluded, because that is usually what is wanted if excluding vcs | ||
| ignored files, and is more consistent with the output of most git commands. |
There was a problem hiding this comment.
I usually expect the program behavior to be explained in man pages, but not the reasons behind the behavior/choices. I'd say this is not unnecessary.
marcospb19
reviewed
Oct 22, 2023
tests/tests.rs
Outdated
Comment on lines
2558
to
2580
| /// Test behavior of .git directory with various flags | ||
| #[test] | ||
| fn test_git_dir() { | ||
| let te = TestEnv::new( | ||
| &[".git/one"], | ||
| &[".git/one/foo.a", ".git/.foo", ".git/a.foo"], | ||
| ); | ||
|
|
||
| te.assert_output(&["--hidden", "foo"], ""); | ||
| te.assert_output(&["--no-ignore", "foo"], ""); | ||
| te.assert_output( | ||
| &["--hidden", "--no-ignore", "foo"], | ||
| ".git/one/foo.a | ||
| .git/.foo | ||
| .git/a.foo", | ||
| ); | ||
| te.assert_output( | ||
| &["--hidden", "--no-ignore-vcs", "foo"], | ||
| ".git/one/foo.a | ||
| .git/.foo | ||
| .git/a.foo", | ||
| ); | ||
| } |
There was a problem hiding this comment.
Could you edit this test (or add a new one) to cover this example (or an equivalent one)?
let te = TestEnv::new(
&["path/to/another/repository/.git/file1"],
&["path/to/another/repository/.git/folder/file2"],
&["a_repository/.git/file1"],
&["a_repository/.git/folder/file2"],
...
);Because the current tests only covers .git in the current folder.
marcospb19
approved these changes
Oct 22, 2023
src/cli.rs
Outdated
Comment on lines
67
to
68
| /// ignored by '.gitignore' files or the rule to exclude .git/. | ||
| /// The flag can be overridden with --ignore-vcs. |
There was a problem hiding this comment.
My suggestion:
/// Show search results from '.git/' folders and results that would
/// otherwise be ignored by '.gitignore' rules.
src/cli.rs
Outdated
Comment on lines
51
to
52
| /// ignored by '.gitignore', '.ignore', '.fdignore', the global ignore file, | ||
| /// or the rule to exclude .git/. |
There was a problem hiding this comment.
My suggestion:
Suggested change
| /// ignored by '.gitignore', '.ignore', '.fdignore', the global ignore file, | |
| /// or the rule to exclude .git/. | |
| /// ignored by '.gitignore', '.ignore', '.fdignore', the global ignore file, | |
| /// or the default rule that excludes '.git/'. |
tmccombs
added a commit
to tmccombs/fd
that referenced
this pull request
Apr 28, 2024
tmccombs
added a commit
to tmccombs/fd
that referenced
this pull request
Apr 29, 2024
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.
See #1396.