feat(watcher): add filesystem_watchers.ignore_dirs

[alex-courtis]

#1606

Add filesystem_watchers.ignore_dirs.

Tested:

• exact path
• trailing directory
• project directory
• escaped specials like \\.

[alex-courtis]

@yehuohan

I would be very grateful if you could test:

cd /path/to/nvim-tree.lua
git pull
git checkout 1606-watchers-ignore-dir

• disable git integration
• no ignore (bad behaviour)
• ignore_dirs = { "CMakeFiles" } (good behaviour)

[yehuohan]

@alex-courtis Sorry for late test until this weekend.

With ignore_dirs parameter, there is no large memory consumption anymore to build with cmake.

Attach the complete test configuration for nvim here:

let $DotVimDir=resolve(expand('<sfile>:p:h'))
set rtp^=$DotVimDir
call plug#begin($DotVimDir.'/bundle')
    Plug 'kyazdani42/nvim-tree.lua'
call plug#end()

lua << EOF
    local tcb = require('nvim-tree.config').nvim_tree_callback
    require('nvim-tree').setup{
        auto_reload_on_write = false,
        log = {
          enable = true,
          truncate = true,
          types = {
            all = false,
            config = false,
            copy_paste = false,
            dev = false,
            diagnostics = false,
            git = true,
            profile = true,
            watcher = true,
          },
        },
        filesystem_watchers = {
            enable = true,
            ignore_dirs = { "CMakeFiles" },
        },
        diagnostics = { enable = false },
        git = { enable = false },
    }
EOF

By the way, does this PR has the feature tear down watcher on failure, notifying the user once?
It seemed the watcher wasn't torn down and nvim got into non-response at the final from large memory consumption when testing without the ignore_dirs parameter.

[alex-courtis]

Many thanks for all your testing @yehuohan

By the way, does this PR has the feature tear down watcher on failure, notifying the user once?
It seemed the watcher wasn't torn down and nvim got into non-response at the final from large memory consumption when testing without the ignore_dirs parameter.

There was a bug with the message on teardown: #1726 which prevented the actual teardown.

Perhaps that was the cause of the unnecessary memory usage. I would be very grateful if you pull latest and try again.

[yehuohan]

@alex-courtis

I tested with the latest nvim-tree.lua without ignore_dirs. There is no large memory consumption and the permission message is displayed. Great!

[alex-courtis]

I tested with the latest nvim-tree.lua without ignore_dirs. There is no large memory consumption and the permission message is displayed. Great!

Fantastic! Many thanks.