Is a ~/.ignore (or ~/.fdignore) file always looked at? #485

timkgh · 2019-09-18T16:01:16Z

The README shows the following example:

> cat ~/.fdignore
/mnt/external-drive
*.bak
Note: fd also supports .ignore files that are used by other programs such as rg or ag.

On macOS I tried creating ~/.ignore and also a ~/.fdignore symlinked to ~/.ignore with the following in it as I'm trying to avoid mounted/network file systems when using fd from fzf:

.git
/Volumes
/net
/keybase

The expectation based on the README example if I just cd / && fd -t d keybase is to not return /keybase or /Volumes/Keybase but they are returned which makes me think that ~/.ignore or ~/.fdignore are not looked at.
If I'm explicit about using the ignore file fd --ignore-file ~/.ignore -t d keybase then it seems to work.

Not sure if this is a bug or expected behavior. It is very hard to tell as there's no documentation that lists the expected behavior, it's all very confusing.

I understand there have been a lot of discussions around ignore, it may be worth having a table of expected behavior then people can work from there when reporting issues.

sharkdp · 2019-09-18T20:24:44Z

Thank you for the feedback.

The README example is just wrong (or at least very misleading) and should be changed. A .fdignore or .ignore file will always just affect directories below it (just like .gitignore files). Putting /mnt/external-drive in .fdignore would therefore only ignore files in ~/mnt/external-drive (which is not what was originally intended with this example).

Not sure if this is a bug or expected behavior. It is very hard to tell as there's no documentation that lists the expected behavior, it's all very confusing.

Yes, it can be very confusing. The behavior is quite complex, but it is very well thought out (this is all part of the ignore crate/library which was designed for ripgrep). In principle, it is documented here: https://docs.rs/ignore/0.4.10/ignore/struct.WalkBuilder.html#ignore-rules

Here is how we set up the WalkBuilder in fd:

fd/src/walk.rs

Lines 71 to 103 in 59c27ba

    
           let mut walker = WalkBuilder::new(first_path_buf.as_path()); 
        
           walker 
        
               .hidden(config.ignore_hidden) 
        
               .ignore(config.read_fdignore) 
        
               .parents(config.read_fdignore || config.read_vcsignore) 
        
               .git_ignore(config.read_vcsignore) 
        
               .git_global(config.read_vcsignore) 
        
               .git_exclude(config.read_vcsignore) 
        
               .overrides(overrides) 
        
               .follow_links(config.follow_links) 
        
               .max_depth(config.max_depth); 
        
           if config.read_fdignore { 
        
               walker.add_custom_ignore_filename(".fdignore"); 
        
           } 
        
           for ignore_file in &config.ignore_files { 
        
               let result = walker.add_ignore(ignore_file); 
        
               match result { 
        
                   Some(ignore::Error::Partial(_)) => (), 
        
                   Some(err) => { 
        
                       print_error!( 
        
                           "{}", 
        
                           format!( 
        
                               "Malformed pattern in custom ignore file '{}': {}.", 
        
                               ignore_file.to_string_lossy(), 
        
                               err.description() 
        
                           ) 
        
                       ); 
        
                   } 
        
                   None => (), 
        
               } 
        
           }

If someone want's to spend some time to properly document this, it would be very appreciated.

timkgh · 2019-09-18T21:10:59Z

OK, this helps, thank you. There is no way to have a global ignore file like ~/.gitignore_global for git.

What is the alternative? alias fd='fd --ignore-file ~/.fdignore_global ...'? If that's the answer, it would help to support a ~/.fd.conf file where default flags could be set for all apps that may be calling fd (like fzf), rather than an alias which only works in the shell.

sharkdp · 2019-09-18T21:13:53Z

We could also think about adding such a global .fdignore file. Maybe something like ~/.config/fd/ignore in analogy to ~/.config/git/ignore.

timkgh · 2019-09-18T21:25:54Z

Ah, right. ~/.gitignore_global is not a built-in git thing, it has to be configured git config --global core.excludesfile ~/.gitignore_global It's in so many articles you start believing it is.

timkgh · 2019-09-18T21:56:42Z

Maybe something like ~/.config/fd/ignore

Along the same lines, would you consider a ~/.config/fd/config (or defaults) for flags one may always want?

kontrafiktion · 2019-12-07T13:47:51Z

ah yes, I would have assumed that "git-ignored folders" would include my global "gitignore" file.

And the code:

.git_global(config.read_vcsignore)

looks like it could be supported

kontrafiktion · 2019-12-07T13:53:37Z

Ah, the directory that produced the unexpected result did not contain a .git directory. When I added that, the git-global ignore did work. Interesting.

robertfoss · 2020-01-19T02:30:21Z

We could also think about adding such a global .fdignore file. Maybe something like ~/.config/fd/ignore in analogy to ~/.config/git/ignore.

RigGrep supports a ~/.rgignore file for global ignores, and it is super handy.

MarcinWieczorek · 2020-04-01T10:41:12Z

I'd love to see that feature, is there any progress?

sharkdp · 2020-04-01T12:29:59Z

I don't think so. This should be rather easy to implement, though.

sharkdp · 2020-05-18T19:21:56Z

Implemented in #575 by @soedirgo.

Along the same lines, would you consider a ~/.config/fd/config (or defaults) for flags one may always want?

See #362

sharkdp added documentation help wanted labels Sep 18, 2019

kontrafiktion mentioned this issue Dec 7, 2019

fd-485: Clarified usage of ignore-files #517

Closed

sharkdp added the good first issue label Apr 1, 2020

sharkdp mentioned this issue Apr 10, 2020

Add -1 option as an alias for --max-results=1 #561

Closed

soedirgo mentioned this issue Apr 22, 2020

Add global fdignore support #575

Merged

sharkdp closed this May 18, 2020

sharkdp added this to the 8.1 milestone May 19, 2020

sharkdp / fd

Is a ~/.ignore (or ~/.fdignore) file always looked at? #485

Is a ~/.ignore (or ~/.fdignore) file always looked at? #485

timkgh commented Sep 18, 2019

sharkdp commented Sep 18, 2019

timkgh commented Sep 18, 2019 •

edited

sharkdp commented Sep 18, 2019

timkgh commented Sep 18, 2019

timkgh commented Sep 18, 2019

kontrafiktion commented Dec 7, 2019

kontrafiktion commented Dec 7, 2019 •

edited

robertfoss commented Jan 19, 2020

MarcinWieczorek commented Apr 1, 2020

sharkdp commented Apr 1, 2020

sharkdp commented May 18, 2020

sharkdp / fd

Sponsor sharkdp/fd

Join GitHub today

Is a ~/.ignore (or ~/.fdignore) file always looked at? #485

Is a ~/.ignore (or ~/.fdignore) file always looked at? #485

Comments

timkgh commented Sep 18, 2019

sharkdp commented Sep 18, 2019

timkgh commented Sep 18, 2019 • edited

sharkdp commented Sep 18, 2019

timkgh commented Sep 18, 2019

timkgh commented Sep 18, 2019

kontrafiktion commented Dec 7, 2019

kontrafiktion commented Dec 7, 2019 • edited

robertfoss commented Jan 19, 2020

MarcinWieczorek commented Apr 1, 2020

sharkdp commented Apr 1, 2020

sharkdp commented May 18, 2020

Essential cookies

Always active

Analytics cookies

timkgh commented Sep 18, 2019 •

edited

kontrafiktion commented Dec 7, 2019 •

edited