typechecked optargs constructors for decorators

This commit is contained in:
Alexander Courtis
2024-11-08 10:57:53 +11:00
parent b092915f17
commit f6392cf88a
4 changed files with 55 additions and 64 deletions

View File

@@ -9,9 +9,9 @@ local DecoratorCopied = require("nvim-tree.renderer.decorator.copied")
local DecoratorCut = require("nvim-tree.renderer.decorator.cut") 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 DecoratorGit = require("nvim-tree.renderer.decorator.git")
-- local DecoratorModified = require("nvim-tree.renderer.decorator.modified") local DecoratorModified = require("nvim-tree.renderer.decorator.modified")
-- local DecoratorHidden = require("nvim-tree.renderer.decorator.hidden") local DecoratorHidden = require("nvim-tree.renderer.decorator.hidden")
-- local DecoratorOpened = require("nvim-tree.renderer.decorator.opened") local DecoratorOpened = require("nvim-tree.renderer.decorator.opened")
local pad = require("nvim-tree.renderer.components.padding") local pad = require("nvim-tree.renderer.components.padding")
@@ -65,9 +65,9 @@ function Builder:new(opts, explorer)
DecoratorCopied({ explorer = explorer }), DecoratorCopied({ explorer = explorer }),
DecoratorDiagnostics({ explorer = explorer }), DecoratorDiagnostics({ explorer = explorer }),
DecoratorBookmarks({ explorer = explorer }), DecoratorBookmarks({ explorer = explorer }),
-- DecoratorModified({ explorer = explorer }), DecoratorModified({ explorer = explorer }),
-- DecoratorHidden({ explorer = explorer }), DecoratorHidden({ explorer = explorer }),
-- DecoratorOpened({ explorer = explorer }), DecoratorOpened({ explorer = explorer }),
DecoratorGit({ explorer = explorer }) DecoratorGit({ explorer = explorer })
}, },
hidden_display = Builder:setup_hidden_display_function(opts), hidden_display = Builder:setup_hidden_display_function(opts),

View File

@@ -6,31 +6,28 @@ local DirectoryNode = require("nvim-tree.node.directory")
---@class (exact) DecoratorHidden: Decorator ---@class (exact) DecoratorHidden: Decorator
---@field icon HighlightedString? ---@field icon HighlightedString?
local DecoratorHidden = Decorator:new() local DecoratorHidden = Decorator:extend()
---Static factory method ---@class DecoratorHidden
---@param opts table ---@overload fun(explorer: DecoratorArgs): DecoratorHidden
---@param explorer Explorer
---@return DecoratorHidden ---@private
function DecoratorHidden:create(opts, explorer) ---@param args DecoratorArgs
---@type DecoratorHidden function DecoratorHidden:new(args)
local o = { Decorator.new(self, {
explorer = explorer, explorer = args.explorer,
enabled = true, enabled = true,
hl_pos = HL_POSITION[opts.renderer.highlight_hidden] or HL_POSITION.none, hl_pos = HL_POSITION[args.explorer.opts.renderer.highlight_hidden] or HL_POSITION.none,
icon_placement = ICON_PLACEMENT[opts.renderer.icons.hidden_placement] or ICON_PLACEMENT.none, icon_placement = ICON_PLACEMENT[args.explorer.opts.renderer.icons.hidden_placement] or ICON_PLACEMENT.none,
} })
o = self:new(o)
if opts.renderer.icons.show.hidden then if self.explorer.opts.renderer.icons.show.hidden then
o.icon = { self.icon = {
str = opts.renderer.icons.glyphs.hidden, str = self.explorer.opts.renderer.icons.glyphs.hidden,
hl = { "NvimTreeHiddenIcon" }, hl = { "NvimTreeHiddenIcon" },
} }
o:define_sign(o.icon) self:define_sign(self.icon)
end end
return o
end end
---Hidden icon: renderer.icons.show.hidden and node starts with `.` (dotfile). ---Hidden icon: renderer.icons.show.hidden and node starts with `.` (dotfile).

View File

@@ -7,36 +7,33 @@ local Decorator = require("nvim-tree.renderer.decorator")
local DirectoryNode = require("nvim-tree.node.directory") local DirectoryNode = require("nvim-tree.node.directory")
---@class (exact) DecoratorModified: Decorator ---@class (exact) DecoratorModified: Decorator
---@field icon HighlightedString|nil ---@field icon HighlightedString?
local DecoratorModified = Decorator:new() local DecoratorModified = Decorator:extend()
---Static factory method ---@class DecoratorModified
---@param opts table ---@overload fun(explorer: DecoratorArgs): DecoratorModified
---@param explorer Explorer
---@return DecoratorModified
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,
}
o = self:new(o)
if not o.enabled then ---@private
return o ---@param args DecoratorArgs
function DecoratorModified:new(args)
Decorator.new(self, {
explorer = args.explorer,
enabled = true,
hl_pos = HL_POSITION[args.explorer.opts.renderer.highlight_modified] or HL_POSITION.none,
icon_placement = ICON_PLACEMENT[args.explorer.opts.renderer.icons.modified_placement] or ICON_PLACEMENT.none,
})
if not self.enabled then
return
end end
if opts.renderer.icons.show.modified then if self.explorer.opts.renderer.icons.show.modified then
o.icon = { self.icon = {
str = opts.renderer.icons.glyphs.modified, str = self.explorer.opts.renderer.icons.glyphs.modified,
hl = { "NvimTreeModifiedIcon" }, hl = { "NvimTreeModifiedIcon" },
} }
o:define_sign(o.icon) self:define_sign(self.icon)
end end
return o
end end
---Modified icon: modified.enable, renderer.icons.show.modified and node is modified ---Modified icon: modified.enable, renderer.icons.show.modified and node is modified

View File

@@ -7,23 +7,20 @@ local Decorator = require("nvim-tree.renderer.decorator")
---@class (exact) DecoratorOpened: Decorator ---@class (exact) DecoratorOpened: Decorator
---@field icon HighlightedString|nil ---@field icon HighlightedString|nil
local DecoratorOpened = Decorator:new() local DecoratorOpened = Decorator:extend()
---Static factory method ---@class DecoratorOpened
---@param opts table ---@overload fun(explorer: DecoratorArgs): DecoratorOpened
---@param explorer Explorer
---@return DecoratorOpened ---@private
function DecoratorOpened:create(opts, explorer) ---@param args DecoratorArgs
---@type DecoratorOpened function DecoratorOpened:new(args)
local o = { Decorator.new(self, {
explorer = explorer, explorer = args.explorer,
enabled = true, enabled = true,
hl_pos = HL_POSITION[opts.renderer.highlight_opened_files] or HL_POSITION.none, hl_pos = HL_POSITION[args.explorer.opts.renderer.highlight_opened_files] or HL_POSITION.none,
icon_placement = ICON_PLACEMENT.none, icon_placement = ICON_PLACEMENT.none,
} })
o = self:new(o)
return o
end end
---Opened highlight: renderer.highlight_opened_files and node has an open buffer ---Opened highlight: renderer.highlight_opened_files and node has an open buffer