typechecked optargs constructors for decorators, WIP

lua/nvim-tree/renderer/builder.lua

@@ -7,7 +7,7 @@ local DirectoryNode = require("nvim-tree.node.directory")
 local DecoratorBookmarks = require("nvim-tree.renderer.decorator.bookmarks")
 local DecoratorCopied = require("nvim-tree.renderer.decorator.copied")
 local DecoratorCut = require("nvim-tree.renderer.decorator.cut")
--- local DecoratorDiagnostics = require("nvim-tree.renderer.decorator.diagnostics")
+local DecoratorDiagnostics = require("nvim-tree.renderer.decorator.diagnostics")
 local DecoratorGit = require("nvim-tree.renderer.decorator.git")
 -- local DecoratorModified = require("nvim-tree.renderer.decorator.modified")
 -- local DecoratorHidden = require("nvim-tree.renderer.decorator.hidden")
@@ -63,7 +63,7 @@ function Builder:new(opts, explorer)
       -- priority order
       DecoratorCut({ explorer = explorer }),
       DecoratorCopied({ explorer = explorer }),
-      -- DecoratorDiagnostics({ explorer = explorer }),
+      DecoratorDiagnostics({ explorer = explorer }),
       DecoratorBookmarks({ explorer = explorer }),
       -- DecoratorModified({ explorer = explorer }),
       -- DecoratorHidden({ explorer = explorer }),

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

@@ -1,95 +0,0 @@
-local HL_POSITION = require("nvim-tree.enum").HL_POSITION
-local diagnostics = require("nvim-tree.diagnostics")
-
-local DirectoryNode = require("nvim-tree.node.directory")
-
-local M = {
-  -- highlight strings for the icons
-  HS_ICON = {},
-
-  -- highlight groups for HL
-  HG_FILE = {},
-  HG_FOLDER = {},
-
-  -- position for HL
-  HL_POS = HL_POSITION.none,
-}
-
----Diagnostics highlight group and position when highlight_diagnostics.
----@param node Node
----@return HL_POSITION position none when no status
----@return string|nil group only when status
-function M.get_highlight(node)
-  if not node or M.HL_POS == HL_POSITION.none then
-    return HL_POSITION.none, nil
-  end
-
-  local group
-  local diag_status = diagnostics.get_diag_status(node)
-  if node:is(DirectoryNode) then
-    group = M.HS_FOLDER[diag_status and diag_status.value]
-  else
-    group = M.HS_FILE[diag_status and diag_status.value]
-  end
-
-  if group then
-    return M.HL_POS, group
-  else
-    return HL_POSITION.none, nil
-  end
-end
-
----diagnostics icon if there is a status
----@param node Node
----@return HighlightedString|nil modified icon
-function M.get_icon(node)
-  if node and M.config.diagnostics.enable and M.config.renderer.icons.show.diagnostics then
-    local diag_status = diagnostics.get_diag_status(node)
-    return M.ICON[diag_status and diag_status.value]
-  end
-end
-
-function M.setup(opts)
-  M.config = {
-    diagnostics = opts.diagnostics,
-    renderer = opts.renderer,
-  }
-
-  if opts.diagnostics.enable and opts.renderer.highlight_diagnostics then
-    M.HL_POS = HL_POSITION[opts.renderer.highlight_diagnostics]
-  end
-
-  M.HG_FILE[vim.diagnostic.severity.ERROR] = "NvimTreeDiagnosticErrorFileHL"
-  M.HG_FILE[vim.diagnostic.severity.WARN] = "NvimTreeDiagnosticWarningFileHL"
-  M.HG_FILE[vim.diagnostic.severity.INFO] = "NvimTreeDiagnosticInfoFileHL"
-  M.HG_FILE[vim.diagnostic.severity.HINT] = "NvimTreeDiagnosticHintFileHL"
-
-  M.HG_FOLDER[vim.diagnostic.severity.ERROR] = "NvimTreeDiagnosticErrorFolderHL"
-  M.HG_FOLDER[vim.diagnostic.severity.WARN] = "NvimTreeDiagnosticWarningFolderHL"
-  M.HG_FOLDER[vim.diagnostic.severity.INFO] = "NvimTreeDiagnosticInfoFolderHL"
-  M.HG_FOLDER[vim.diagnostic.severity.HINT] = "NvimTreeDiagnosticHintFolderHL"
-
-  M.HS_ICON[vim.diagnostic.severity.ERROR] = {
-    str = M.config.diagnostics.icons.error,
-    hl = { "NvimTreeDiagnosticErrorIcon" },
-  }
-
-  M.HS_ICON[vim.diagnostic.severity.WARN] = {
-    str = M.config.diagnostics.icons.warning,
-    hl = { "NvimTreeDiagnosticWarningIcon" },
-  }
-  M.HS_ICON[vim.diagnostic.severity.INFO] = {
-    str = M.config.diagnostics.icons.info,
-    hl = { "NvimTreeDiagnosticInfoIcon" },
-  }
-  M.HS_ICON[vim.diagnostic.severity.HINT] = {
-    str = M.config.diagnostics.icons.hint,
-    hl = { "NvimTreeDiagnosticHintIcon" },
-  }
-
-  for _, i in ipairs(M.HS_ICON) do
-    vim.fn.sign_define(i.hl[1], { text = i.str, texthl = i.hl[1] })
-  end
-end
-
-return M

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

@@ -1,12 +1,10 @@
 local M = {}
 
-M.diagnostics = require("nvim-tree.renderer.components.diagnostics")
 M.full_name = require("nvim-tree.renderer.components.full-name")
 M.devicons = require("nvim-tree.renderer.components.devicons")
 M.padding = require("nvim-tree.renderer.components.padding")
 
 function M.setup(opts)
-  M.diagnostics.setup(opts)
   M.full_name.setup(opts)
   M.devicons.setup(opts)
   M.padding.setup(opts)

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

@@ -35,38 +35,35 @@ local ICON_KEYS = {
 
 ---@class (exact) DecoratorDiagnostics: Decorator
 ---@field icons HighlightedString[]?
-local DecoratorDiagnostics = Decorator:new()
+local DecoratorDiagnostics = Decorator:extend()
 
----Static factory method
+---@class DecoratorDiagnostics
----@param opts table
+---@overload fun(explorer: DecoratorArgs): DecoratorDiagnostics
----@param explorer Explorer
----@return DecoratorDiagnostics
-function DecoratorDiagnostics:create(opts, explorer)
-  ---@type DecoratorDiagnostics
-  local o = {
-    explorer = explorer,
-    enabled = opts.diagnostics.enable,
-    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,
-  }
-  o = self:new(o)
 
-  if not o.enabled then
+---@private
-    return o
+---@param args DecoratorArgs
+function DecoratorDiagnostics:new(args)
+  Decorator.new(self, {
+    explorer       = args.explorer,
+    enabled        = true,
+    hl_pos         = HL_POSITION[args.explorer.opts.renderer.highlight_diagnostics] or HL_POSITION.none,
+    icon_placement = ICON_PLACEMENT[args.explorer.opts.renderer.icons.diagnostics_placement] or ICON_PLACEMENT.none,
+  })
+
+  if not self.enabled then
+    return
   end
 
-  if opts.renderer.icons.show.diagnostics then
+  if self.explorer.opts.renderer.icons.show.diagnostics then
-    o.icons = {}
+    self.icons = {}
     for name, sev in pairs(ICON_KEYS) do
-      o.icons[sev] = {
+      self.icons[sev] = {
-        str = opts.diagnostics.icons[name],
+        str = self.explorer.opts.diagnostics.icons[name],
         hl = { HG_ICON[sev] },
       }
-      o:define_sign(o.icons[sev])
+      self:define_sign(self.icons[sev])
     end
   end
-
-  return o
 end
 
 ---Diagnostic icon: diagnostics.enable, renderer.icons.show.diagnostics and node has status