chore: resolve undefined-field warnings, fix link git statuses, rewrite devicons (#2968)

* add todo * refactor(#2886): multi instance: node class refactoring: extract links, *_git_status (#2944) * extract DirectoryLinkNode and FileLinkNode, move Node methods to children * temporarily move DirectoryNode methods into BaseNode for easier reviewing * move mostly unchanged DirectoryNode methods back to BaseNode * tidy * git.git_status_file takes an array * update git status of links * luacheck hack * safer git_status_dir * refactor(#2886): multi instance: node class refactoring: DirectoryNode:expand_or_collapse (#2957) move expand_or_collapse to DirectoryNode * refactor(#2886): multi instance: node group functions refactoring (#2959) * move last_group_node to DirectoryNode * move add BaseNode:as and more doc * revert parameter name changes * revert parameter name changes * add Class * move group methods into DN * tidy group methods * tidy group methods * tidy group methods * tidy group methods * parent is DirectoryNode * tidy expand all * BaseNode -> Node * move watcher to DirectoryNode * last_group_node is DirectoryNode only * simplify create-file * simplify parent * simplify collapse-all * simplify live-filter * style * move lib.get_cursor_position to Explorer * move lib.get_node_at_cursor to Explorer * move lib.get_nodes to Explorer * move place_cursor_on_node to Explorer * resolve resource leak in purge_all_state * move many autocommands into Explorer * post merge tidy * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * Revert "chore: resolve undefined-field" This reverts commit be546ff18d41f28466b065c857e1e041659bd2c8. * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * Revert "chore: resolve undefined-field" This reverts commit e82db1c44d. * chore: resolve undefined-field * chore: class new is now generic * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * Revert "chore: resolve undefined-field" This reverts commit 0e9b844d22. * move icon builders into node classes * move icon builders into node classes * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * chore: resolve undefined-field * move folder specifics from icons to Directory * move folder specifics from icons to Directory * move folder specifics from icons to Directory * move folder specifics from icons to Directory * move file specifics from icons to File * clean up sorters * chore: resolve undefined-field * tidy hl icon name * file devicon uses library to fall back * file devicon uses library to fall back * file devicon uses library to fall back
2024-11-03 14:06:12 +11:00
parent c22124b374
commit 610a1c189b
43 changed files with 1073 additions and 887 deletions
--- a/lua/nvim-tree/actions/fs/clipboard.lua
+++ b/lua/nvim-tree/actions/fs/clipboard.lua
@@ -9,31 +9,34 @@ local find_file = require("nvim-tree.actions.finders.find-file").fn

 local DirectoryNode = require("nvim-tree.node.directory")

---@enum ACTION
-local ACTION = {
-  copy = "copy",
-  cut = "cut",
-}
+---@alias ClipboardAction "copy" | "cut"
+---@alias ClipboardData table<ClipboardAction, Node[]>
+
+---@alias ClipboardActionFn fun(source: string, dest: string): boolean, string?

 ---@class Clipboard to handle all actions.fs clipboard API
 ---@field config table hydrated user opts.filters
 ---@field private explorer Explorer
---@field private data table<ACTION, Node[]>
+---@field private data ClipboardData
+---@field private clipboard_name string
+---@field private reg string
 local Clipboard = {}

 ---@param opts table user options
 ---@param explorer Explorer
 ---@return Clipboard
 function Clipboard:new(opts, explorer)
+  ---@type Clipboard
  local o = {
    explorer = explorer,
    data = {
-      [ACTION.copy] = {},
-      [ACTION.cut] = {},
+      copy = {},
+      cut = {},
    },
+    clipboard_name = opts.actions.use_system_clipboard and "system" or "neovim",
+    reg = opts.actions.use_system_clipboard and "+" or "1",
    config = {
      filesystem_watchers = opts.filesystem_watchers,
-      actions = opts.actions,
    },
  }

@@ -47,13 +50,11 @@ end
 ---@return boolean
 ---@return string|nil
 local function do_copy(source, destination)
-  local source_stats, handle
-  local success, errmsg
+  local source_stats, err = vim.loop.fs_stat(source)

-  source_stats, errmsg = vim.loop.fs_stat(source)
  if not source_stats then
-    log.line("copy_paste", "do_copy fs_stat '%s' failed '%s'", source, errmsg)
-    return false, errmsg
+    log.line("copy_paste", "do_copy fs_stat '%s' failed '%s'", source, err)
+    return false, err
  end

  log.line("copy_paste", "do_copy %s '%s' -> '%s'", source_stats.type, source, destination)
@@ -64,25 +65,28 @@ local function do_copy(source, destination)
  end

  if source_stats.type == "file" then
-    success, errmsg = vim.loop.fs_copyfile(source, destination)
+    local success
+    success, err = vim.loop.fs_copyfile(source, destination)
    if not success then
-      log.line("copy_paste", "do_copy fs_copyfile failed '%s'", errmsg)
-      return false, errmsg
+      log.line("copy_paste", "do_copy fs_copyfile failed '%s'", err)
+      return false, err
    end
    return true
  elseif source_stats.type == "directory" then
-    handle, errmsg = vim.loop.fs_scandir(source)
+    local handle
+    handle, err = vim.loop.fs_scandir(source)
    if type(handle) == "string" then
      return false, handle
    elseif not handle then
-      log.line("copy_paste", "do_copy fs_scandir '%s' failed '%s'", source, errmsg)
-      return false, errmsg
+      log.line("copy_paste", "do_copy fs_scandir '%s' failed '%s'", source, err)
+      return false, err
    end

-    success, errmsg = vim.loop.fs_mkdir(destination, source_stats.mode)
+    local success
+    success, err = vim.loop.fs_mkdir(destination, source_stats.mode)
    if not success then
-      log.line("copy_paste", "do_copy fs_mkdir '%s' failed '%s'", destination, errmsg)
-      return false, errmsg
+      log.line("copy_paste", "do_copy fs_mkdir '%s' failed '%s'", destination, err)
+      return false, err
    end

    while true do
@@ -93,15 +97,15 @@ local function do_copy(source, destination)

      local new_name = utils.path_join({ source, name })
      local new_destination = utils.path_join({ destination, name })
-      success, errmsg = do_copy(new_name, new_destination)
+      success, err = do_copy(new_name, new_destination)
      if not success then
-        return false, errmsg
+        return false, err
      end
    end
  else
-    errmsg = string.format("'%s' illegal file type '%s'", source, source_stats.type)
-    log.line("copy_paste", "do_copy %s", errmsg)
-    return false, errmsg
+    err = string.format("'%s' illegal file type '%s'", source, source_stats.type)
+    log.line("copy_paste", "do_copy %s", err)
+    return false, err
  end

  return true
@@ -109,28 +113,26 @@ end

 ---@param source string
 ---@param dest string
---@param action ACTION
---@param action_fn fun(source: string, dest: string)
+---@param action ClipboardAction
+---@param action_fn ClipboardActionFn
 ---@return boolean|nil -- success
 ---@return string|nil -- error message
 local function do_single_paste(source, dest, action, action_fn)
-  local dest_stats
-  local success, errmsg, errcode
  local notify_source = notify.render_path(source)

  log.line("copy_paste", "do_single_paste '%s' -> '%s'", source, dest)

-  dest_stats, errmsg, errcode = vim.loop.fs_stat(dest)
-  if not dest_stats and errcode ~= "ENOENT" then
-    notify.error("Could not " .. action .. " " .. notify_source .. " - " .. (errmsg or "???"))
-    return false, errmsg
+  local dest_stats, err, err_name = vim.loop.fs_stat(dest)
+  if not dest_stats and err_name ~= "ENOENT" then
+    notify.error("Could not " .. action .. " " .. notify_source .. " - " .. (err or "???"))
+    return false, err
  end

  local function on_process()
-    success, errmsg = action_fn(source, dest)
+    local success, error = action_fn(source, dest)
    if not success then
-      notify.error("Could not " .. action .. " " .. notify_source .. " - " .. (errmsg or "???"))
-      return false, errmsg
+      notify.error("Could not " .. action .. " " .. notify_source .. " - " .. (error or "???"))
+      return false, error
    end

    find_file(utils.path_remove_trailing(dest))
@@ -173,7 +175,7 @@ local function do_single_paste(source, dest, action, action_fn)
 end

 ---@param node Node
---@param clip table
+---@param clip ClipboardData
 local function toggle(node, clip)
  if node.name == ".." then
    return
@@ -191,8 +193,8 @@ end

 ---Clear copied and cut
 function Clipboard:clear_clipboard()
-  self.data[ACTION.copy] = {}
-  self.data[ACTION.cut] = {}
+  self.data.copy = {}
+  self.data.cut = {}
  notify.info("Clipboard has been emptied.")
  self.explorer.renderer:draw()
 end
@@ -200,29 +202,32 @@ end
 ---Copy one node
 ---@param node Node
 function Clipboard:copy(node)
-  utils.array_remove(self.data[ACTION.cut], node)
-  toggle(node, self.data[ACTION.copy])
+  utils.array_remove(self.data.cut, node)
+  toggle(node, self.data.copy)
  self.explorer.renderer:draw()
 end

 ---Cut one node
 ---@param node Node
 function Clipboard:cut(node)
-  utils.array_remove(self.data[ACTION.copy], node)
-  toggle(node, self.data[ACTION.cut])
+  utils.array_remove(self.data.copy, node)
+  toggle(node, self.data.cut)
  self.explorer.renderer:draw()
 end

 ---Paste cut or cop
 ---@private
 ---@param node Node
---@param action ACTION
---@param action_fn fun(source: string, dest: string)
+---@param action ClipboardAction
+---@param action_fn ClipboardActionFn
 function Clipboard:do_paste(node, action, action_fn)
  if node.name == ".." then
    node = self.explorer
-  elseif node:is(DirectoryNode) then
-    node = node:last_group_node()
+  else
+    local dir = node:as(DirectoryNode)
+    if dir then
+      node = dir:last_group_node()
+    end
  end
  local clip = self.data[action]
  if #clip == 0 then
@@ -230,10 +235,10 @@ function Clipboard:do_paste(node, action, action_fn)
  end

  local destination = node.absolute_path
-  local stats, errmsg, errcode = vim.loop.fs_stat(destination)
-  if not stats and errcode ~= "ENOENT" then
-    log.line("copy_paste", "do_paste fs_stat '%s' failed '%s'", destination, errmsg)
-    notify.error("Could not " .. action .. " " .. notify.render_path(destination) .. " - " .. (errmsg or "???"))
+  local stats, err, err_name = vim.loop.fs_stat(destination)
+  if not stats and err_name ~= "ENOENT" then
+    log.line("copy_paste", "do_paste fs_stat '%s' failed '%s'", destination, err)
+    notify.error("Could not " .. action .. " " .. notify.render_path(destination) .. " - " .. (err or "???"))
    return
  end
  local is_dir = stats and stats.type == "directory"
@@ -278,24 +283,24 @@ end
 ---Paste cut (if present) or copy (if present)
 ---@param node Node
 function Clipboard:paste(node)
-  if self.data[ACTION.cut][1] ~= nil then
-    self:do_paste(node, ACTION.cut, do_cut)
-  elseif self.data[ACTION.copy][1] ~= nil then
-    self:do_paste(node, ACTION.copy, do_copy)
+  if self.data.cut[1] ~= nil then
+    self:do_paste(node, "cut", do_cut)
+  elseif self.data.copy[1] ~= nil then
+    self:do_paste(node, "copy", do_copy)
  end
 end

 function Clipboard:print_clipboard()
  local content = {}
-  if #self.data[ACTION.cut] > 0 then
+  if #self.data.cut > 0 then
    table.insert(content, "Cut")
-    for _, node in pairs(self.data[ACTION.cut]) do
+    for _, node in pairs(self.data.cut) do
      table.insert(content, " * " .. (notify.render_path(node.absolute_path)))
    end
  end
-  if #self.data[ACTION.copy] > 0 then
+  if #self.data.copy > 0 then
    table.insert(content, "Copy")
-    for _, node in pairs(self.data[ACTION.copy]) do
+    for _, node in pairs(self.data.copy) do
      table.insert(content, " * " .. (notify.render_path(node.absolute_path)))
    end
  end
@@ -305,65 +310,45 @@ end

 ---@param content string
 function Clipboard:copy_to_reg(content)
-  local clipboard_name
-  local reg
-  if self.config.actions.use_system_clipboard == true then
-    clipboard_name = "system"
-    reg = "+"
-  else
-    clipboard_name = "neovim"
-    reg = "1"
-  end
-
  -- manually firing TextYankPost does not set vim.v.event
  -- workaround: create a scratch buffer with the clipboard contents and send a yank command
  local temp_buf = vim.api.nvim_create_buf(false, true)
  vim.api.nvim_buf_set_text(temp_buf, 0, 0, 0, 0, { content })
  vim.api.nvim_buf_call(temp_buf, function()
-    vim.cmd(string.format('normal! "%sy$', reg))
+    vim.cmd(string.format('normal! "%sy$', self.reg))
  end)
  vim.api.nvim_buf_delete(temp_buf, {})

-  notify.info(string.format("Copied %s to %s clipboard!", content, clipboard_name))
+  notify.info(string.format("Copied %s to %s clipboard!", content, self.clipboard_name))
 end

 ---@param node Node
 function Clipboard:copy_filename(node)
-  local content
-
  if node.name == ".." then
    -- root
-    content = vim.fn.fnamemodify(self.explorer.absolute_path, ":t")
+    self:copy_to_reg(vim.fn.fnamemodify(self.explorer.absolute_path, ":t"))
  else
    -- node
-    content = node.name
+    self:copy_to_reg(node.name)
  end
-
-  self:copy_to_reg(content)
 end

 ---@param node Node
 function Clipboard:copy_basename(node)
-  local content
-
  if node.name == ".." then
    -- root
-    content = vim.fn.fnamemodify(self.explorer.absolute_path, ":t:r")
+    self:copy_to_reg(vim.fn.fnamemodify(self.explorer.absolute_path, ":t:r"))
  else
    -- node
-    content = vim.fn.fnamemodify(node.name, ":r")
+    self:copy_to_reg(vim.fn.fnamemodify(node.name, ":r"))
  end
-
-  self:copy_to_reg(content)
 end

 ---@param node Node
 function Clipboard:copy_path(node)
-  local content
-
  if node.name == ".." then
    -- root
-    content = utils.path_add_trailing("")
+    self:copy_to_reg(utils.path_add_trailing(""))
  else
    -- node
    local absolute_path = node.absolute_path
@@ -373,10 +358,12 @@ function Clipboard:copy_path(node)
    end

    local relative_path = utils.path_relative(absolute_path, cwd)
-    content = node.nodes ~= nil and utils.path_add_trailing(relative_path) or relative_path
+    if node:is(DirectoryNode) then
+      self:copy_to_reg(utils.path_add_trailing(relative_path))
+    else
+      self:copy_to_reg(relative_path)
+    end
  end
-
-  self:copy_to_reg(content)
 end

 ---@param node Node
@@ -394,14 +381,14 @@ end
 ---@param node Node
 ---@return boolean
 function Clipboard:is_cut(node)
-  return vim.tbl_contains(self.data[ACTION.cut], node)
+  return vim.tbl_contains(self.data.cut, node)
 end

 ---Node is copied. Will not be cut.
 ---@param node Node
 ---@return boolean
 function Clipboard:is_copied(node)
-  return vim.tbl_contains(self.data[ACTION.copy], node)
+  return vim.tbl_contains(self.data.copy, node)
 end

 return Clipboard
--- a/lua/nvim-tree/actions/fs/create-file.lua
+++ b/lua/nvim-tree/actions/fs/create-file.lua
@@ -34,7 +34,7 @@ end

 ---@param node Node?
 function M.fn(node)
-  node = node or core.get_explorer() --[[@as Node]]
+  node = node or core.get_explorer()
  if not node then
    return
  end
--- a/lua/nvim-tree/actions/fs/remove-file.lua
+++ b/lua/nvim-tree/actions/fs/remove-file.lua
@@ -5,6 +5,9 @@ local view = require("nvim-tree.view")
 local lib = require("nvim-tree.lib")
 local notify = require("nvim-tree.notify")

+local DirectoryLinkNode = require("nvim-tree.node.directory-link")
+local DirectoryNode = require("nvim-tree.node.directory")
+
 local M = {
  config = {},
 }
@@ -89,7 +92,7 @@ end
 ---@param node Node
 function M.remove(node)
  local notify_node = notify.render_path(node.absolute_path)
-  if node.nodes ~= nil and not node.link_to then
+  if node:is(DirectoryNode) and not node:is(DirectoryLinkNode) then
    local success = remove_dir(node.absolute_path)
    if not success then
      notify.error("Could not remove " .. notify_node)
--- a/lua/nvim-tree/actions/fs/rename-file.lua
+++ b/lua/nvim-tree/actions/fs/rename-file.lua
@@ -125,8 +125,9 @@ function M.fn(default_modifier)
      return
    end

-    if node:is(DirectoryNode) then
-      node = node:last_group_node()
+    local dir = node:as(DirectoryNode)
+    if dir then
+      node = dir:last_group_node()
    end
    if node.name == ".." then
      return
--- a/lua/nvim-tree/actions/fs/trash.lua
+++ b/lua/nvim-tree/actions/fs/trash.lua
@@ -2,6 +2,9 @@ local core = require("nvim-tree.core")
 local lib = require("nvim-tree.lib")
 local notify = require("nvim-tree.notify")

+local DirectoryLinkNode = require("nvim-tree.node.directory-link")
+local DirectoryNode = require("nvim-tree.node.directory")
+
 local M = {
  config = {},
 }
@@ -54,7 +57,7 @@ function M.remove(node)

  local explorer = core.get_explorer()

-  if node.nodes ~= nil and not node.link_to then
+  if node:is(DirectoryNode) and not node:is(DirectoryLinkNode) then
    trash_path(function(_, rc)
      if rc ~= 0 then
        notify.warn("trash failed: " .. err_msg .. "; please see :help nvim-tree.trash")
--- a/lua/nvim-tree/actions/moves/item.lua
+++ b/lua/nvim-tree/actions/moves/item.lua
@@ -3,6 +3,7 @@ local view = require("nvim-tree.view")
 local core = require("nvim-tree.core")
 local diagnostics = require("nvim-tree.diagnostics")

+local FileNode = require("nvim-tree.node.file")
 local DirectoryNode = require("nvim-tree.node.directory")

 local M = {}
@@ -10,14 +11,14 @@ local MAX_DEPTH = 100

 ---Return the status of the node or nil if no status, depending on the type of
 ---status.
---@param node table node to inspect
---@param what string type of status
---@param skip_gitignored boolean default false
+---@param node Node to inspect
+---@param what string? type of status
+---@param skip_gitignored boolean? default false
 ---@return boolean
 local function status_is_valid(node, what, skip_gitignored)
  if what == "git" then
-    local git_status = node:get_git_status()
-    return git_status ~= nil and (not skip_gitignored or git_status[1] ~= "!!")
+    local git_xy = node:get_git_xy()
+    return git_xy ~= nil and (not skip_gitignored or git_xy[1] ~= "!!")
  elseif what == "diag" then
    local diag_status = diagnostics.get_diag_status(node)
    return diag_status ~= nil and diag_status.value ~= nil
@@ -30,9 +31,9 @@ end

 ---Move to the next node that has a valid status. If none found, don't move.
 ---@param explorer Explorer
---@param where string where to move (forwards or backwards)
---@param what string type of status
---@param skip_gitignored boolean default false
+---@param where string? where to move (forwards or backwards)
+---@param what string? type of status
+---@param skip_gitignored boolean? default false
 local function move(explorer, where, what, skip_gitignored)
  local first_node_line = core.get_nodes_starting_line()
  local nodes_by_line = utils.get_nodes_by_line(explorer.nodes, first_node_line)
@@ -83,8 +84,8 @@ end

 --- Move to the next node recursively.
 ---@param explorer Explorer
---@param what string type of status
---@param skip_gitignored boolean default false
+---@param what string? type of status
+---@param skip_gitignored? boolean default false
 local function move_next_recursive(explorer, what, skip_gitignored)
  -- If the current node:
  -- * is a directory
@@ -149,8 +150,8 @@ end
 --- 4.5) Save the current node and start back from 4.1.
 ---
 ---@param explorer Explorer
---@param what string type of status
---@param skip_gitignored boolean default false
+---@param what string? type of status
+---@param skip_gitignored boolean? default false
 local function move_prev_recursive(explorer, what, skip_gitignored)
  local node_init, node_cur

@@ -175,7 +176,7 @@ local function move_prev_recursive(explorer, what, skip_gitignored)
      if
        node_cur == nil
        or node_cur == node_init -- we didn't move
-        or not node_cur.nodes    -- node is a file
+        or node_cur:is(FileNode) -- node is a file
      then
        return
      end
@@ -209,8 +210,10 @@ local function move_prev_recursive(explorer, what, skip_gitignored)
 end

 ---@class NavigationItemOpts
---@field where string
---@field what string
+---@field where string?
+---@field what string?
+---@field skip_gitignored boolean?
+---@field recurse boolean?

 ---@param opts NavigationItemOpts
 ---@return fun()
@@ -222,26 +225,21 @@ function M.fn(opts)
    end

    local recurse = false
-    local skip_gitignored = false

    -- recurse only valid for git and diag moves.
    if (opts.what == "git" or opts.what == "diag") and opts.recurse ~= nil then
      recurse = opts.recurse
    end

-    if opts.skip_gitignored ~= nil then
-      skip_gitignored = opts.skip_gitignored
-    end
-
    if not recurse then
-      move(explorer, opts.where, opts.what, skip_gitignored)
+      move(explorer, opts.where, opts.what, opts.skip_gitignored)
      return
    end

    if opts.where == "next" then
-      move_next_recursive(explorer, opts.what, skip_gitignored)
+      move_next_recursive(explorer, opts.what, opts.skip_gitignored)
    elseif opts.where == "prev" then
-      move_prev_recursive(explorer, opts.what, skip_gitignored)
+      move_prev_recursive(explorer, opts.what, opts.skip_gitignored)
    end
  end
 end