use factory pattern for decorators

Author: alex-courtis

lua/nvim-tree/renderer/builder.lua

@@ -68,14 +68,14 @@ function Builder:new(opts, explorer)
     virtual_lines = {},
     decorators = {
       -- priority order
-      DecoratorCut:new(opts, explorer),
-      DecoratorCopied:new(opts, explorer),
-      DecoratorDiagnostics:new(opts, explorer),
-      DecoratorBookmarks:new(opts, explorer),
-      DecoratorModified:new(opts, explorer),
-      DecoratorHidden:new(opts, explorer),
-      DecoratorOpened:new(opts, explorer),
-      DecoratorGit:new(opts, explorer),
+      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),
     },
     hidden_display = Builder:setup_hidden_display_function(opts),
   }

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

@@ -4,20 +4,22 @@ local ICON_PLACEMENT = require("nvim-tree.enum").ICON_PLACEMENT
 local Decorator = require("nvim-tree.renderer.decorator")
 
 ---@class (exact) DecoratorBookmarks: Decorator
----@field icon HighlightedString
+---@field icon HighlightedString?
 local DecoratorBookmarks = Decorator:new()
 
+---Static factory method
 ---@param opts table
 ---@param explorer Explorer
 ---@return DecoratorBookmarks
-function DecoratorBookmarks:new(opts, explorer)
-  local o = Decorator.new(self, {
+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,
-  })
-  ---@cast o DecoratorBookmarks
+  }
+  o = self:new(o) --[[@as DecoratorBookmarks]]
 
   if opts.renderer.icons.show.bookmarks then
     o.icon = {

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

@@ -5,20 +5,22 @@ local Decorator = require("nvim-tree.renderer.decorator")
 
 ---@class (exact) DecoratorCopied: Decorator
 ---@field enabled boolean
----@field icon HighlightedString|nil
+---@field icon HighlightedString?
 local DecoratorCopied = Decorator:new()
 
+---Static factory method
 ---@param opts table
 ---@param explorer Explorer
 ---@return DecoratorCopied
-function DecoratorCopied:new(opts, explorer)
-  local o = Decorator.new(self, {
+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,
-  })
-  ---@cast o DecoratorCopied
+  }
+  o = self:new(o) --[[@as DecoratorCopied]]
 
   return o
 end

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

@@ -4,21 +4,21 @@ local ICON_PLACEMENT = require("nvim-tree.enum").ICON_PLACEMENT
 local Decorator = require("nvim-tree.renderer.decorator")
 
 ---@class (exact) DecoratorCut: Decorator
----@field enabled boolean
----@field icon HighlightedString|nil
 local DecoratorCut = Decorator:new()
 
+---Static factory method
 ---@param opts table
 ---@param explorer Explorer
 ---@return DecoratorCut
-function DecoratorCut:new(opts, explorer)
-  local o = Decorator.new(self, {
+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,
-  })
-  ---@cast o DecoratorCut
+  }
+  o = self:new(o) --[[@as DecoratorCut]]
 
   return o
 end

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

@@ -33,20 +33,22 @@ local ICON_KEYS = {
 }
 
 ---@class (exact) DecoratorDiagnostics: Decorator
----@field icons HighlightedString[]
+---@field icons HighlightedString[]?
 local DecoratorDiagnostics = Decorator:new()
 
+---Static factory method
 ---@param opts table
 ---@param explorer Explorer
 ---@return DecoratorDiagnostics
-function DecoratorDiagnostics:new(opts, explorer)
-  local o = Decorator.new(self, {
+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,
-  })
-  ---@cast o DecoratorDiagnostics
+  }
+  o = self:new(o) --[[@as DecoratorDiagnostics]]
 
   if not o.enabled then
     return o

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

@@ -9,23 +9,25 @@ local Decorator = require("nvim-tree.renderer.decorator")
 ---@field ord number decreasing priority
 
 ---@class (exact) DecoratorGit: Decorator
----@field file_hl table<string, string> by porcelain status e.g. "AM"
----@field folder_hl table<string, string> by porcelain status
----@field icons_by_status HighlightedStringGit[] by human status
----@field icons_by_xy table<string, HighlightedStringGit[]> by porcelain status
+---@field file_hl table<string, string>? by porcelain status e.g. "AM"
+---@field folder_hl table<string, string>? by porcelain status
+---@field icons_by_status HighlightedStringGit[]? by human status
+---@field icons_by_xy table<string, HighlightedStringGit[]>? by porcelain status
 local DecoratorGit = Decorator:new()
 
+---Static factory method
 ---@param opts table
 ---@param explorer Explorer
 ---@return DecoratorGit
-function DecoratorGit:new(opts, explorer)
-  local o = Decorator.new(self, {
+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,
-  })
-  ---@cast o DecoratorGit
+  }
+  o = self:new(o) --[[@as DecoratorGit]]
 
   if not o.enabled then
     return o

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

@@ -3,20 +3,22 @@ local ICON_PLACEMENT = require("nvim-tree.enum").ICON_PLACEMENT
 local Decorator = require("nvim-tree.renderer.decorator")
 
 ---@class (exact) DecoratorHidden: Decorator
----@field icon HighlightedString|nil
+---@field icon HighlightedString?
 local DecoratorHidden = Decorator:new()
 
+---Static factory method
 ---@param opts table
 ---@param explorer Explorer
 ---@return DecoratorHidden
-function DecoratorHidden:new(opts, explorer)
-  local o = Decorator.new(self, {
+function DecoratorHidden:create(opts, explorer)
+  ---@type DecoratorHidden
+  local o = {
     explorer = explorer,
     enabled = true,
     hl_pos = HL_POSITION[opts.renderer.highlight_hidden] or HL_POSITION.none,
     icon_placement = ICON_PLACEMENT[opts.renderer.icons.hidden_placement] or ICON_PLACEMENT.none,
-  })
-  ---@cast o DecoratorHidden
+  }
+  o = self:new(o) --[[@as DecoratorHidden]]
 
   if opts.renderer.icons.show.hidden then
     o.icon = {

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

@@ -1,6 +1,8 @@
 local HL_POSITION = require("nvim-tree.enum").HL_POSITION
 local ICON_PLACEMENT = require("nvim-tree.enum").ICON_PLACEMENT
 
+---Abstract Decorator
+---Uses the factory pattern to instantiate child instances.
 ---@class (exact) Decorator
 ---@field private __index? table
 ---@field protected explorer Explorer

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

@@ -9,17 +9,19 @@ local Decorator = require("nvim-tree.renderer.decorator")
 ---@field icon HighlightedString|nil
 local DecoratorModified = Decorator:new()
 
+---Static factory method
 ---@param opts table
 ---@param explorer Explorer
 ---@return DecoratorModified
-function DecoratorModified:new(opts, explorer)
-  local o = Decorator.new(self, {
+function DecoratorModified:create(opts, explorer)
+  ---@type DecoratorModified
+  local o = {
     explorer = explorer,
     enabled = opts.modified.enable,
     hl_pos = HL_POSITION[opts.renderer.highlight_modified] or HL_POSITION.none,
     icon_placement = ICON_PLACEMENT[opts.renderer.icons.modified_placement] or ICON_PLACEMENT.none,
-  })
-  ---@cast o DecoratorModified
+  }
+  o = self:new(o) --[[@as DecoratorModified]]
 
   if not o.enabled then
     return o

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

@@ -10,17 +10,19 @@ local Decorator = require("nvim-tree.renderer.decorator")
 ---@field icon HighlightedString|nil
 local DecoratorOpened = Decorator:new()
 
+---Static factory method
 ---@param opts table
 ---@param explorer Explorer
 ---@return DecoratorOpened
-function DecoratorOpened:new(opts, explorer)
-  local o = Decorator.new(self, {
+function DecoratorOpened:create(opts, explorer)
+  ---@type DecoratorOpened
+  local o = {
     explorer = explorer,
     enabled = true,
     hl_pos = HL_POSITION[opts.renderer.highlight_opened_files] or HL_POSITION.none,
     icon_placement = ICON_PLACEMENT.none,
-  })
-  ---@cast o DecoratorOpened
+  }
+  o = self:new(o) --[[@as DecoratorOpened]]
 
   return o
 end