docs(#3241): tidy

Author: alex-courtis

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

@@ -6,6 +6,8 @@
 ---This is expensive as there are many cascading requires and is avoided
 ---until after setup has been called, so that the user may require API cheaply.
 
+local legacy = require("nvim-tree.legacy")
+
 local actions = require("nvim-tree.actions")
 local help = require("nvim-tree.help")
 local keymap = require("nvim-tree.keymap")
@@ -256,7 +258,7 @@ function M.hydrate(api)
   api.map.keymap.current = keymap.get_keymap
 
   -- (Re)hydrate any legacy by mapping to concrete set above
-  require("nvim-tree.api.impl.legacy").hydrate(api)
+  legacy.map_api(api)
 end
 
 return M

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

@@ -9,6 +9,8 @@
 --
 --Everything must be as lazily loaded as possible: the user must be able to require api cheaply.
 
+local legacy = require("nvim-tree.legacy")
+
 local commands = require("nvim-tree.commands") -- already required by plugin.lua
 local events = require("nvim-tree.events")     -- needed for event registration pre-setup
 local keymap = require("nvim-tree.keymap")     -- needed for default on attach
@@ -40,7 +42,6 @@ function M.hydrate(api)
   hydrate_error(api)
 
   -- eager functions
-  api.events.Event = events.Event
   api.events.subscribe = events.subscribe
   api.map.on_attach.default = keymap.on_attach_default
   api.commands.get = commands.get
@@ -51,9 +52,10 @@ function M.hydrate(api)
 
   -- classes
   api.Decorator = Decorator:extend()
+  api.events.Event = events.Event
 
   -- Hydrate any legacy by mapping to concrete set above
-  require("nvim-tree.api.impl.legacy").hydrate(api)
+  legacy.map_api(api)
 end
 
 return M

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

@@ -151,4 +151,32 @@ function M.migrate_legacy_options(opts)
   removed(opts)
 end
 
+---Silently create new api entries pointing legacy functions to current
+---@param api table not properly typed to prevent LSP from referencing implementations
+function M.map_api(api)
+  api.config = api.config or {}
+  api.config.mappings = api.config.mappings or {}
+  api.config.mappings.get_keymap = api.map.keymap.current
+  api.config.mappings.get_keymap_default = api.map.keymap.default
+  api.config.mappings.default_on_attach = api.map.on_attach.default
+
+  api.live_filter = api.live_filter or {}
+  api.live_filter.start = api.filter.live.start
+  api.live_filter.clear = api.filter.live.clear
+
+  api.tree = api.tree or {}
+  api.tree.toggle_enable_filters = api.filter.toggle
+  api.tree.toggle_gitignore_filter = api.filter.git.ignored.toggle
+  api.tree.toggle_git_clean_filter = api.filter.git.clean.toggle
+  api.tree.toggle_no_buffer_filter = api.filter.no_buffer.toggle
+  api.tree.toggle_custom_filter = api.filter.custom.toggle
+  api.tree.toggle_hidden_filter = api.filter.dotfiles.toggle
+  api.tree.toggle_no_bookmark_filter = api.filter.no_bookmark.toggle
+
+  api.diagnostics = api.diagnostics or {}
+  api.diagnostics.hi_test = api.health.hi_test
+
+  api.decorator.UserDecorator = api.Decorator
+end
+
 return M

lua/nvim-tree/legacy.lua

@@ -1,6 +1,6 @@
 local Decorator = require("nvim-tree.renderer.decorator")
 
----Builtin decorator interface.
+---Abstract builtin decorator
 ---Overrides all methods to use a Node instead of nvim_tree.api.Node as we don't have generics.
 ---
 ---@class (exact) BuiltinDecorator: Decorator

lua/nvim-tree/renderer/decorator/builtin.lua

@@ -1,8 +1,10 @@
+local DecoratorInterface = require("nvim-tree._meta.api.decorator")
+
 ---
----Abstract decorator implementation
+---Abstract decorator
 ---
 ---@class (exact) Decorator: nvim_tree.api.Decorator
-local Decorator = require("nvim-tree._meta.api.decorator"):extend()
+local Decorator = DecoratorInterface:extend()
 
 ---Maybe highlight groups for icon and name
 ---@param node nvim_tree.api.Node