feat(filesystem): auto watch git folder for index changes, closes #337

Author: cseickel

lua/neo-tree/sources/filesystem/init.lua

@@ -255,6 +255,7 @@ end
 --wants to change from the defaults. May be empty to accept default values.
 M.setup = function(config, global_config)
   config.filtered_items = config.filtered_items or {}
+  config.enable_git_status = global_config.enable_git_status
 
   local hide_by_name = config.filtered_items.hide_by_name
   if hide_by_name then

lua/neo-tree/sources/filesystem/lib/fs_scan.lua

@@ -202,6 +202,15 @@ M.get_items = function(state, parent_id, path_to_reveal, callback, async, recurs
     end
     --end
 
+    if not parent_id and state.use_libuv_file_watcher and state.enable_git_status then
+      log.trace("Starting .git folder watcher")
+      local path = root.path
+      if root.is_link then
+        path = root.link_to
+      end
+      fs_watch.watch_git_index(path)
+    end
+
     file_items.deep_sort(root.children)
     if parent_id then
       -- lazy loading a child folder
@@ -281,6 +290,7 @@ M.stop_watchers = function(state)
     local loaded_folders = renderer.select_nodes(state.tree, function(node)
       return node.type == "directory" and node.loaded
     end)
+    fs_watch.unwatch_git_index(state.path)
     for _, folder in ipairs(loaded_folders) do
       log.trace("Unwatching folder ", folder.path)
       if folder.is_link then

lua/neo-tree/sources/filesystem/lib/fs_watch.lua

@@ -1,6 +1,8 @@
 local vim = vim
 local events = require("neo-tree.events")
 local log = require("neo-tree.log")
+local git = require("neo-tree.git")
+local utils = require("neo-tree.utils")
 
 local M = {}
 
@@ -20,6 +22,18 @@ local flags = {
 
 local watched = {}
 
+local get_dot_git_folder = function(path)
+  local git_root = git.get_repository_root(path)
+  if git_root then
+    local git_folder = utils.path_join(git_root, ".git")
+    local stat = vim.loop.fs_stat(git_folder)
+    if stat and stat.type == "directory" then
+      return git_folder, git_root
+    end
+  end
+  return nil, nil
+end
+
 M.show_watched = function()
   local items = {}
   for _, handle in pairs(watched) do
@@ -30,11 +44,13 @@ end
 
 ---Watch a directory for changes to it's children. Not recursive.
 ---@param path string The directory to watch.
-M.watch_folder = function(path)
-  if path:find("/%.git$") or path:find("/%.git/") then
-    -- git folders seem to throw off fs events constantly.
-    log.debug("watch_folder(path): Skipping git folder: ", path)
-    return
+M.watch_folder = function(path, git_watch_callback)
+  if not git_watch_callback then
+    if path:find("/%.git$") or path:find("/%.git/") then
+      -- git folders seem to throw off fs events constantly.
+      log.debug("watch_folder(path): Skipping git folder: ", path)
+      return
+    end
   end
   local h = watched[path]
   if h == nil then
@@ -45,13 +61,31 @@ M.watch_folder = function(path)
       path = path,
       references = 1,
     }
-    w:start(path, flags, fs_event_callback)
+    w:start(path, flags, git_watch_callback or fs_event_callback)
   else
     log.trace("Incrementing references for fs watch on: ", path)
     h.references = h.references + 1
   end
 end
 
+M.watch_git_index = function(path)
+  local git_folder, git_root = get_dot_git_folder(path)
+  if git_folder then
+    local git_event_callback = vim.schedule_wrap(function(err, fname)
+      if fname and fname:match("^.+%.lock$") then
+        return
+      end
+      if err then
+        log.error("git_event_callback: ", err)
+        return
+      end
+      events.fire_event(events.GIT_EVENT, { path = fname, repository = git_root })
+    end)
+
+    M.watch_folder(git_folder, git_event_callback)
+  end
+end
+
 ---Stop watching a directory. If there are no more references to the handle,
 ---it will be destroyed. Otherwise, the reference count will be decremented.
 ---@param path string The directory to stop watching.
@@ -72,6 +106,13 @@ M.unwatch_folder = function(path)
   end
 end
 
+M.unwatch_git_index = function(path)
+  local git_folder = get_dot_git_folder(path)
+  if git_folder then
+    M.unwatch_folder(git_folder)
+  end
+end
+
 ---Stop watching all directories. This is the nuclear option and it affects all
 ---sources.
 M.unwatch_all = function()