feat(#2415): create DecoratorDiagnostics

Author: alex-courtis

lua/nvim-tree/renderer/builder.lua

@@ -5,7 +5,6 @@ local notify = require "nvim-tree.notify"
 local git = require "nvim-tree.renderer.components.git"
 local pad = require "nvim-tree.renderer.components.padding"
 local icons = require "nvim-tree.renderer.components.icons"
-local diagnostics = require "nvim-tree.renderer.components.diagnostics"
 
 local HL_POSITION = require("nvim-tree.enum").HL_POSITION
 local ICON_PLACEMENT = require("nvim-tree.enum").ICON_PLACEMENT
@@ -74,14 +73,6 @@ function Builder:configure_git_icons_placement(where)
   return self
 end
 
-function Builder:configure_diagnostics_icon_placement(where)
-  if where ~= "after" and where ~= "before" and where ~= "signcolumn" then
-    where = "before" -- default before
-  end
-  self.diagnostics_placement = where
-  return self
-end
-
 function Builder:configure_symlink_destination(show)
   self.symlink_destination = show
   return self
@@ -236,8 +227,8 @@ end
 ---@param node table
 ---@return HighlightedString[]|nil icon
 function Builder:_get_diagnostics_icon(node)
-  local diagnostics_icon = diagnostics.get_icon(node)
-  if diagnostics_icon and self.diagnostics_placement == "signcolumn" then
+  local diagnostics_icon = self.decorators.diagnostics:get_icon(node)
+  if diagnostics_icon and self.decorators.diagnostics.icon_placement == ICON_PLACEMENT.signcolumn then
     table.insert(self.signs, {
       sign = diagnostics_icon.hl[1],
       lnum = self.index + 1,
@@ -266,8 +257,8 @@ end
 ---@param node table
 ---@return HighlightedString[]|nil icon
 function Builder:_get_bookmark_icon(node)
-  local bookmark_icon = self.decorators.bookmark:get_icon(node)
-  if bookmark_icon and self.decorators.bookmark.icon_placement == ICON_PLACEMENT.signcolumn then
+  local bookmark_icon = self.decorators.bookmarks:get_icon(node)
+  if bookmark_icon and self.decorators.bookmarks.icon_placement == ICON_PLACEMENT.signcolumn then
     table.insert(self.signs, {
       sign = bookmark_icon.hl[1],
       lnum = self.index + 1,
@@ -319,12 +310,12 @@ end
 ---@param icon_hl string[] icons to append to
 ---@param name_hl string[] names to append to
 function Builder:_append_dec_highlight(node, decorator, icon_hl, name_hl)
-  local pos, hl = decorator:get_highlight(node)
-  if pos ~= HL_POSITION.none and hl then
-    if pos == HL_POSITION.all or pos == HL_POSITION.icon then
+  local hl = decorator:get_highlight(node)
+  if hl then
+    if decorator.hl_pos == HL_POSITION.all or decorator.hl_pos == HL_POSITION.icon then
       table.insert(icon_hl, hl)
     end
-    if pos == HL_POSITION.all or pos == HL_POSITION.name then
+    if decorator.hl_pos == HL_POSITION.all or decorator.hl_pos == HL_POSITION.name then
       table.insert(name_hl, hl)
     end
   end
@@ -365,10 +356,10 @@ function Builder:_format_line(indent_markers, arrows, icon, name, git_icons, dia
   if modified_icon and self.decorators.modified.icon_placement == ICON_PLACEMENT.before then
     add_to_end(line, { modified_icon })
   end
-  if diagnostics_icon and self.diagnostics_placement == "before" then
+  if diagnostics_icon and self.decorators.diagnostics.icon_placement == ICON_PLACEMENT.before then
     add_to_end(line, { diagnostics_icon })
   end
-  if bookmark_icon and self.decorators.bookmark.icon_placement == ICON_PLACEMENT.before then
+  if bookmark_icon and self.decorators.bookmarks.icon_placement == ICON_PLACEMENT.before then
     add_to_end(line, { bookmark_icon })
   end
 
@@ -380,10 +371,10 @@ function Builder:_format_line(indent_markers, arrows, icon, name, git_icons, dia
   if modified_icon and self.decorators.modified.icon_placement == ICON_PLACEMENT.after then
     add_to_end(line, { modified_icon })
   end
-  if diagnostics_icon and self.diagnostics_placement == "after" then
+  if diagnostics_icon and self.decorators.diagnostics.icon_placement == ICON_PLACEMENT.after then
     add_to_end(line, { diagnostics_icon })
   end
-  if bookmark_icon and self.decorators.bookmark.icon_placement == ICON_PLACEMENT.after then
+  if bookmark_icon and self.decorators.bookmarks.icon_placement == ICON_PLACEMENT.after then
     add_to_end(line, { bookmark_icon })
   end
 
@@ -427,8 +418,8 @@ function Builder:_build_line(node, idx, num_children, unloaded_bufnr)
   -- extra highighting
   self:_append_highlight(node, git.get_highlight, icon.hl, name.hl)
   self:_append_dec_highlight(node, self.decorators.modified, icon.hl, name.hl)
-  self:_append_dec_highlight(node, self.decorators.bookmark, icon.hl, name.hl)
-  self:_append_highlight(node, diagnostics.get_highlight, icon.hl, name.hl)
+  self:_append_dec_highlight(node, self.decorators.bookmarks, icon.hl, name.hl)
+  self:_append_dec_highlight(node, self.decorators.diagnostics, icon.hl, name.hl)
   self:_append_highlight(node, copy_paste.get_highlight, icon.hl, name.hl)
 
   local line = self:_format_line(indent_markers, arrows, icon, name, git_icons, diagnostics_icon, modified_icon, bookmark_icon)

lua/nvim-tree/renderer/decorator/bookmark.lua renamed to lua/nvim-tree/renderer/decorator/bookmarks.lua

@@ -5,18 +5,18 @@ local ICON_PLACEMENT = require("nvim-tree.enum").ICON_PLACEMENT
 
 local Decorator = require "nvim-tree.renderer.decorator"
 
---- @class DecoratorBookmark: Decorator
+--- @class DecoratorBookmarks: Decorator
 --- @field icon HighlightedString
-local DecoratorBookmark = Decorator:new()
+local DecoratorBookmarks = Decorator:new()
 
 --- @param opts table
---- @return DecoratorBookmark
-function DecoratorBookmark:new(opts)
+--- @return DecoratorBookmarks
+function DecoratorBookmarks:new(opts)
   local o = Decorator.new(self, {
     hl_pos = HL_POSITION[opts.renderer.highlight_bookmarks] or HL_POSITION.none,
     icon_placement = ICON_PLACEMENT[opts.renderer.icons.bookmarks_placement] or ICON_PLACEMENT.none,
   })
-  ---@cast o DecoratorBookmark
+  ---@cast o DecoratorBookmarks
 
   if opts.renderer.icons.show.bookmarks then
     o.icon = {
@@ -29,25 +29,18 @@ function DecoratorBookmark:new(opts)
   return o
 end
 
---- Bookmark  icon: renderer.icons.show.bookmarks and node is marked
-function DecoratorBookmark:get_icon(node)
+--- Bookmark icon: renderer.icons.show.bookmarks and node is marked
+function DecoratorBookmarks:get_icon(node)
   if marks.get_mark(node) then
     return self.icon
   end
 end
 
 --- Bookmark highlight: renderer.highlight_bookmarks and node is marked
-function DecoratorBookmark:get_highlight(node)
-  if self.hl_pos == HL_POSITION.none then
-    return HL_POSITION.none, nil
-  end
-
-  local mark = marks.get_mark(node)
-  if mark then
-    return self.hl_pos, "NvimTreeBookmarkHL"
-  else
-    return HL_POSITION.none, nil
+function DecoratorBookmarks:get_highlight(node)
+  if self.hl_pos ~= HL_POSITION.none and marks.get_mark(node) then
+    return "NvimTreeBookmarkHL"
   end
 end
 
-return DecoratorBookmark
+return DecoratorBookmarks

lua/nvim-tree/renderer/decorator/diagnostics.lua

@@ -0,0 +1,93 @@
+local HL_POSITION = require("nvim-tree.enum").HL_POSITION
+local ICON_PLACEMENT = require("nvim-tree.enum").ICON_PLACEMENT
+
+local Decorator = require "nvim-tree.renderer.decorator"
+
+-- highlight groups by severity
+local HG_ICON = {
+  [vim.diagnostic.severity.ERROR] = "NvimTreeDiagnosticErrorIcon",
+  [vim.diagnostic.severity.WARN] = "NvimTreeDiagnosticWarningIcon",
+  [vim.diagnostic.severity.INFO] = "NvimTreeDiagnosticInfoIcon",
+  [vim.diagnostic.severity.HINT] = "NvimTreeDiagnosticHintIcon",
+}
+local HG_FILE = {
+  [vim.diagnostic.severity.ERROR] = "NvimTreeDiagnosticErrorFileHL",
+  [vim.diagnostic.severity.WARN] = "NvimTreeDiagnosticWarningFileHL",
+  [vim.diagnostic.severity.INFO] = "NvimTreeDiagnosticInfoFileHL",
+  [vim.diagnostic.severity.HINT] = "NvimTreeDiagnosticHintFileHL",
+}
+local HG_FOLDER = {
+  [vim.diagnostic.severity.ERROR] = "NvimTreeDiagnosticErrorFolderHL",
+  [vim.diagnostic.severity.WARN] = "NvimTreeDiagnosticWarningFolderHL",
+  [vim.diagnostic.severity.INFO] = "NvimTreeDiagnosticInfoFolderHL",
+  [vim.diagnostic.severity.HINT] = "NvimTreeDiagnosticHintFolderHL",
+}
+-- opts.diagnostics.icons.
+local ICON_KEYS = {
+  ["error"] = vim.diagnostic.severity.ERROR,
+  ["warning"] = vim.diagnostic.severity.WARN,
+  ["info"] = vim.diagnostic.severity.INFO,
+  ["hint"] = vim.diagnostic.severity.HINT,
+}
+
+--- @class DecoratorDiagnostics: Decorator
+--- @field enabled boolean
+--- @field icons HighlightedString[]
+local DecoratorDiagnostics = Decorator:new()
+
+--- @param opts table
+--- @return DecoratorDiagnostics
+function DecoratorDiagnostics:new(opts)
+  local o = Decorator.new(self, {
+    hl_pos = HL_POSITION[opts.renderer.highlight_diagnostics] or HL_POSITION.none,
+    icon_placement = ICON_PLACEMENT[opts.renderer.icons.diagnostics_placement] or ICON_PLACEMENT.none,
+  })
+  ---@cast o DecoratorDiagnostics
+
+  o.enabled = opts.diagnostics.enable
+  if not o.enabled then
+    return o
+  end
+
+  if opts.renderer.icons.show.diagnostics then
+    o.icons = {}
+    for name, sev in pairs(ICON_KEYS) do
+      o.icons[sev] = {
+        str = opts.diagnostics.icons[name],
+        hl = { HG_ICON[sev] },
+      }
+      o:define_sign(o.icons[sev])
+    end
+  end
+
+  return o
+end
+
+--- Diagnostic icon: diagnostics.enable, renderer.icons.show.diagnostics and node has status
+function DecoratorDiagnostics:get_icon(node)
+  if node and self.enabled and self.icons then
+    return self.icons[node.diag_status]
+  end
+end
+
+--- Diagnostic highlight: diagnostics.enable, renderer.highlight_diagnostics and node has status
+function DecoratorDiagnostics:get_highlight(node)
+  if not node or not self.enabled or self.hl_pos == HL_POSITION.none then
+    return nil
+  end
+
+  local group
+  if node.nodes then
+    group = HG_FOLDER[node.diag_status]
+  else
+    group = HG_FILE[node.diag_status]
+  end
+
+  if group then
+    return group
+  else
+    return nil
+  end
+end
+
+return DecoratorDiagnostics

lua/nvim-tree/renderer/decorator/init.lua

@@ -20,15 +20,15 @@ end
 --- @return HighlightedString|nil modified icon
 function Decorator:get_icon(node) end
 
---- Node highlight
+--- Node highlight group
 --- @param node table
---- @return HL_POSITION|nil position
 --- @return string|nil group
 function Decorator:get_highlight(node) end
 
 ---@diagnostic enable: unused-local
 
 --- Define a sign
+--- @protected
 --- @param icon HighlightedString|nil
 function Decorator:define_sign(icon)
   if icon and #icon.hl > 0 then

lua/nvim-tree/renderer/decorator/modified.lua

@@ -45,13 +45,13 @@ end
 --- Modified highlight: modified.enable, renderer.highlight_modified and node is modified
 function DecoratorModified:get_highlight(node)
   if not self.enabled or self.hl_pos == HL_POSITION.none or not modified.is_modified(node) then
-    return HL_POSITION.none, nil
+    return nil
   end
 
   if node.nodes then
-    return self.hl_pos, "NvimTreeModifiedFolderHL"
+    return "NvimTreeModifiedFolderHL"
   else
-    return self.hl_pos, "NvimTreeModifiedFileHL"
+    return "NvimTreeModifiedFileHL"
   end
 end
 

lua/nvim-tree/renderer/init.lua

@@ -7,11 +7,11 @@ local _padding = require "nvim-tree.renderer.components.padding"
 local icon_component = require "nvim-tree.renderer.components.icons"
 local full_name = require "nvim-tree.renderer.components.full-name"
 local git = require "nvim-tree.renderer.components.git"
-local diagnostics = require "nvim-tree.renderer.components.diagnostics"
 local Builder = require "nvim-tree.renderer.builder"
 local live_filter = require "nvim-tree.live-filter"
 
-local DecoratorBookmark = require "nvim-tree.renderer.decorator.bookmark"
+local DecoratorBookmarks = require "nvim-tree.renderer.decorator.bookmarks"
+local DecoratorDiagnostics = require "nvim-tree.renderer.decorator.diagnostics"
 local DecoratorModified = require "nvim-tree.renderer.decorator.modified"
 
 local M = {
@@ -76,7 +76,6 @@ function M.draw(unloaded_bufnr)
     :configure_opened_file_highlighting(M.config.highlight_opened_files)
     :configure_icon_padding(M.config.icons.padding)
     :configure_git_icons_placement(M.config.icons.git_placement)
-    :configure_diagnostics_icon_placement(M.config.icons.diagnostics_placement)
     :configure_symlink_destination(M.config.symlink_destination)
     :configure_filter(live_filter.filter, live_filter.prefix)
     :configure_group_name_modifier(M.config.group_empty)
@@ -105,18 +104,14 @@ function M.setup(opts)
   _padding.setup(opts)
   full_name.setup(opts)
   git.setup(opts)
-  diagnostics.setup(opts)
   icon_component.setup(opts)
 
   -- TODO change to array: precedence should follow order
   M.decorators = {
-    bookmark = DecoratorBookmark:new(opts),
+    bookmarks = DecoratorBookmarks:new(opts),
+    diagnostics = DecoratorDiagnostics:new(opts),
     modified = DecoratorModified:new(opts),
   }
-
-  for _, d in pairs(M.decorators) do
-    log.line("dev", "d = %s", vim.inspect(d))
-  end
 end
 
 return M