7a4ff1a516
* feat(#2948): add UserDecorator, proof of concept * feat(#2948): add UserDecorator, proof of concept * feat(#2948): add UserDecorator, proof of concept * feat(#2948): add UserDecorator * feat(#2948): add UserDecorator * feat(#2948): add UserDecorator * feat(#2948): add Decorator node icon override * feat(#2948): add nvim_tree.api.* node classes * feat(#2948): extract _meta following nvim pattern * feat(#2948): extract _meta following nvim pattern * feat(#2948): add decorator registry and order * feat(#2948): add decorator registry and order * feat(#2948): tidy * feat(#2948): document API * feat(#2948): document API * feat(#2948): document API * feat(#2948): pass api nodes to user decorators * feat(#2948): document API * feat(#2948): use renderer.decorators to define order and register * feat(#2948): tidy decorator args and complete documentation * feat(#2948): decorator classes specified by prefix rather than suffix * feat(#2948): improve doc * feat(#2948): improve doc * feat(#2948): improve doc * feat(#2948): additional user decorator safety * feat(#2948): create nvim_tree.api.decorator.UserDecorator class in API, add :extend * feat(#2948): improve doc
108 lines
2.7 KiB
Lua
108 lines
2.7 KiB
Lua
local git_utils = require("nvim-tree.git.utils")
|
|
local icons = require("nvim-tree.renderer.components.devicons")
|
|
local utils = require("nvim-tree.utils")
|
|
|
|
local Node = require("nvim-tree.node")
|
|
|
|
local PICTURE_MAP = {
|
|
jpg = true,
|
|
jpeg = true,
|
|
png = true,
|
|
gif = true,
|
|
webp = true,
|
|
jxl = true,
|
|
}
|
|
|
|
---@class (exact) FileNode: Node
|
|
---@field extension string
|
|
local FileNode = Node:extend()
|
|
|
|
---@class FileNode
|
|
---@overload fun(args: NodeArgs): FileNode
|
|
|
|
---@protected
|
|
---@param args NodeArgs
|
|
function FileNode:new(args)
|
|
FileNode.super.new(self, args)
|
|
|
|
self.type = "file"
|
|
self.extension = string.match(args.name, ".?[^.]+%.(.*)") or ""
|
|
self.executable = utils.is_executable(args.absolute_path)
|
|
end
|
|
|
|
function FileNode:destroy()
|
|
Node.destroy(self)
|
|
end
|
|
|
|
---Update the GitStatus of the file
|
|
---@param parent_ignored boolean
|
|
---@param project GitProject?
|
|
function FileNode:update_git_status(parent_ignored, project)
|
|
self.git_status = git_utils.git_status_file(parent_ignored, project, self.absolute_path, nil)
|
|
end
|
|
|
|
---@return GitXY[]?
|
|
function FileNode:get_git_xy()
|
|
if not self.git_status then
|
|
return nil
|
|
end
|
|
|
|
return self.git_status.file and { self.git_status.file }
|
|
end
|
|
|
|
---@return HighlightedString icon
|
|
function FileNode:highlighted_icon()
|
|
if not self.explorer.opts.renderer.icons.show.file then
|
|
return self:highlighted_icon_empty()
|
|
end
|
|
|
|
local str, hl
|
|
|
|
-- devicon if enabled and available, fallback to default
|
|
if self.explorer.opts.renderer.icons.web_devicons.file.enable then
|
|
str, hl = icons.get_icon(self.name, nil, { default = true })
|
|
if not self.explorer.opts.renderer.icons.web_devicons.file.color then
|
|
hl = nil
|
|
end
|
|
end
|
|
|
|
-- default icon from opts
|
|
if not str then
|
|
str = self.explorer.opts.renderer.icons.glyphs.default
|
|
end
|
|
|
|
-- default hl
|
|
if not hl then
|
|
hl = "NvimTreeFileIcon"
|
|
end
|
|
|
|
return { str = str, hl = { hl } }
|
|
end
|
|
|
|
---@return HighlightedString name
|
|
function FileNode:highlighted_name()
|
|
local hl
|
|
if vim.tbl_contains(self.explorer.opts.renderer.special_files, self.absolute_path) or vim.tbl_contains(self.explorer.opts.renderer.special_files, self.name) then
|
|
hl = "NvimTreeSpecialFile"
|
|
elseif self.executable then
|
|
hl = "NvimTreeExecFile"
|
|
elseif PICTURE_MAP[self.extension] then
|
|
hl = "NvimTreeImageFile"
|
|
end
|
|
|
|
return { str = self.name, hl = { hl } }
|
|
end
|
|
|
|
---Create a sanitized partial copy of a node
|
|
---@param api_nodes table<number, nvim_tree.api.Node>? optional map of uids to api node to populate
|
|
---@return nvim_tree.api.FileNode cloned
|
|
function FileNode:clone(api_nodes)
|
|
local clone = Node.clone(self, api_nodes) --[[@as nvim_tree.api.FileNode]]
|
|
|
|
clone.extension = self.extension
|
|
|
|
return clone
|
|
end
|
|
|
|
return FileNode
|