docs(#3088): add meta for legacy api

Author: alex-courtis

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

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

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

@@ -18,13 +18,17 @@ function nvim_tree.api.filter.live.start() end
 ---
 function nvim_tree.api.filter.live.clear() end
 
-nvim_tree.api.filter.git = { clean = {}, ignored = {} }
+nvim_tree.api.filter.git = {}
+
+nvim_tree.api.filter.git.clean = {}
 
 ---
 ---Toggle [nvim_tree.config.filters] {git_clean} filter.
 ---
 function nvim_tree.api.filter.git.clean.toggle() end
 
+nvim_tree.api.filter.git.ignored = {}
+
 ---
 ---Toggle [nvim_tree.config.filters] {git_ignored} filter.
 ---

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

@@ -228,4 +228,27 @@ function nvim_tree.api.tree.winid(opts) end
 ---[tab-ID] 0 or nil for current.
 ---@field tabpage? integer
 
+
+---@deprecated use `nvim_tree.api.filter.toggle()`
+function nvim_tree.api.tree.toggle_enable_filters() end
+
+---@deprecated use `nvim_tree.api.filter.git.ignored.toggle()`
+function nvim_tree.api.tree.toggle_gitignore_filter() end
+
+---@deprecated use `nvim_tree.api.filter.git.clean.toggle()`
+function nvim_tree.api.tree.toggle_git_clean_filter() end
+
+---@deprecated use `nvim_tree.api.filter.no_buffer.toggle()`
+function nvim_tree.api.tree.toggle_no_buffer_filter() end
+
+---@deprecated use `nvim_tree.api.filter.custom.toggle()`
+function nvim_tree.api.tree.toggle_custom_filter() end
+
+---@deprecated use `nvim_tree.api.filter.dotfiles.toggle()`
+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

@@ -1,5 +1,3 @@
-local api = {}
-
 ---@brief
 ---nvim-tree exposes a public API. This is non breaking, with additions made as necessary.
 ---
@@ -70,28 +68,29 @@ local api = {}
 ---@field dir? table<"direct" | "indirect", nvim_tree.git.XY[]> direct inclusive-or indirect status
 
 
--- TODO #3088 add nvim_tree.api class
 
 --
 -- Load the (empty) meta definitions
 --
-api.commands = require("nvim-tree._meta.api.commands")
-api.events = require("nvim-tree._meta.api.events")
-api.filter = require("nvim-tree._meta.api.filter")
-api.fs = require("nvim-tree._meta.api.fs")
-api.git = require("nvim-tree._meta.api._git")
-api.health = require("nvim-tree._meta.api.health")
-api.map = require("nvim-tree._meta.api.map")
-api.marks = require("nvim-tree._meta.api.marks")
-api.node = require("nvim-tree._meta.api.node")
-api.tree = require("nvim-tree._meta.api.tree")
-
 
----
+---nvim-tree Public API
+---@class nvim_tree.api
 ---@nodoc
----Legacy meta definitions
----
-api = require("nvim-tree.legacy").api_meta(api)
+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"),
+}
 
 
 --

lua/nvim-tree/legacy.lua

@@ -188,67 +188,4 @@ function M.api_map(api)
   api.diagnostics.hi_test = api.health.hi_test
 end
 
----Add meta definitions for deprecated API
-function M.api_meta(api)
-  ---@deprecated
-  ---@see nvim_tree.api.filter.toggle
-  function api.tree.toggle_enable_filters() end
-
-  ---@deprecated
-  ---@see nvim_tree.api.filter.git.ignored.toggle
-  function api.tree.toggle_gitignore_filter() end
-
-  ---@deprecated
-  ---@see nvim_tree.api.filter.git.clean.toggle
-  function api.tree.toggle_git_clean_filter() end
-
-  ---@deprecated
-  ---@see nvim_tree.api.filter.no_buffer.toggle
-  function api.tree.toggle_no_buffer_filter() end
-
-  ---@deprecated
-  ---@see nvim_tree.api.filter.custom.toggle
-  function api.tree.toggle_custom_filter() end
-
-  ---@deprecated
-  ---@see nvim_tree.api.filter.dotfiles.toggle
-  function api.tree.toggle_hidden_filter() end
-
-  ---@deprecated
-  ---@see nvim_tree.api.filter.no_bookmark.toggle
-  function api.tree.toggle_no_bookmark_filter() end
-
-  api.config = { mappings = {} }
-
-  ---@deprecated
-  ---@see nvim_tree.api.map.keymap.current
-  function api.config.mappings.get_keymap() end
-
-  ---@deprecated
-  ---@see nvim_tree.api.map.keymap.default
-  function api.config.mappings.get_keymap_default() end
-
-  ---@deprecated nvim_tree.api.map.on_attach.default
-  ---@see nvim_tree.api.map.on_attach.default
-  function api.config.mappings.default_on_attach(_) end
-
-  api.live_filter = {}
-
-  ---@deprecated
-  ---@see nvim_tree.api.filter.live.start
-  function api.live_filter.start() end
-
-  ---@deprecated
-  ---@see nvim_tree.api.filter.live.clear
-  function api.live_filter.clear() end
-
-  api.diagnostics = {}
-
-  ---@deprecated
-  ---@see nvim_tree.api.health.hi_test
-  function api.diagnostics.hi_test() end
-
-  return api
-end
-
 return M