Add global fdignore support

[soedirgo]

Rust newbie here :-)

This implements global fdignore support in ~/.config/fd/ignore as mentioned here.

I have some questions:

• I'm using std::env::home_dir() (which is deprecated) instead of using the dirs crate, because this is what the ignore crate does. Which would you prefer?
• I'm not too sure how to handle the tests. If I have, say, * in my ~/.config/fd/ignore, the tests will break. The simplest way I can think of to deal with this is to add a !* using --ignore-file.
• Are there parts of the doc I should change?

[sharkdp]

Rust newbie here :-)

Welcome!

This implements global fdignore support in ~/.config/fd/ignore as mentioned here.

Great!

I'm using std::env::home_dir() (which is deprecated) instead of using the dirs crate, because this is what the ignore crate does. Which would you prefer?

I prefer using the same solution that we have for bat: follow the XDG standard, i.e. use $XDG_CONFIG_HOME, if available. Otherwise, fall back to OS-specific standard directories. On macOS, use ~/.config/fd as well (not what dirs suggests). We could copy some code from bat. We don't need the get_cache_dir part.

I'm not too sure how to handle the tests. If I have, say, * in my ~/.config/fd/ignore, the tests will break. The simplest way I can think of to deal with this is to add a !* using --ignore-file.

I think we definitely need a cleaner solution for that. We could add a --no-global-ignore-file command-line option (can be hidden from the help text) that we would always pass to fd when performing the integration tests.

Are there parts of the doc I should change?

That would be great, yes. This could be mentioned in the README and/or the man page.

[sharkdp]

I guess it works on Windows as well, but maybe just use .join("fd").join("ignore").

[soedirgo]

Got it 👍.

[soedirgo]

Thanks for the review!

I changed the global ignore file's behavior so that it gets ignored with -I. I think it should behave like --ignore-files, but -I should ignore anything that isn't explicit (i.e. --ignore-files).

[sharkdp]

Thank you for the updates.

Two things:

First, could we please make the documentation less Unix-specific? (i.e. paths like ~/.config/fd/ignore)

Second, I know this will be hard to add to integration tests. But could you please show a list of tests that you have performed locally to make sure that this works as intended? In particular, I'm thinking about

• Main functionality. Does it work with globs like *.txt and absolute paths like /sys?
• Prioritization of different ignore files
• What happens if invalid patterns are in the global ignore file?
• Interplay with --no-ignore and --unrestricted
• Interplay with --no-ignore-vcs (files from global ignore file should still be ignored)

[soedirgo]

First, could we please make the documentation less Unix-specific? (i.e. paths like ~/.config/fd/ignore)

Updated.

Second, I know this will be hard to add to integration tests. But could you please show a list of tests that you have performed locally to make sure that this works as intended?

• Functionality is like --ignore-files, i.e. it works with globs, but absolute paths are matched such that the root is the working directory.
• From what I can see, priority is fd/ignore < --ignore-files < .gitignore < .ignore < .fdignore.
• Invalid patterns will print an error and ignore the pattern, but other patterns will still be matched.
• --no-ignore and --unrestricted ignores the global ignore file.
• --no-ignore-vsc has no effect.

[sharkdp]

Thank you very much for the updates!

[sharkdp]

Released in fd 8.1.0