docs(#3088): mark deprecated api modules, use proper namespacing for deprecateds

Author: alex-courtis

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

@@ -1,34 +1,33 @@
 ---@meta
-
 -- Deprecated top level API modules.
 -- Remember to add mappings in legacy.lua `api_map`
 
-local M = {}
+local nvim_tree = { api = {} }
 
-M.config = {}
+nvim_tree.api.config = {}
 
-M.config.mappings = {}
+nvim_tree.api.config.mappings = {}
 
 ---@deprecated use `nvim_tree.api.map.keymap.current()`
-function M.config.mappings.get_keymap() end
+function nvim_tree.api.config.mappings.get_keymap() end
 
 ---@deprecated use `nvim_tree.api.map.keymap.default()`
-function M.config.mappings.get_keymap_default() end
+function nvim_tree.api.config.mappings.get_keymap_default() end
 
 ---@deprecated use `nvim_tree.api.map.on_attach.default()`
-function M.config.mappings.default_on_attach(bufnr) end
+function nvim_tree.api.config.mappings.default_on_attach(bufnr) end
 
-M.live_filter = {}
+nvim_tree.api.live_filter = {}
 
 ---@deprecated use `nvim_tree.api.filter.live.start()`
-function M.live_filter.start() end
+function nvim_tree.api.live_filter.start() end
 
 ---@deprecated use `nvim_tree.api.filter.live.clear()`
-function M.live_filter.clear() end
+function nvim_tree.api.live_filter.clear() end
 
-M.diagnostics = {}
+nvim_tree.api.diagnostics = {}
 
 ---@deprecated use `nvim_tree.api.health.hi_test()`
-function M.diagnostics.hi_test() end
+function nvim_tree.api.diagnostics.hi_test() end
 
-return M
+return nvim_tree.api

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

@@ -250,5 +250,4 @@ function nvim_tree.api.tree.toggle_hidden_filter() end
 ---@deprecated use `nvim_tree.api.filter.no_bookmark.toggle()`
 function nvim_tree.api.tree.toggle_no_bookmark_filter() end
 
-
 return nvim_tree.api.tree

lua/nvim-tree/api.lua

@@ -72,24 +72,26 @@
 --
 -- Load the (empty) meta definitions
 --
+local deprecated = require("nvim-tree._meta.api.deprecated")
 
 ---nvim-tree Public API
 ---@class nvim_tree.api
 ---@nodoc
 local api = {
   commands = require("nvim-tree._meta.api.commands"),
-  config = require("nvim-tree._meta.api.deprecated").config,
-  diagnostics = require("nvim-tree._meta.api.deprecated").diagnostics,
   events = require("nvim-tree._meta.api.events"),
   filter = require("nvim-tree._meta.api.filter"),
   fs = require("nvim-tree._meta.api.fs"),
   git = require("nvim-tree._meta.api._git"),
   health = require("nvim-tree._meta.api.health"),
-  live_filter = require("nvim-tree._meta.api.deprecated").live_filter,
   map = require("nvim-tree._meta.api.map"),
   marks = require("nvim-tree._meta.api.marks"),
   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
 }