refactor(#3253): add api.config, tidy new config module

Author: alex-courtis

doc/nvim-tree-lua.txt

@@ -2460,6 +2460,28 @@ get()                                           *nvim_tree.api.commands.get()*
         • {opts} (`vim.api.keyset.user_command`) |command-attributes|
 
 
+==============================================================================
+API: config                                             *nvim-tree-api-config*
+
+default()                                     *nvim_tree.api.config.default()*
+    Default nvim-tree config.
+
+    Return: ~
+        (`nvim_tree.config`) immutable deep clone
+
+global()                                       *nvim_tree.api.config.global()*
+    Global current nvim-tree config.
+
+    Return: ~
+        (`nvim_tree.config`) immutable deep clone
+
+user()                                           *nvim_tree.api.config.user()*
+    Reference to config passed to |nvim-tree-setup|
+
+    Return: ~
+        (`nvim_tree.config?`) nil when no config passed to setup
+
+
 ==============================================================================
 API: events                                             *nvim-tree-api-events*
 

lua/nvim-tree.lua

@@ -36,7 +36,7 @@ function M.change_root(path, bufnr)
       ft = vim.api.nvim_buf_get_option(bufnr, "filetype") or "" ---@diagnostic disable-line: deprecated
     end
 
-    for _, value in pairs(config.current().update_focused_file.update_root.ignore_list) do
+    for _, value in pairs(config.g.update_focused_file.update_root.ignore_list) do
       if utils.str_find(path, value) or utils.str_find(ft, value) then
         return
       end
@@ -68,12 +68,12 @@ function M.change_root(path, bufnr)
   end
 
   -- otherwise test M.init_root
-  if config.current().prefer_startup_root and utils.path_relative(path, M.init_root) ~= path then
+  if config.g.prefer_startup_root and utils.path_relative(path, M.init_root) ~= path then
     explorer_fn("change_dir", M.init_root)
     return
   end
   -- otherwise root_dirs
-  for _, dir in pairs(config.current().root_dirs) do
+  for _, dir in pairs(config.g.root_dirs) do
     dir = vim.fn.fnamemodify(dir, ":p")
     if utils.path_relative(path, dir) ~= path then
       explorer_fn("change_dir", dir)
@@ -95,7 +95,7 @@ function M.tab_enter()
       ft = vim.api.nvim_buf_get_option(0, "ft") ---@diagnostic disable-line: deprecated
     end
 
-    for _, filter in ipairs(config.current().tab.sync.ignore) do
+    for _, filter in ipairs(config.g.tab.sync.ignore) do
       if bufname:match(filter) ~= nil or ft:match(filter) ~= nil then
         return
       end
@@ -110,7 +110,7 @@ function M.tab_enter()
 end
 
 function M.open_on_directory()
-  local should_proceed = config.current().hijack_directories.auto_open or view.is_visible()
+  local should_proceed = config.g.hijack_directories.auto_open or view.is_visible()
   if not should_proceed then
     return
   end
@@ -131,11 +131,11 @@ function M.open_on_directory()
 end
 
 local function manage_netrw()
-  if config.current().hijack_netrw then
+  if config.g.hijack_netrw then
     vim.cmd("silent! autocmd! FileExplorer *")
     vim.cmd("autocmd VimEnter * ++once silent! autocmd! FileExplorer *")
   end
-  if config.current().disable_netrw then
+  if config.g.disable_netrw then
     vim.g.loaded_netrw = 1
     vim.g.loaded_netrwPlugin = 1
   end
@@ -147,7 +147,7 @@ function M.change_dir(name)
     explorer_fn("change_dir", name)
   end
 
-  if config.current().update_focused_file.update_root.enable then
+  if config.g.update_focused_file.update_root.enable then
     actions.tree.find_file.fn()
   end
 end
@@ -166,43 +166,43 @@ local function setup_autocommands()
       if not utils.is_nvim_tree_buf(0) then
         return
       end
-      if config.current().actions.open_file.eject then
+      if config.g.actions.open_file.eject then
         view._prevent_buffer_override()
       else
         view.abandon_current_window()
       end
     end,
   })
 
-  if config.current().tab.sync.open then
+  if config.g.tab.sync.open then
     create_nvim_tree_autocmd("TabEnter", { callback = vim.schedule_wrap(M.tab_enter) })
   end
-  if config.current().sync_root_with_cwd then
+  if config.g.sync_root_with_cwd then
     create_nvim_tree_autocmd("DirChanged", {
       callback = function()
         M.change_dir(vim.loop.cwd())
       end,
     })
   end
-  if config.current().update_focused_file.enable then
+  if config.g.update_focused_file.enable then
     create_nvim_tree_autocmd("BufEnter", {
       callback = function(event)
-        local exclude = config.current().update_focused_file.exclude
+        local exclude = config.g.update_focused_file.exclude
         if type(exclude) == "function" and exclude(event) then
           return
         end
-        utils.debounce("BufEnter:find_file", config.current().view.debounce_delay, function()
+        utils.debounce("BufEnter:find_file", config.g.view.debounce_delay, function()
           actions.tree.find_file.fn()
         end)
       end,
     })
   end
 
-  if config.current().hijack_directories.enable and (config.current().disable_netrw or config.current().hijack_netrw) then
+  if config.g.hijack_directories.enable and (config.g.disable_netrw or config.g.hijack_netrw) then
     create_nvim_tree_autocmd({ "BufEnter", "BufNewFile" }, { callback = M.open_on_directory, nested = true })
   end
 
-  if config.current().view.centralize_selection then
+  if config.g.view.centralize_selection then
     create_nvim_tree_autocmd("BufEnter", {
       pattern = "NvimTree_*",
       callback = function()
@@ -219,7 +219,7 @@ local function setup_autocommands()
     })
   end
 
-  if config.current().diagnostics.enable then
+  if config.g.diagnostics.enable then
     create_nvim_tree_autocmd("DiagnosticChanged", {
       callback = function(ev)
         log.line("diagnostics", "DiagnosticChanged")
@@ -235,7 +235,7 @@ local function setup_autocommands()
     })
   end
 
-  if config.current().view.float.enable and config.current().view.float.quit_on_focus_loss then
+  if config.g.view.float.enable and config.g.view.float.quit_on_focus_loss then
     create_nvim_tree_autocmd("WinLeave", {
       pattern = "NvimTree_*",
       callback = function()
@@ -278,41 +278,41 @@ end
 -- TODO #3253 ensure that we can call setup twice
 
 
----@param conf? nvim_tree.config
-function M.setup(conf)
+---@param config_user? nvim_tree.config user supplied subset of config
+function M.setup(config_user)
   if vim.fn.has("nvim-0.9") == 0 then
     notify.warn("nvim-tree.lua requires Neovim 0.9 or higher")
     return
   end
 
   M.init_root = vim.fn.getcwd()
 
-  config.setup(conf)
+  config.setup(config_user)
 
   manage_netrw()
 
-  require("nvim-tree.notify").setup(config.current())
-  require("nvim-tree.log").setup(config.current())
+  require("nvim-tree.notify").setup(config.g)
+  require("nvim-tree.log").setup(config.g)
 
   if log.enabled("config") then
     log.line("config", "default config + user")
-    log.raw("config", "%s\n", vim.inspect(config.current()))
+    log.raw("config", "%s\n", vim.inspect(config.g))
   end
 
-  require("nvim-tree.actions").setup(config.current())
-  require("nvim-tree.keymap").setup(config.current())
+  require("nvim-tree.actions").setup(config.g)
+  require("nvim-tree.keymap").setup(config.g)
   require("nvim-tree.appearance").setup()
-  require("nvim-tree.diagnostics").setup(config.current())
-  require("nvim-tree.explorer"):setup(config.current())
-  require("nvim-tree.explorer.watch").setup(config.current())
-  require("nvim-tree.git").setup(config.current())
-  require("nvim-tree.git.utils").setup(config.current())
-  require("nvim-tree.view").setup(config.current())
-  require("nvim-tree.lib").setup(config.current())
-  require("nvim-tree.renderer.components").setup(config.current())
-  require("nvim-tree.buffers").setup(config.current())
-  require("nvim-tree.help").setup(config.current())
-  require("nvim-tree.watcher").setup(config.current())
+  require("nvim-tree.diagnostics").setup(config.g)
+  require("nvim-tree.explorer"):setup(config.g)
+  require("nvim-tree.explorer.watch").setup(config.g)
+  require("nvim-tree.git").setup(config.g)
+  require("nvim-tree.git.utils").setup(config.g)
+  require("nvim-tree.view").setup(config.g)
+  require("nvim-tree.lib").setup(config.g)
+  require("nvim-tree.renderer.components").setup(config.g)
+  require("nvim-tree.buffers").setup(config.g)
+  require("nvim-tree.help").setup(config.g)
+  require("nvim-tree.watcher").setup(config.g)
 
   setup_autocommands()
 

lua/nvim-tree/_meta/api/config.lua

@@ -0,0 +1,33 @@
+---@meta
+local nvim_tree = { api = { config = {} } }
+
+---
+---Default nvim-tree config.
+---
+---@return nvim_tree.config immutable deep clone
+function nvim_tree.api.config.default() end
+
+---
+---Global current nvim-tree config.
+---
+---@return nvim_tree.config immutable deep clone
+function nvim_tree.api.config.global() end
+
+---
+---Reference to config passed to [nvim-tree-setup]
+---
+---@return nvim_tree.config? nil when no config passed to setup
+function nvim_tree.api.config.user() end
+
+nvim_tree.api.config.mappings = {}
+
+---@deprecated use `nvim_tree.api.map.keymap.current()`
+function nvim_tree.api.config.mappings.get_keymap() end
+
+---@deprecated use `nvim_tree.api.map.keymap.default()`
+function nvim_tree.api.config.mappings.get_keymap_default() end
+
+---@deprecated use `nvim_tree.api.map.on_attach.default()`
+function nvim_tree.api.config.mappings.default_on_attach(bufnr) end
+
+return nvim_tree.api.config

lua/nvim-tree/_meta/api/deprecated.lua

@@ -4,19 +4,6 @@
 
 local nvim_tree = { api = {} }
 
-nvim_tree.api.config = {}
-
-nvim_tree.api.config.mappings = {}
-
----@deprecated use `nvim_tree.api.map.keymap.current()`
-function nvim_tree.api.config.mappings.get_keymap() end
-
----@deprecated use `nvim_tree.api.map.keymap.default()`
-function nvim_tree.api.config.mappings.get_keymap_default() end
-
----@deprecated use `nvim_tree.api.map.on_attach.default()`
-function nvim_tree.api.config.mappings.default_on_attach(bufnr) end
-
 nvim_tree.api.live_filter = {}
 
 ---@deprecated use `nvim_tree.api.filter.live.start()`

lua/nvim-tree/api.lua

@@ -79,6 +79,7 @@ local deprecated = require("nvim-tree._meta.api.deprecated")
 ---@nodoc
 local api = {
   commands = require("nvim-tree._meta.api.commands"),
+  config = require("nvim-tree._meta.api.config"),
   events = require("nvim-tree._meta.api.events"),
   filter = require("nvim-tree._meta.api.filter"),
   fs = require("nvim-tree._meta.api.fs"),
@@ -89,7 +90,6 @@ local api = {
   node = require("nvim-tree._meta.api.node"),
   tree = require("nvim-tree._meta.api.tree"),
 
-  config = deprecated.config, ---@deprecated
   diagnostics = deprecated.diagnostics, ---@deprecated
   live_filter = deprecated.live_filter, ---@deprecated
 }

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

@@ -7,6 +7,7 @@
 ---until after setup has been called, so that the user may require API cheaply.
 
 local actions = require("nvim-tree.actions")
+local config = require("nvim-tree.config")
 local help = require("nvim-tree.help")
 local keymap = require("nvim-tree.keymap")
 local utils = require("nvim-tree.utils")
@@ -252,6 +253,9 @@ local function hydrate_post(api)
   api.marks.navigate.select = wrap_explorer_member("marks", "navigate_select")
 
   api.map.keymap.current = keymap.get_keymap
+
+  api.config.global = config.g_clone
+  api.config.user = config.u_clone
 end
 
 ---Re-hydrate api

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

@@ -45,6 +45,7 @@ local function hydrate_pre(api)
   -- May be lazily requried on execution
   --
   api.health.hi_test = function() require("nvim-tree.appearance.hi-test")() end
+  api.config.default = function() return require("nvim-tree.config").d_clone() end
 
 
   --