refactor(#3256): legacy config consistent parameter naming

Author: alex-courtis

lua/nvim-tree/legacy.lua

@@ -51,110 +51,110 @@ local function move(src, src_path, src_pos, dst, dst_path, dst_pos, remove)
 end
 
 -- silently move, please add to help nvim-tree-legacy-config
----@param opts nvim_tree.config user supplied subset of config
-local function refactored_config(opts)
+---@param u nvim_tree.config user supplied subset of config
+local function refactored_config(u)
   -- 2022/06/20
-  move(opts, "update_focused_file", "update_cwd", opts, "update_focused_file", "update_root",        true)
-  move(opts, "",                    "update_cwd", opts, "",                    "sync_root_with_cwd", true)
+  move(u, "update_focused_file", "update_cwd", u, "update_focused_file", "update_root",        true)
+  move(u, "",                    "update_cwd", u, "",                    "sync_root_with_cwd", true)
 
   -- 2022/11/07
-  move(opts, "", "open_on_tab",              opts, "tab.sync", "open",   false)
-  move(opts, "", "open_on_tab",              opts, "tab.sync", "close",  true)
-  move(opts, "", "ignore_buf_on_tab_change", opts, "tab.sync", "ignore", true)
+  move(u, "", "open_on_tab",              u, "tab.sync", "open",   false)
+  move(u, "", "open_on_tab",              u, "tab.sync", "close",  true)
+  move(u, "", "ignore_buf_on_tab_change", u, "tab.sync", "ignore", true)
 
   -- 2022/11/22
-  move(opts, "renderer", "root_folder_modifier", opts, "renderer", "root_folder_label", true)
+  move(u, "renderer", "root_folder_modifier", u, "renderer", "root_folder_label", true)
 
   -- 2023/01/01
-  move(opts, "update_focused_file", "debounce_delay", opts, "view", "debounce_delay", true)
+  move(u, "update_focused_file", "debounce_delay", u, "view", "debounce_delay", true)
 
   -- 2023/01/08
-  move(opts, "trash", "require_confirm", opts, "ui.confirm", "trash", true)
+  move(u, "trash", "require_confirm", u, "ui.confirm", "trash", true)
 
   -- 2023/01/15
-  if type(opts.view) == "table" and opts.view.adaptive_size ~= nil then
-    if opts.view.adaptive_size and type(opts.view.width) ~= "table" then
-      local width = opts.view.width --[[@as nvim_tree.config.view.width.spec]]
-      opts.view.width = {
+  if type(u.view) == "table" and u.view.adaptive_size ~= nil then
+    if u.view.adaptive_size and type(u.view.width) ~= "table" then
+      local width = u.view.width --[[@as nvim_tree.config.view.width.spec]]
+      u.view.width = {
         min = width,
       }
     end
-    opts.view["adaptive_size"] = nil
+    u.view["adaptive_size"] = nil
   end
 
   -- 2023/07/15
-  move(opts, "", "sort_by", opts, "sort", "sorter", true)
+  move(u, "", "sort_by", u, "sort", "sorter", true)
 
   -- 2023/07/16
-  move(opts, "git", "ignore", opts, "filters", "git_ignored", true)
+  move(u, "git", "ignore", u, "filters", "git_ignored", true)
 
   -- 2023/08/26
-  move(opts, "renderer.icons", "webdev_colors", opts, "renderer.icons.web_devicons.file", "color", true)
+  move(u, "renderer.icons", "webdev_colors", u, "renderer.icons.web_devicons.file", "color", true)
 
   -- 2023/10/08
-  if type(opts.renderer) == "table" and type(opts.renderer.highlight_diagnostics) == "boolean" then
-    opts.renderer.highlight_diagnostics = opts.renderer.highlight_diagnostics and "name" or "none"
+  if type(u.renderer) == "table" and type(u.renderer.highlight_diagnostics) == "boolean" then
+    u.renderer.highlight_diagnostics = u.renderer.highlight_diagnostics and "name" or "none"
   end
 
   -- 2023/10/21
-  if type(opts.renderer) == "table" and type(opts.renderer.highlight_git) == "boolean" then
-    opts.renderer.highlight_git = opts.renderer.highlight_git and "name" or "none"
+  if type(u.renderer) == "table" and type(u.renderer.highlight_git) == "boolean" then
+    u.renderer.highlight_git = u.renderer.highlight_git and "name" or "none"
   end
 
   -- 2024/02/15
-  if type(opts.update_focused_file) == "table" then
-    if type(opts.update_focused_file.update_root) ~= "table" then
-      opts.update_focused_file.update_root = { enable = opts.update_focused_file.update_root == true }
+  if type(u.update_focused_file) == "table" then
+    if type(u.update_focused_file.update_root) ~= "table" then
+      u.update_focused_file.update_root = { enable = u.update_focused_file.update_root == true }
     end
   end
-  move(opts, "update_focused_file", "ignore_list", opts, "update_focused_file.update_root", "ignore_list", true)
+  move(u, "update_focused_file", "ignore_list", u, "update_focused_file.update_root", "ignore_list", true)
 
   -- 2025/04/30
-  if opts.renderer and opts.renderer.icons and type(opts.renderer.icons.padding) == "string" then
-    local icons_padding = opts.renderer.icons.padding --[[@as string]]
-    opts.renderer.icons.padding = {}
-    opts.renderer.icons.padding.icon = icons_padding
+  if u.renderer and u.renderer.icons and type(u.renderer.icons.padding) == "string" then
+    local icons_padding = u.renderer.icons.padding --[[@as string]]
+    u.renderer.icons.padding = {}
+    u.renderer.icons.padding.icon = icons_padding
   end
 end
 
----@param opts nvim_tree.config user supplied subset of config
-local function deprecated_config(opts)
-  if type(opts.view) == "table" and opts.view.hide_root_folder then
+---@param u nvim_tree.config user supplied subset of config
+local function deprecated_config(u)
+  if type(u.view) == "table" and u.view.hide_root_folder then
     notify.info("view.hide_root_folder is deprecated, please set renderer.root_folder_label = false")
   end
 end
 
----@param opts nvim_tree.config user supplied subset of config
-local function removed_config(opts)
-  if opts.auto_close then
+---@param u nvim_tree.config user supplied subset of config
+local function removed_config(u)
+  if u.auto_close then
     notify.warn("auto close feature has been removed: https://github.com/nvim-tree/nvim-tree.lua/wiki/Auto-Close")
-    opts["auto_close"] = nil
+    u["auto_close"] = nil
   end
 
-  if opts.focus_empty_on_setup then
+  if u.focus_empty_on_setup then
     notify.warn("focus_empty_on_setup has been removed: https://github.com/nvim-tree/nvim-tree.lua/wiki/Open-At-Startup")
-    opts["focus_empty_on_setup"] = nil
+    u["focus_empty_on_setup"] = nil
   end
 
-  if opts.create_in_closed_folder then
+  if u.create_in_closed_folder then
     notify.warn(
       "create_in_closed_folder has been removed and is now the default behaviour. You may use api.fs.create to add a file under your desired node.")
   end
-  opts["create_in_closed_folder"] = nil
+  u["create_in_closed_folder"] = nil
 end
 
 ---Migrate legacy config in place.
 ---Refactored are silently migrated. Deprecated and removed result in a warning.
----@param opts nvim_tree.config user supplied subset of config
-function M.migrate_config(opts)
+---@param u nvim_tree.config user supplied subset of config
+function M.migrate_config(u)
   -- silently move
-  refactored_config(opts)
+  refactored_config(u)
 
   -- warn
-  deprecated_config(opts)
+  deprecated_config(u)
 
   -- warn and delete
-  removed_config(opts)
+  removed_config(u)
 end
 
 ---Silently create new api entries pointing legacy functions to current