fix(#1815): debounce BufEnter find_file

Author: alex-courtis

doc/nvim-tree-lua.txt

@@ -507,6 +507,11 @@ until it finds the file.
     Enable this feature.
       Type: `boolean`, Default: `false`
 
+    *nvim-tree.update_focused_file.debounce_delay*
+    Idle milliseconds between BufEnter and update.
+    The last BufEnter will be focused, others are discarded.
+      Type: `number`, Default: `50` (ms)
+
     *nvim-tree.update_focused_file.update_root*  (previously `update_focused_file.update_cwd`)
     Update the root directory of the tree if the file is not under current
     root directory. It prefers vim's cwd and `root_dirs`.

lua/nvim-tree.lua

@@ -398,7 +398,9 @@ local function setup_autocommands(opts)
   if opts.update_focused_file.enable then
     create_nvim_tree_autocmd("BufEnter", {
       callback = function()
-        find_file(false)
+        utils.debounce("BufEnter:find_file", opts.update_focused_file.debounce_delay, function()
+          find_file(false)
+        end)
       end,
     })
   end
@@ -571,6 +573,7 @@ local DEFAULT_OPTS = { -- BEGIN_DEFAULT_OPTS
   },
   update_focused_file = {
     enable = false,
+    debounce_delay = 50,
     update_root = false,
     ignore_list = {},
   },