typechecked optargs constructors for decorators, WIP

Author: alex-courtis

lua/nvim-tree/renderer/builder.lua

@@ -7,11 +7,11 @@ 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")
-local DecoratorOpened = require("nvim-tree.renderer.decorator.opened")
+-- local DecoratorModified = require("nvim-tree.renderer.decorator.modified")
+-- local DecoratorHidden = require("nvim-tree.renderer.decorator.hidden")
+-- local DecoratorOpened = require("nvim-tree.renderer.decorator.opened")
 
 local pad = require("nvim-tree.renderer.components.padding")
 
@@ -61,14 +61,14 @@ function Builder:new(opts, explorer)
     virtual_lines = {},
     decorators = {
       -- priority order
-      DecoratorCut:create(opts, explorer),
-      DecoratorCopied:create(opts, explorer),
-      DecoratorDiagnostics:create(opts, explorer),
-      DecoratorBookmarks:create(opts, explorer),
-      DecoratorModified:create(opts, explorer),
-      DecoratorHidden:create(opts, explorer),
-      DecoratorOpened:create(opts, explorer),
-      DecoratorGit:create(opts, explorer),
+      DecoratorCut({ explorer = explorer }),
+      DecoratorCopied({ explorer = explorer }),
+      -- DecoratorDiagnostics({ explorer = explorer }),
+      DecoratorBookmarks({ explorer = explorer }),
+      -- DecoratorModified({ explorer = explorer }),
+      -- DecoratorHidden({ explorer = explorer }),
+      -- DecoratorOpened({ explorer = explorer }),
+      DecoratorGit({ explorer = explorer })
     },
     hidden_display = Builder:setup_hidden_display_function(opts),
   }

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

@@ -5,31 +5,28 @@ local Decorator = require("nvim-tree.renderer.decorator")
 
 ---@class (exact) DecoratorBookmarks: Decorator
 ---@field icon HighlightedString?
-local DecoratorBookmarks = Decorator:new()
-
----Static factory method
----@param opts table
----@param explorer Explorer
----@return DecoratorBookmarks
-function DecoratorBookmarks:create(opts, explorer)
-  ---@type DecoratorBookmarks
-  local o = {
-    explorer = explorer,
-    enabled = true,
-    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,
-  }
-  o = self:new(o)
-
-  if opts.renderer.icons.show.bookmarks then
-    o.icon = {
-      str = opts.renderer.icons.glyphs.bookmark,
+local DecoratorBookmarks = Decorator:extend()
+
+---@class DecoratorBookmarks
+---@overload fun(explorer: DecoratorArgs): DecoratorBookmarks
+
+---@private
+---@param args DecoratorArgs
+function DecoratorBookmarks:new(args)
+  Decorator.new(self, {
+    explorer       = args.explorer,
+    enabled        = true,
+    hl_pos         = HL_POSITION[args.explorer.opts.renderer.highlight_bookmarks] or HL_POSITION.none,
+    icon_placement = ICON_PLACEMENT[args.explorer.opts.renderer.icons.bookmarks_placement] or ICON_PLACEMENT.none,
+  })
+
+  if self.explorer.opts.renderer.icons.show.bookmarks then
+    self.icon = {
+      str = self.explorer.opts.renderer.icons.glyphs.bookmark,
       hl = { "NvimTreeBookmarkIcon" },
     }
-    o:define_sign(o.icon)
+    self:define_sign(self.icon)
   end
-
-  return o
 end
 
 ---Bookmark icon: renderer.icons.show.bookmarks and node is marked

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

@@ -4,24 +4,20 @@ local ICON_PLACEMENT = require("nvim-tree.enum").ICON_PLACEMENT
 local Decorator = require("nvim-tree.renderer.decorator")
 
 ---@class (exact) DecoratorCopied: Decorator
----@field icon HighlightedString?
-local DecoratorCopied = Decorator:new()
+local DecoratorCopied = Decorator:extend()
 
----Static factory method
----@param opts table
----@param explorer Explorer
----@return DecoratorCopied
-function DecoratorCopied:create(opts, explorer)
-  ---@type DecoratorCopied
-  local o = {
-    explorer = explorer,
-    enabled = true,
-    hl_pos = HL_POSITION[opts.renderer.highlight_clipboard] or HL_POSITION.none,
-    icon_placement = ICON_PLACEMENT.none,
-  }
-  o = self:new(o)
+---@class DecoratorCopied
+---@overload fun(explorer: DecoratorArgs): DecoratorCopied
 
-  return o
+---@private
+---@param args DecoratorArgs
+function DecoratorCopied:new(args)
+  Decorator.new(self, {
+    explorer       = args.explorer,
+    enabled        = true,
+    hl_pos         = HL_POSITION[args.explorer.opts.renderer.highlight_clipboard] or HL_POSITION.none,
+    icon_placement = ICON_PLACEMENT.none,
+  })
 end
 
 ---Copied highlight: renderer.highlight_clipboard and node is copied

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

@@ -4,23 +4,20 @@ local ICON_PLACEMENT = require("nvim-tree.enum").ICON_PLACEMENT
 local Decorator = require("nvim-tree.renderer.decorator")
 
 ---@class (exact) DecoratorCut: Decorator
-local DecoratorCut = Decorator:new()
+local DecoratorCut = Decorator:extend()
 
----Static factory method
----@param opts table
----@param explorer Explorer
----@return DecoratorCut
-function DecoratorCut:create(opts, explorer)
-  ---@type DecoratorCut
-  local o = {
-    explorer = explorer,
-    enabled = true,
-    hl_pos = HL_POSITION[opts.renderer.highlight_clipboard] or HL_POSITION.none,
-    icon_placement = ICON_PLACEMENT.none,
-  }
-  o = self:new(o)
+---@class DecoratorCut
+---@overload fun(explorer: DecoratorArgs): DecoratorCut
 
-  return o
+---@private
+---@param args DecoratorArgs
+function DecoratorCut:new(args)
+  Decorator.new(self, {
+    explorer       = args.explorer,
+    enabled        = true,
+    hl_pos         = HL_POSITION[args.explorer.opts.renderer.highlight_clipboard] or HL_POSITION.none,
+    icon_placement = ICON_PLACEMENT.none,
+  })
 end
 
 ---Cut highlight: renderer.highlight_clipboard and node is cut

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

@@ -20,40 +20,37 @@ local DirectoryNode = require("nvim-tree.node.directory")
 ---@field folder_hl_by_xy table<GitXY, string>?
 ---@field icons_by_status GitIconsByStatus?
 ---@field icons_by_xy GitIconsByXY?
-local DecoratorGit = Decorator:new()
-
----Static factory method
----@param opts table
----@param explorer Explorer
----@return DecoratorGit
-function DecoratorGit:create(opts, explorer)
-  ---@type DecoratorGit
-  local o = {
-    explorer = explorer,
-    enabled = opts.git.enable,
-    hl_pos = HL_POSITION[opts.renderer.highlight_git] or HL_POSITION.none,
-    icon_placement = ICON_PLACEMENT[opts.renderer.icons.git_placement] or ICON_PLACEMENT.none,
-  }
-  o = self:new(o)
-
-  if not o.enabled then
-    return o
+local DecoratorGit = Decorator:extend()
+
+---@class DecoratorGit
+---@overload fun(explorer: DecoratorArgs): DecoratorGit
+
+---@private
+---@param args DecoratorArgs
+function DecoratorGit:new(args)
+  Decorator.new(self, {
+    explorer       = args.explorer,
+    enabled        = args.explorer.opts.git.enable,
+    hl_pos         = HL_POSITION[args.explorer.opts.renderer.highlight_git] or HL_POSITION.none,
+    icon_placement = ICON_PLACEMENT[args.explorer.opts.renderer.icons.git_placement] or ICON_PLACEMENT.none,
+  })
+
+  if not self.enabled then
+    return
   end
 
-  if o.hl_pos ~= HL_POSITION.none then
-    o:build_file_folder_hl_by_xy()
+  if self.hl_pos ~= HL_POSITION.none then
+    self:build_file_folder_hl_by_xy()
   end
 
-  if opts.renderer.icons.show.git then
-    o:build_icons_by_status(opts.renderer.icons.glyphs.git)
-    o:build_icons_by_xy(o.icons_by_status)
+  if self.explorer.opts.renderer.icons.show.git then
+    self:build_icons_by_status(self.explorer.opts.renderer.icons.glyphs.git)
+    self:build_icons_by_xy(self.icons_by_status)
 
-    for _, icon in pairs(o.icons_by_status) do
+    for _, icon in pairs(self.icons_by_status) do
       self:define_sign(icon)
     end
   end
-
-  return o
 end
 
 ---@param glyphs GitGlyphsByStatus

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

@@ -1,4 +1,4 @@
-local Class = require("nvim-tree.class")
+local Class = require("nvim-tree.classic")
 
 local HL_POSITION = require("nvim-tree.enum").HL_POSITION
 local ICON_PLACEMENT = require("nvim-tree.enum").ICON_PLACEMENT
@@ -10,7 +10,24 @@ local ICON_PLACEMENT = require("nvim-tree.enum").ICON_PLACEMENT
 ---@field protected enabled boolean
 ---@field protected hl_pos HL_POSITION
 ---@field protected icon_placement ICON_PLACEMENT
-local Decorator = Class:new()
+local Decorator = Class:extend()
+
+---@class (exact) DecoratorArgs
+---@field explorer Explorer
+
+---@class (exact) AbstractDecoratorArgs: DecoratorArgs
+---@field enabled boolean
+---@field hl_pos HL_POSITION
+---@field icon_placement ICON_PLACEMENT
+
+---@protected
+---@param args AbstractDecoratorArgs
+function Decorator:new(args)
+  self.explorer       = args.explorer
+  self.enabled        = args.enabled
+  self.hl_pos         = args.hl_pos
+  self.icon_placement = args.icon_placement
+end
 
 ---Maybe highlight groups
 ---@param node Node