docs(#3088): extract post impl functions, lazy some requires

Author: alex-courtis

lua/nvim-tree/api/impl/post.lua

@@ -1,84 +1,131 @@
-local core = require("nvim-tree.core")
 local view = require("nvim-tree.view")
-local utils = require("nvim-tree.utils")
 local actions = require("nvim-tree.actions")
-local appearance_hi_test = require("nvim-tree.appearance.hi-test")
-local help = require("nvim-tree.help")
-local keymap = require("nvim-tree.keymap")
 
 local DirectoryNode = require("nvim-tree.node.directory")
 local FileNode = require("nvim-tree.node.file")
 local FileLinkNode = require("nvim-tree.node.file-link")
 local RootNode = require("nvim-tree.node.root")
 
----Hydrate all implementations barring those that were called during hydrate_pre
----@param api table
-local function hydrate_post(api)
-  ---Invoke a method on the singleton explorer.
-  ---Print error when setup not called.
-  ---@param explorer_method string explorer method name
-  ---@return fun(...): any
-  local function wrap_explorer(explorer_method)
-    return function(...)
-      local explorer = core.get_explorer()
-      if explorer then
-        return explorer[explorer_method](explorer, ...)
-      end
+---Invoke a method on the singleton explorer.
+---Print error when setup not called.
+---@param explorer_method string explorer method name
+---@return fun(...): any
+local function wrap_explorer(explorer_method)
+  return function(...)
+    local explorer = require("nvim-tree.core").get_explorer()
+    if explorer then
+      return explorer[explorer_method](explorer, ...)
     end
   end
+end
 
-  ---Inject the node as the first argument if present otherwise do nothing.
-  ---@param fn fun(node: Node, ...): any
-  ---@return fun(node: Node?, ...): any
-  local function wrap_node(fn)
-    return function(node, ...)
-      node = node or wrap_explorer("get_node_at_cursor")()
-      if node then
-        return fn(node, ...)
-      end
+---Inject the node as the first argument if present otherwise do nothing.
+---@param fn fun(node: Node, ...): any
+---@return fun(node: Node?, ...): any
+local function wrap_node(fn)
+  return function(node, ...)
+    node = node or wrap_explorer("get_node_at_cursor")()
+    if node then
+      return fn(node, ...)
     end
   end
+end
+
+---Inject the node or nil as the first argument if absent.
+---@param fn fun(node: Node?, ...): any
+---@return fun(node: Node?, ...): any
+local function wrap_node_or_nil(fn)
+  return function(node, ...)
+    node = node or wrap_explorer("get_node_at_cursor")()
+    return fn(node, ...)
+  end
+end
 
-  ---Inject the node or nil as the first argument if absent.
-  ---@param fn fun(node: Node?, ...): any
-  ---@return fun(node: Node?, ...): any
-  local function wrap_node_or_nil(fn)
-    return function(node, ...)
-      node = node or wrap_explorer("get_node_at_cursor")()
-      return fn(node, ...)
+---Invoke a member's method on the singleton explorer.
+---Print error when setup not called.
+---@param explorer_member string explorer member name
+---@param member_method string method name to invoke on member
+---@param ... any passed to method
+---@return fun(...): any
+local function wrap_explorer_member_args(explorer_member, member_method, ...)
+  local method_args = ...
+  return function(...)
+    local explorer = require("nvim-tree.core").get_explorer()
+    if explorer then
+      return explorer[explorer_member][member_method](explorer[explorer_member], method_args, ...)
     end
   end
+end
 
-  ---Invoke a member's method on the singleton explorer.
-  ---Print error when setup not called.
-  ---@param explorer_member string explorer member name
-  ---@param member_method string method name to invoke on member
-  ---@param ... any passed to method
-  ---@return fun(...): any
-  local function wrap_explorer_member_args(explorer_member, member_method, ...)
-    local method_args = ...
-    return function(...)
-      local explorer = core.get_explorer()
-      if explorer then
-        return explorer[explorer_member][member_method](explorer[explorer_member], method_args, ...)
-      end
+---Invoke a member's method on the singleton explorer.
+---Print error when setup not called.
+---@param explorer_member string explorer member name
+---@param member_method string method name to invoke on member
+---@return fun(...): any
+local function wrap_explorer_member(explorer_member, member_method)
+  return function(...)
+    local explorer = require("nvim-tree.core").get_explorer()
+    if explorer then
+      return explorer[explorer_member][member_method](explorer[explorer_member], ...)
     end
   end
+end
 
-  ---Invoke a member's method on the singleton explorer.
-  ---Print error when setup not called.
-  ---@param explorer_member string explorer member name
-  ---@param member_method string method name to invoke on member
-  ---@return fun(...): any
-  local function wrap_explorer_member(explorer_member, member_method)
-    return function(...)
-      local explorer = core.get_explorer()
-      if explorer then
-        return explorer[explorer_member][member_method](explorer[explorer_member], ...)
-      end
+---@class NodeEditOpts
+---@field quit_on_open boolean|nil default false
+---@field focus boolean|nil default true
+
+---@param mode string
+---@param node Node
+---@param edit_opts NodeEditOpts?
+local function edit(mode, node, edit_opts)
+  local file_link = node:as(FileLinkNode)
+  local path = file_link and file_link.link_to or node.absolute_path
+  local cur_tabpage = vim.api.nvim_get_current_tabpage()
+
+  actions.node.open_file.fn(mode, path)
+
+  edit_opts = edit_opts or {}
+
+  local mode_unsupported_quit_on_open = mode == "drop" or mode == "tab_drop" or mode == "edit_in_place"
+  if not mode_unsupported_quit_on_open and edit_opts.quit_on_open then
+    view.close(cur_tabpage)
+  end
+
+  local mode_unsupported_focus = mode == "drop" or mode == "tab_drop" or mode == "edit_in_place"
+  local focus = edit_opts.focus == nil or edit_opts.focus == true
+  if not mode_unsupported_focus and not focus then
+    -- if mode == "tabnew" a new tab will be opened and we need to focus back to the previous tab
+    if mode == "tabnew" then
+      vim.cmd(":tabprev")
     end
+    view.focus()
   end
+end
 
+---@param mode string
+---@param toggle_group boolean?
+---@return fun(node: Node, edit_opts: NodeEditOpts?)
+local function open_or_expand_or_dir_up(mode, toggle_group)
+  ---@param node Node
+  ---@param edit_opts NodeEditOpts?
+  return function(node, edit_opts)
+    local root = node:as(RootNode)
+    local dir = node:as(DirectoryNode)
+
+    if root or node.name == ".." then
+      actions.root.change_dir.fn("..")
+    elseif dir then
+      dir:expand_or_collapse(toggle_group)
+    elseif not toggle_group then
+      edit(mode, node, edit_opts)
+    end
+  end
+end
+
+---Hydrate all implementations barring those that were called during hydrate_pre
+---@param api table
+local function hydrate_post(api)
   api.tree.open = actions.tree.open.fn
   api.tree.focus = api.tree.open
 
@@ -119,8 +166,8 @@ local function hydrate_post(api)
   api.tree.collapse_all = actions.tree.modifiers.collapse.all
 
   api.tree.expand_all = wrap_node(actions.tree.modifiers.expand.all)
-  api.tree.toggle_help = help.toggle
-  api.tree.is_tree_buf = utils.is_nvim_tree_buf
+  api.tree.toggle_help = function() require("nvim-tree.help").toggle() end
+  api.tree.is_tree_buf = function() require("nvim-tree.utils").is_nvim_tree_buf() end
 
   api.tree.is_visible = view.is_visible
 
@@ -143,58 +190,6 @@ local function hydrate_post(api)
   api.fs.copy.filename = wrap_node(wrap_explorer_member("clipboard", "copy_filename"))
   api.fs.copy.basename = wrap_node(wrap_explorer_member("clipboard", "copy_basename"))
   api.fs.copy.relative_path = wrap_node(wrap_explorer_member("clipboard", "copy_path"))
-  ---
-  ---@class NodeEditOpts
-  ---@field quit_on_open boolean|nil default false
-  ---@field focus boolean|nil default true
-
-  ---@param mode string
-  ---@param node Node
-  ---@param edit_opts NodeEditOpts?
-  local function edit(mode, node, edit_opts)
-    local file_link = node:as(FileLinkNode)
-    local path = file_link and file_link.link_to or node.absolute_path
-    local cur_tabpage = vim.api.nvim_get_current_tabpage()
-
-    actions.node.open_file.fn(mode, path)
-
-    edit_opts = edit_opts or {}
-
-    local mode_unsupported_quit_on_open = mode == "drop" or mode == "tab_drop" or mode == "edit_in_place"
-    if not mode_unsupported_quit_on_open and edit_opts.quit_on_open then
-      view.close(cur_tabpage)
-    end
-
-    local mode_unsupported_focus = mode == "drop" or mode == "tab_drop" or mode == "edit_in_place"
-    local focus = edit_opts.focus == nil or edit_opts.focus == true
-    if not mode_unsupported_focus and not focus then
-      -- if mode == "tabnew" a new tab will be opened and we need to focus back to the previous tab
-      if mode == "tabnew" then
-        vim.cmd(":tabprev")
-      end
-      view.focus()
-    end
-  end
-
-  ---@param mode string
-  ---@param toggle_group boolean?
-  ---@return fun(node: Node, edit_opts: NodeEditOpts?)
-  local function open_or_expand_or_dir_up(mode, toggle_group)
-    ---@param node Node
-    ---@param edit_opts NodeEditOpts?
-    return function(node, edit_opts)
-      local root = node:as(RootNode)
-      local dir = node:as(DirectoryNode)
-
-      if root or node.name == ".." then
-        actions.root.change_dir.fn("..")
-      elseif dir then
-        dir:expand_or_collapse(toggle_group)
-      elseif not toggle_group then
-        edit(mode, node, edit_opts)
-      end
-    end
-  end
 
   api.node.open.edit = wrap_node(open_or_expand_or_dir_up("edit"))
   api.node.open.drop = wrap_node(open_or_expand_or_dir_up("drop"))
@@ -236,12 +231,8 @@ local function hydrate_post(api)
   api.node.expand = wrap_node(actions.tree.modifiers.expand.node)
   api.node.collapse = wrap_node(actions.tree.modifiers.collapse.node)
 
-  api.node.buffer.delete = wrap_node(function(node, opts)
-    actions.node.buffer.delete(node, opts)
-  end)
-  api.node.buffer.wipe = wrap_node(function(node, opts)
-    actions.node.buffer.wipe(node, opts)
-  end)
+  api.node.buffer.delete = wrap_node(function(node, opts) actions.node.buffer.delete(node, opts) end)
+  api.node.buffer.wipe = wrap_node(function(node, opts) actions.node.buffer.wipe(node, opts) end)
 
   api.tree.reload_git = wrap_explorer("reload_git")
 
@@ -266,12 +257,13 @@ local function hydrate_post(api)
   api.marks.navigate.prev = wrap_explorer_member("marks", "navigate_prev")
   api.marks.navigate.select = wrap_explorer_member("marks", "navigate_select")
 
-  api.map.get_keymap = keymap.get_keymap
-  api.map.get_keymap_default = keymap.get_keymap_default
+  api.map.get_keymap = function() require("nvim-tree.keymap").get_keymap() end
+  api.map.get_keymap_default = function() require("nvim-tree.keymap").get_keymap_default() end
 
-  api.health.hi_test = appearance_hi_test
+  api.health.hi_test = function() require("nvim-tree.appearance.hi-test")() end
 
-  api.commands.get = require("nvim-tree.commands").get
+  -- TODO #3231 this should be OK pre
+  api.commands.get = function() require("nvim-tree.commands").get() end
 end
 
 ---Hydrates all API functions with concrete implementations.