feat: Indicate modified buffers

doc/nvim-tree-lua.txt

@@ -222,6 +222,7 @@ Subsequent calls to setup will replace the previous configuration.
         highlight_git = false,
         full_name = false,
         highlight_opened_files = "none",
+        highlight_modified = "none",
         root_folder_label = ":~:s?$?/..?",
         indent_width = 2,
         indent_markers = {
@@ -240,6 +241,8 @@ Subsequent calls to setup will replace the previous configuration.
           git_placement = "before",
           padding = " ",
           symlink_arrow = " ➛ ",
+          modified = "[+]",
+          modified_placement = "after",
           show = {
             file = true,
             folder = true,
@@ -324,6 +327,12 @@ Subsequent calls to setup will replace the previous configuration.
         show_on_open_dirs = true,
         timeout = 400,
       },
+      modified = {
+        enable = false,
+        show_on_dirs = true,
+        show_on_open_dirs = false,
+        debounce_delay = 50,
+      },
       actions = {
         use_system_clipboard = true,
         change_dir = {
@@ -542,6 +551,7 @@ Configuration options for the system open command.
 
 *nvim-tree.diagnostics*
 Show LSP and COC diagnostics in the signcolumn
+Note that the modified sign will take precedence over the diagnostics signs.
 
     `NOTE`: it will use the default diagnostic color groups to highlight the signs.
     If you wish to customize, you can override these groups:
@@ -617,6 +627,28 @@ Git integration with icons and colors.
   milliseconds but a few seconds), it will not render anything until the git
   process returned the data.
 
+*nvim-tree.modified*
+Indicate which file have unsaved modification.
+
+    *nvim-tree.modified.enable*
+    Enable / disable the feature.
+      Type: `boolean`, Default: `false`
+
+    *nvim-tree.modified.show_on_dirs*
+    Show modified indication on directory whose children are modified.
+      Type: `boolean`, Default: `true`
+
+    *nvim-tree.modified.show_on_open_dirs*
+    Show modified indication on open directories.
+    Only relevant when |modified.show_on_dirs| is `true`.
+      Type: `boolean`, Default: `false`
+
+    *nvim-tree.modified.debounce_delay*
+    Idle milliseconds between the file is modified and action.
+    This helps performance when large number of files are modified in quick
+    succession (e.g. lsp rename).
+      Type: `number`, Default: `50` (ms)
+
 *nvim-tree.filesystem_watchers*
 Will use file system watcher (libuv fs_event) to watch the filesystem for
 changes.
@@ -773,6 +805,13 @@ UI rendering setup
     Value can be `"none"`, `"icon"`, `"name"` or `"all"`.
       Type: `string`, Default: `"none"`
 
+    *nvim-tree.renderer.highlight_modified*
+    Highlight icons and/or names for modified files using `NvimTreeModified`
+    highlight groups.
+    Value can be `"none"`, `"icon"`, `"name"` or `"all"`
+    This can be used with or without the icons.
+      Type: `string`, Default `"none"`
+
     *nvim-tree.renderer.root_folder_label*  (previously `renderer.root_folder_modifier`)
     In what format to show root folder. See `:help filename-modifiers` for
     available `string` options.
@@ -815,7 +854,7 @@ UI rendering setup
         Place where the git icons will be rendered.
         Can be `"after"` or `"before"` filename (after the file/folders icons)
         or `"signcolumn"` (requires |nvim-tree.view.signcolumn| enabled).
-        Note that the diagnostic signs will take precedence over the git signs.
+        Note that the diagnostic signs and the modified sign will take precedence over the git signs.
           Type: `string`, Default: `before`
 
         *nvim-tree.renderer.icons.padding*
@@ -827,6 +866,17 @@ UI rendering setup
         Used as a separator between symlinks' source and target.
           Type: `string`, Default: `" ➛ "`
 
+        *nvim-tree.renderer.icons.modified*
+        Icon to display for modified files. Can be multiple characters if
+        |renderer.icons.modified_placement| isn't `"signcolumn"`.
+          Type: `string`, Default: `"[+]"`
+
+        *nvim-tree.renderer.icons.modified_placement*
+        Place where the modified icon will be rendered.
+        Can be `"after"` or `"before"` filename (after the file/folders icons)
+        or `"signcolumn"` (requires |nvim-tree.view.signcolumn| enabled).
+          Type: `string`, Default: `after`
+
         *nvim-tree.renderer.icons.show*
         Configuration options for showing icon types.
 

lua/nvim-tree.lua

@@ -468,6 +468,16 @@ local function setup_autocommands(opts)
       end,
     })
   end
+
+  if opts.modified.enable then
+    create_nvim_tree_autocmd("BufModifiedSet", {
+      callback = function()
+        utils.debounce("BufModifiedSet:modified_files", opts.modified.debounce_delay, function()
+          reloaders.reload_explorer()
+        end)
+      end,
+    })
+  end
 end
 
 local DEFAULT_OPTS = { -- BEGIN_DEFAULT_OPTS
@@ -523,6 +533,7 @@ local DEFAULT_OPTS = { -- BEGIN_DEFAULT_OPTS
     highlight_git = false,
     full_name = false,
     highlight_opened_files = "none",
+    highlight_modified = "none",
     root_folder_label = ":~:s?$?/..?",
     indent_width = 2,
     indent_markers = {
@@ -541,6 +552,8 @@ local DEFAULT_OPTS = { -- BEGIN_DEFAULT_OPTS
       git_placement = "before",
       padding = " ",
       symlink_arrow = " ➛ ",
+      modified = "[+]",
+      modified_placement = "after",
       show = {
         file = true,
         folder = true,
@@ -625,6 +638,12 @@ local DEFAULT_OPTS = { -- BEGIN_DEFAULT_OPTS
     show_on_open_dirs = true,
     timeout = 400,
   },
+  modified = {
+    enable = false,
+    show_on_dirs = true,
+    show_on_open_dirs = false,
+    debounce_delay = 50,
+  },
   actions = {
     use_system_clipboard = true,
     change_dir = {

lua/nvim-tree/renderer/builder.lua

@@ -68,6 +68,13 @@ function Builder:configure_git_icons_placement(where)
   return self
 end
 
+function Builder:configure_modified(modified_icon, modified_placement, modified)
+  self.modified = modified
+  self.modified.icon = modified_icon
+  self.modified.placement = modified_placement
+  return self
+end
+
 function Builder:configure_symlink_destination(show)
   self.symlink_destination = show
   return self
@@ -206,15 +213,19 @@ function Builder:_highlight_opened_files(node, offset, icon_length, git_icons_le
   self:_insert_highlight("NvimTreeOpenedFile", from, to)
 end
 
-function Builder:_build_file(node, padding, git_highlight, git_icons_tbl, unloaded_bufnr)
+function Builder:_build_file(node, padding, git_highlight, git_icons_tbl, unloaded_bufnr, modified)
   local offset = string.len(padding)
 
   local icon = self:_build_file_icon(node, offset)
 
   local git_icons_starts_at = offset + #icon + (self.is_git_after and #node.name + 1 or 0)
   local git_icons = self:_unwrap_git_data(git_icons_tbl, git_icons_starts_at)
 
-  self:_insert_line(self:_format_line(padding .. icon, node.name, git_icons))
+  local name = node.name
+  if modified then
+    name = name .. self.modified.icon
+  end
+  self:_insert_line(self:_format_line(padding .. icon, name, git_icons))
 
   local git_icons_length = self.is_git_after and 0 or #git_icons
   local col_start = offset + #icon + git_icons_length
@@ -263,6 +274,8 @@ function Builder:_build_line(node, idx, num_children, unloaded_bufnr)
     end
   end
 
+  local modified = vim.fn.bufloaded(node.absolute_path) > 0 and vim.fn.getbufinfo(node.absolute_path)[1].changed == 1
+
   local is_folder = node.nodes ~= nil
   local is_symlink = node.link_to ~= nil
 
@@ -271,7 +284,7 @@ function Builder:_build_line(node, idx, num_children, unloaded_bufnr)
   elseif is_symlink then
     self:_build_symlink(node, padding, git_highlight, git_icons_tbl)
   else
-    self:_build_file(node, padding, git_highlight, git_icons_tbl, unloaded_bufnr)
+    self:_build_file(node, padding, git_highlight, git_icons_tbl, unloaded_bufnr, modified)
   end
   self.index = self.index + 1
 

lua/nvim-tree/renderer/init.lua

@@ -70,6 +70,7 @@ function M.draw(unloaded_bufnr)
       :configure_opened_file_highlighting(M.config.highlight_opened_files)
       :configure_git_icons_padding(M.config.icons.padding)
       :configure_git_icons_placement(M.config.icons.git_placement)
+      :configure_modified(M.config.icons.modified, M.config.icons.modified_placement, M.config.modified)
       :configure_symlink_destination(M.config.symlink_destination)
       :configure_filter(live_filter.filter, live_filter.prefix)
       :build_header(view.is_root_folder_visible(core.get_cwd()))
@@ -100,6 +101,7 @@ end
 
 function M.setup(opts)
   M.config = opts.renderer
+  M.config.modified = opts.modified
 
   _padding.setup(opts)
   full_name.setup(opts)