feat: add highlight open files option (#838)

Author: nhat-vo

lua/neo-tree/defaults.lua

@@ -19,6 +19,7 @@ local config = {
   enable_diagnostics = true,
   enable_git_status = true,
   enable_modified_markers = true, -- Show markers for files with unsaved changes.
+  enable_opened_markers = true,   -- Enable tracking of opened files. Required for `components.name.highlight_opened_files`
   enable_refresh_on_write = true, -- Refresh the tree when a file is written. Only used if `use_libuv_file_watcher` is false.
   git_status_async = true,
   -- These options are for people with VERY large git repos
@@ -210,6 +211,7 @@ local config = {
     },
     name = {
       trailing_slash = false,
+      highlight_opened_files = false, -- Requires `enable_opened_markers = true`
       use_git_status_colors = true,
       highlight = "NeoTreeFileName",
     },

lua/neo-tree/setup/init.lua

@@ -47,18 +47,24 @@ local define_events = function()
 
   events.define_autocmd_event(events.VIM_BUFFER_CHANGED, { "BufWritePost", "BufFilePost" }, 200)
 
+  local update_opened_buffers = function(args)
+    args.opened_buffers = utils.get_opened_buffers()
+    return args
+  end
   events.define_autocmd_event(
     events.VIM_BUFFER_MODIFIED_SET,
     { "BufModifiedSet" },
     0,
-    function(args)
-      args.modified_buffers = utils.get_modified_buffers()
-      return args
-    end
+    update_opened_buffers
   )
 
-  events.define_autocmd_event(events.VIM_BUFFER_ADDED, { "BufAdd" }, 200)
-  events.define_autocmd_event(events.VIM_BUFFER_DELETED, { "BufDelete" }, 200)
+  events.define_autocmd_event(events.VIM_BUFFER_ADDED, { "BufAdd" }, 200, update_opened_buffers)
+  events.define_autocmd_event(
+    events.VIM_BUFFER_DELETED,
+    { "BufDelete" },
+    200,
+    update_opened_buffers
+  )
   events.define_autocmd_event(events.VIM_BUFFER_ENTER, { "BufEnter", "BufWinEnter" }, 0)
 
   events.define_autocmd_event(events.VIM_TERMINAL_ENTER, { "TermEnter" }, 0)
@@ -278,10 +284,10 @@ M.win_enter_event = function()
         if state == nil then
           return
         end
-        local mod = utils.get_modified_buffers()
+        local mod = utils.get_opened_buffers()
         log.debug("close_if_last_window, modified files found: ", vim.inspect(mod))
-        for filename, is_modified in pairs(mod) do
-          if is_modified then
+        for filename, buf_info in pairs(mod) do
+          if buf_info.modified then
             if vim.startswith(filename, "[No Name]#") then
               bufnr = string.sub(filename, 11)
               log.trace("close_if_last_window, showing unnamed modified buffer: ", filename)

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

@@ -59,7 +59,7 @@ local buffers_changed_internal = function()
   for _, tabnr in ipairs(vim.api.nvim_list_tabpages()) do
     local state = manager.get_state(M.name, tabnr)
     if state.path and renderer.window_exists(state) then
-      items.get_open_buffers(state)
+      items.get_opened_buffers(state)
       if state.follow_current_file then
         follow_internal()
       end
@@ -93,7 +93,7 @@ M.navigate = function(state, path, path_to_reveal)
     renderer.position.set(state, path_to_reveal)
   end
 
-  items.get_open_buffers(state)
+  items.get_opened_buffers(state)
 
   if path_changed and state.bind_to_cwd then
     vim.api.nvim_command("tcd " .. path)
@@ -168,7 +168,7 @@ M.setup = function(config, global_config)
   if global_config.enable_modified_markers then
     manager.subscribe(M.name, {
       event = events.VIM_BUFFER_MODIFIED_SET,
-      handler = wrap(manager.modified_buffers_changed),
+      handler = wrap(manager.opened_buffers_changed),
     })
   end
 

lua/neo-tree/sources/buffers/lib/items.lua

@@ -8,7 +8,7 @@ local M = {}
 
 ---Get a table of all open buffers, along with all parent paths of those buffers.
 ---The paths are the keys of the table, and all the values are 'true'.
-M.get_open_buffers = function(state)
+M.get_opened_buffers = function(state)
   if state.loading then
     return
   end

lua/neo-tree/sources/common/components.lua

@@ -292,9 +292,10 @@ M.icon = function(config, node, state)
 end
 
 M.modified = function(config, node, state)
-  local modified_buffers = state.modified_buffers or {}
+  local opened_buffers = state.opened_buffers or {}
+  local buf_info = opened_buffers[node.path]
 
-  if modified_buffers[node.path] then
+  if buf_info and buf_info.modified then
     return {
       text = (make_two_char(config.symbol) or "[+] "),
       highlight = config.highlight or highlights.MODIFIED,
@@ -327,6 +328,13 @@ M.name = function(config, node, state)
     end
   end
 
+  if config.highlight_opened_files then
+    local opened_buffers = state.opened_buffers or {}
+    if opened_buffers[node.path] ~= nil then
+      highlight = highlights.FILE_NAME_OPENED
+    end
+  end
+
   if type(config.right_padding) == "number" then
     if config.right_padding > 0 then
       text = text .. string.rep(" ", config.right_padding)

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

@@ -365,10 +365,19 @@ M.setup = function(config, global_config)
   if global_config.enable_modified_markers then
     manager.subscribe(M.name, {
       event = events.VIM_BUFFER_MODIFIED_SET,
-      handler = wrap(manager.modified_buffers_changed),
+      handler = wrap(manager.opened_buffers_changed),
     })
   end
 
+  if global_config.enable_opened_markers then
+    for _, event in ipairs({ events.VIM_BUFFER_ADDED, events.VIM_BUFFER_DELETED }) do
+      manager.subscribe(M.name, {
+        event = event,
+        handler = wrap(manager.opened_buffers_changed),
+      })
+    end
+  end
+
   -- Configure event handler for follow_current_file option
   if config.follow_current_file then
     manager.subscribe(M.name, {

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

@@ -78,7 +78,7 @@ M.setup = function(config, global_config)
   if global_config.enable_modified_markers then
     manager.subscribe(M.name, {
       event = events.VIM_BUFFER_MODIFIED_SET,
-      handler = wrap(manager.modified_buffers_changed),
+      handler = wrap(manager.opened_buffers_changed),
     })
   end
 

lua/neo-tree/sources/manager.lua

@@ -425,17 +425,17 @@ M.focus = function(source_name, path_to_reveal, callback)
 end
 
 ---Redraws the tree with updated modified markers without scanning the filesystem again.
-M.modified_buffers_changed = function(source_name, args)
+M.opened_buffers_changed = function(source_name, args)
   if not type(args) == "table" then
-    error("modified_buffers_changed: args must be a table")
+    error("opened_buffers_changed: args must be a table")
   end
-  if type(args.modified_buffers) == "table" then
+  if type(args.opened_buffers) == "table" then
     M._for_each_state(source_name, function(state)
-      if utils.tbl_equals(args.modified_buffers, state.modified_buffers) then
+      if utils.tbl_equals(args.opened_buffers, state.opened_buffers) then
         -- no changes, no need to redraw
         return
       end
-      state.modified_buffers = args.modified_buffers
+      state.opened_buffers = args.opened_buffers
       renderer.redraw(state)
     end)
   end

lua/neo-tree/utils.lua

@@ -144,7 +144,7 @@ M.debounce = function(id, fn, frequency_in_ms, strategy, action)
 end
 
 --- Returns true if the contents of two tables are equal.
-M.tbl_equals = function (table1, table2)
+M.tbl_equals = function(table1, table2)
   -- same object
   if table1 == table2 then
     return true
@@ -241,18 +241,33 @@ M.get_diagnostic_counts = function()
   return lookup
 end
 
+--- DEPRECATED: This will be removed in v3. Use `get_opened_buffers` instead.
 ---Gets a lookup of all open buffers keyed by path with the modifed flag as the value
----@return table
+---@return table opened_buffers { [buffer_name] = bool }
 M.get_modified_buffers = function()
-  local modified_buffers = {}
+  local opened_buffers = M.get_opened_buffers()
+  for bufname, bufinfo in pairs(opened_buffers) do
+    opened_buffers[bufname] = bufinfo.modified
+  end
+  return opened_buffers
+end
+
+---Gets a lookup of all open buffers keyed by path with additional information
+---@return table opened_buffers { [buffer_name] = { modified = bool } }
+M.get_opened_buffers = function()
+  local opened_buffers = {}
   for _, buffer in ipairs(vim.api.nvim_list_bufs()) do
-    local buffer_name = vim.api.nvim_buf_get_name(buffer)
-    if buffer_name == nil or buffer_name == "" then
-      buffer_name = "[No Name]#" .. buffer
+    if vim.api.nvim_buf_is_loaded(buffer) and vim.fn.buflisted(buffer) then
+      local buffer_name = vim.api.nvim_buf_get_name(buffer)
+      if buffer_name == nil or buffer_name == "" then
+        buffer_name = "[No Name]#" .. buffer
+      end
+      opened_buffers[buffer_name] = {
+        ["modified"] = vim.api.nvim_buf_get_option(buffer, "modified"),
+      }
     end
-    modified_buffers[buffer_name] = vim.api.nvim_buf_get_option(buffer, "modified")
   end
-  return modified_buffers
+  return opened_buffers
 end
 
 ---Resolves some variable to a string. The object can be either a string or a