perf(#3253): extract purge_all_state and document

Author: alex-courtis

lua/nvim-tree.lua

@@ -114,55 +114,53 @@ local function setup_autocommands()
   require("nvim-tree.renderer.components.full-name").setup_autocommands()
 end
 
-function M.purge_all_state()
-  local view = require("nvim-tree.view")
-  local core = require("nvim-tree.core")
-
-  view.close_all_tabs()
-  view.abandon_all_windows()
-  local explorer = core.get_explorer()
-  if explorer then
-    require("nvim-tree.git").purge_state()
-    explorer:destroy()
-    core.reset_explorer()
-  end
-  -- purge orphaned that were not destroyed by their nodes
-  require("nvim-tree.watcher").purge_watchers()
-end
-
----@param config_user? nvim_tree.config user supplied subset of config
+---`require("nvim-tree").setup` must be called once to initialise nvim-tree.
+---
+---Call again to apply a change in configuration without restarting Nvim.
+---
+---See :help nvim-tree-setup
+---
+---@param config_user? nvim_tree.config subset, uses defaults when nil
 function M.setup(config_user)
   local log = require("nvim-tree.log")
 
+  -- Nvim version check
   if vim.fn.has("nvim-0.9") == 0 then
     require("nvim-tree.notify").warn("nvim-tree.lua requires Neovim 0.9 or higher")
     return
   end
 
+  -- validate and merge with defaults as config.g
   config.setup(config_user)
 
+  -- optionally create the log file
   log.start()
 
+  -- optionally log the configuration
   if log.enabled("config") then
     log.line("config", "default config + user")
     log.raw("config", "%s\n", vim.inspect(config.g))
   end
 
+  -- idempotent highlight definition
   require("nvim-tree.appearance").highlight()
 
+  -- set the initial view state based on config
   require("nvim-tree.view-state").initialize()
 
+  -- idempotent au (re)definition
   setup_autocommands()
 
+  -- subsequent calls to setup clear all state
   if vim.g.NvimTreeSetup == 1 then
-    -- subsequent calls to setup
-    M.purge_all_state()
+    require("nvim-tree.core").purge_all_state()
   end
 
+  -- hydrate post setup API
+  require("nvim-tree.api.impl").hydrate_post_setup(require("nvim-tree.api"))
+
   vim.g.NvimTreeSetup = 1
   vim.api.nvim_exec_autocmds("User", { pattern = "NvimTreeSetup" })
-
-  require("nvim-tree.api.impl").hydrate_post_setup(require("nvim-tree.api"))
 end
 
 vim.g.NvimTreeRequired = 1

lua/nvim-tree/core.lua

@@ -2,6 +2,8 @@ local events = require("nvim-tree.events")
 local notify = require("nvim-tree.notify")
 local view = require("nvim-tree.view")
 local log = require("nvim-tree.log")
+local git = require("nvim-tree.git")
+local watcher = require("nvim-tree.watcher")
 
 local M = {}
 
@@ -64,4 +66,16 @@ function M.get_nodes_starting_line()
   return offset
 end
 
+function M.purge_all_state()
+  view.close_all_tabs()
+  view.abandon_all_windows()
+  if TreeExplorer then
+    git.purge_state()
+    TreeExplorer:destroy()
+    M.reset_explorer()
+  end
+  -- purge orphaned that were not destroyed by their nodes
+  watcher.purge_watchers()
+end
+
 return M

lua/nvim-tree/watcher.lua

@@ -238,7 +238,7 @@ M.Watcher = Watcher
 function M.disable_watchers(msg)
   notify.warn(string.format("Disabling watchers: %s", msg))
   config.g.filesystem_watchers.enable = false
-  require("nvim-tree").purge_all_state()
+  require("nvim-tree.core").purge_all_state()
 end
 
 function M.purge_watchers()