feat(view): indicate modified buffers (#1835)

* Outlined new options

* highlight_modified is highlight_opened_files

* prototype with autocmd

* moved modified into glyphs

* show_on_dirs and show_on_open_dirs

* icon placement before & after

* _get_filename_offset

* fixed :wq doesn't update modified indicator

* highlight_modified, signcolumn modified_placement

Refactored to make everything use HighlightedString to remove all the complex `insert_highlight` calculation.
Not tested.

* updated doc to match the reality of no multi char for glyphs.modified

* fixed git signcolumn doesn't show

* fixed highlight_modified gets replaced by highlight_opened_files

* fixed renderer.icons.show.modified = false crash

* updated doc to reflect empty icon not breaking rendering

* removed debounce_delay to implement in a later PR

* doc nit: order placement

* change modified dirs default to be consistent with git

* illegal git & modified placement changed to default

* don't assume icon exist

* nit remove comment

* Noted in doc that glyphs can't have more than 2 characters if in signcolumn

* Don't sign_define if placement isn't signcolumn

Co-authored-by: Alexander Courtis <[email protected]>

Author: chomosuke

doc/nvim-tree-lua.txt

@@ -224,6 +224,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,18 +241,21 @@ Subsequent calls to setup will replace the previous configuration.
         icons = {
           webdev_colors = true,
           git_placement = "before",
+          modified_placement = "after",
           padding = " ",
           symlink_arrow = " ➛ ",
           show = {
             file = true,
             folder = true,
             folder_arrow = true,
             git = true,
+            modified = true,
           },
           glyphs = {
             default = "",
             symlink = "",
             bookmark = "",
+            modified = "●",
             folder = {
               arrow_closed = "",
               arrow_open = "",
@@ -326,6 +330,11 @@ 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 = true,
+      },
       actions = {
         use_system_clipboard = true,
         change_dir = {
@@ -544,6 +553,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:
@@ -619,6 +629,26 @@ 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: `true`
+
+  You will still need to set |renderer.icons.show.modified| `= true` or
+  |renderer.highlight_modified| `= true` to be able to see things in the
+  tree.
+
 *nvim-tree.filesystem_watchers*
 Will use file system watcher (libuv fs_event) to watch the filesystem for
 changes.
@@ -779,6 +809,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.
@@ -821,12 +858,17 @@ 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.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.padding*
         Inserted between icon and filename.
-        Use with caution, it could break rendering if you set an empty string depending on your font.
           Type: `string`, Default: `" "`
 
         *nvim-tree.renderer.icons.symlink_arrow*
@@ -854,8 +896,15 @@ UI rendering setup
             Requires |git.enable| `= true`
               Type: `boolean`, Default: `true`
 
+            *nvim-tree.renderer.icons.show.modified*
+            Show a modified icon, see |renderer.icons.modified_placement|
+            Requires |modified.enable| `= true`
+              Type: `boolean`, Default: `true`
+
         *nvim-tree.renderer.icons.glyphs*
         Configuration options for icon glyphs.
+        NOTE: Do not set any glyphs to more than two characters if it's going
+        to appear in the signcolumn.
 
             *nvim-tree.renderer.icons.glyphs.default*
             Glyph for files. Will be overridden by `nvim-web-devicons` if available.
@@ -865,6 +914,10 @@ UI rendering setup
             Glyph for symlinks to files.
               Type: `string`, Default: `""`
 
+            *nvim-tree.renderer.icons.glyphs.modified*
+            Icon to display for modified files.
+              Type: `string`, Default: `"●"`
+
             *nvim-tree.renderer.icons.glyphs.folder*
             Glyphs for directories.
               Type: `table`, Default:
@@ -1471,6 +1524,7 @@ NvimTreeEmptyFolderName     (Directory)
 NvimTreeOpenedFolderName    (Directory)
 NvimTreeExecFile
 NvimTreeOpenedFile
+NvimTreeModifiedFile
 NvimTreeSpecialFile
 NvimTreeImageFile
 NvimTreeIndentMarker

lua/nvim-tree.lua

@@ -12,6 +12,7 @@ local copy_paste = require "nvim-tree.actions.fs.copy-paste"
 local collapse_all = require "nvim-tree.actions.tree-modifiers.collapse-all"
 local git = require "nvim-tree.git"
 local filters = require "nvim-tree.explorer.filters"
+local modified = require "nvim-tree.modified"
 
 local _config = {}
 
@@ -476,6 +477,15 @@ local function setup_autocommands(opts)
       end,
     })
   end
+
+  if opts.modified.enable then
+    create_nvim_tree_autocmd({ "BufModifiedSet", "BufWritePost" }, {
+      callback = function()
+        modified.reload()
+        reloaders.reload_explorer()
+      end,
+    })
+  end
 end
 
 local DEFAULT_OPTS = { -- BEGIN_DEFAULT_OPTS
@@ -532,6 +542,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 = {
@@ -548,18 +559,21 @@ local DEFAULT_OPTS = { -- BEGIN_DEFAULT_OPTS
     icons = {
       webdev_colors = true,
       git_placement = "before",
+      modified_placement = "after",
       padding = " ",
       symlink_arrow = " ➛ ",
       show = {
         file = true,
         folder = true,
         folder_arrow = true,
         git = true,
+        modified = true,
       },
       glyphs = {
         default = "",
         symlink = "",
         bookmark = "",
+        modified = "●",
         folder = {
           arrow_closed = "",
           arrow_open = "",
@@ -634,6 +648,11 @@ local DEFAULT_OPTS = { -- BEGIN_DEFAULT_OPTS
     show_on_open_dirs = true,
     timeout = 400,
   },
+  modified = {
+    enable = false,
+    show_on_dirs = true,
+    show_on_open_dirs = true,
+  },
   actions = {
     use_system_clipboard = true,
     change_dir = {
@@ -810,6 +829,7 @@ function M.setup(conf)
   require("nvim-tree.renderer").setup(opts)
   require("nvim-tree.live-filter").setup(opts)
   require("nvim-tree.marks").setup(opts)
+  require("nvim-tree.modified").setup(opts)
   if M.config.renderer.icons.show.file and pcall(require, "nvim-web-devicons") then
     require("nvim-web-devicons").setup()
   end

lua/nvim-tree/colors.lua

@@ -40,6 +40,7 @@ local function get_hl_groups()
     SpecialFile = { gui = "bold,underline", fg = colors.yellow },
     ImageFile = { gui = "bold", fg = colors.purple },
     OpenedFile = { gui = "bold", fg = colors.green },
+    ModifiedFile = { fg = colors.green },
 
     GitDirty = { fg = colors.dark_red },
     GitDeleted = { fg = colors.dark_red },

lua/nvim-tree/modified.lua

@@ -0,0 +1,34 @@
+local M = {}
+
+---@type table<string, boolean> record of which file is modified
+M._record = {}
+
+---refresh M.record
+function M.reload()
+  M._record = {}
+  local bufs = vim.fn.getbufinfo { bufmodified = true, buflisted = true }
+  for _, buf in pairs(bufs) do
+    local path = buf.name
+    M._record[path] = true
+    while path ~= vim.fn.getcwd() and path ~= "/" do
+      path = vim.fn.fnamemodify(path, ":h")
+      M._record[path] = true
+    end
+  end
+end
+
+---@param node table
+---@return boolean
+function M.is_modified(node)
+  return M.config.enable
+    and M._record[node.absolute_path]
+    and (not node.nodes or M.config.show_on_dirs)
+    and (not node.open or M.config.show_on_open_dirs)
+end
+
+---@param opts table
+function M.setup(opts)
+  M.config = opts.modified
+end
+
+return M