A way to disable git integration on certain paths

[henry-hsieh]

When I'm in a root path containing hundreds subfolders which are not git projects, open another file in the root path will make the nvim-tree search every subfolder to check whether it's a git project. The opts.git.disable_for_dirs and opts.filesystem_watchers.ignore_dirs have nothing to do with this situation because of calling git.utils.get_toplevel hundreds times still costing a lot of time, especially for slow filesystems such as NFS.

It's nice if opts.git.enable can accept a function similar to opts.filesystem_watchers.ignore_dirs that can disable git for certain matched regex paths. But I wonder whether there is another way to change the option of nvim-tree before I called NvimTreeOpen or NvimTreeToggle. Then I can do the path filter by my own.

Thanks!

[alex-courtis]

See discussion on toplevel here #3171 . It should not be called repeatedly, with the results cached instead.

opts.git.disable_for_dirs does take an exact relative string or function (I use a function) but not a regex, whereas filesystem_watchers.ignore_dirs can use a vim.fn.match regex.

Regardless of toplevel performance issues, this would be a valuable feature. Please raise a feature request so that we may schedule this work.

As usual, pull requests are most gratefully appreciated, see

• CONTRIBUTING.md
• Wiki: Development

[henry-hsieh]

I can confirm that when I open a file from node, it will trigger reload. And then a series of searching top-level git_dirs for subfolders starts. That's why I experience slow during opening files.

I think the path is: directory node (node/directory.lua) > watcher (explorer/watch.lua) > refresh dir (git/init.lua) > get toplevel (git/init.lua) > get toplevel (git/utils.lua)

The cached toplevel path seems not working. Otherwise, the git_utils.get_toplevel should not be called.

I'm using nvim-tree v1.11. It seems there is no change related to the cache mechanism of newer versions.

Edit: This issue has the same conclusion of #3171. I'm thinking extend git.disable_for_dirs alongside git.enable checking. This may better than changing git.enable could accept the function because not every case using git.enable would have path.

[alex-courtis]

I'm thinking extend git.disable_for_dirs alongside git.enable checking. This may better than changing git.enable could accept the function because not every case using git.enable would have path.

Yes please. I will definitely use it, as my function is not elegant.

[henry-hsieh]

I'm thinking extend git.disable_for_dirs alongside git.enable checking. This may better than changing git.enable could accept the function because not every case using git.enable would have path.

I have a few thought of the implementation. The difficult part is the definition of git.disable_for_dirs:

*nvim-tree.git.disable_for_dirs*
Disable git integration when git top-level matches these paths.
Strings may be relative, evaluated via |fnamemodify| `":p"`
Function is passed an absolute path and returns true for disable.
  Type: `string[] | fun(path: string): boolean`, Default: `{}`

The table is used to disable git integration when git top-level matches any string inside table. However, searching git top-level is the culprit of making nvim-tree slow, at least before the fix of #3185. If the fix is going to be merged into master, the job of the disable_for_dirs will be reducing the cache size as much as possible. Therefore, I'm proposing that we changed the option to: List of vim regex for absolute directory paths that will not be looked up for git projects, or a function returning whether a path should be ignored. The option can have an new name ignore_dirs just like filesystem_watchers.ignore_dirs. And we deprecate the old option name.

[alex-courtis]

@przepompownia and @henry-hsieh I'd be most grateful if you thoroughly tested this fix branch #3185 which caches git toplevel for untracked directories.

cd /path/to/nvim-tree.lua
git pull
git checkout 3171

When you're finished testing:

git checkout master