From 8760d76c1d316aa46f141f3f2b80b853a2acc41e Mon Sep 17 00:00:00 2001 From: Alexander Courtis Date: Fri, 25 Oct 2024 14:35:48 +1100 Subject: [PATCH] chore: enable missing-local-export-doc --- .luarc.json | 2 +- lua/nvim-tree/renderer/components/icons.lua | 20 ++++++++++++++++++-- 2 files changed, 19 insertions(+), 3 deletions(-) diff --git a/.luarc.json b/.luarc.json index d8b3e691..b1f121b2 100644 --- a/.luarc.json +++ b/.luarc.json @@ -39,7 +39,7 @@ "lowercase-global": "Any", "missing-fields": "Any", "missing-global-doc": "Any", - "missing-local-export-doc": "None", + "missing-local-export-doc": "Any", "missing-parameter": "Any", "missing-return": "Any", "missing-return-value": "Any", diff --git a/lua/nvim-tree/renderer/components/icons.lua b/lua/nvim-tree/renderer/components/icons.lua index c62b1055..93f1a7bf 100644 --- a/lua/nvim-tree/renderer/components/icons.lua +++ b/lua/nvim-tree/renderer/components/icons.lua @@ -5,10 +5,16 @@ local function config_symlinks() M.i.symlink_arrow = M.config.symlink_arrow end +---@return string icon +---@return string? name local function empty() - return "" + return "", nil end +---@param node Node +---@param has_children boolean +---@return string icon +---@return string? name local function get_folder_icon_default(node, has_children) local is_symlink = node.links_to ~= nil local n @@ -32,6 +38,10 @@ local function get_folder_icon_default(node, has_children) return n, nil end +---@param node Node +---@param has_children boolean +---@return string icon +---@return string? name local function get_folder_icon_webdev(node, has_children) local icon, hl_group = M.devicons.get_icon(node.name, node.extension) if not M.config.web_devicons.folder.color then @@ -44,16 +54,22 @@ local function get_folder_icon_webdev(node, has_children) end end +---@return string icon +---@return string? name local function get_file_icon_default() local hl_group = "NvimTreeFileIcon" local icon = M.config.glyphs.default if #icon > 0 then return icon, hl_group else - return "" + return "", nil end end +---@param fname string +---@param extension string +---@return string icon +---@return string? name local function get_file_icon_webdev(fname, extension) local icon, hl_group = M.devicons.get_icon(fname, extension) if not M.config.web_devicons.file.color then