docs(#3088): extract api/health.lua, tidy formatting

Author: alex-courtis

lua/nvim-tree/api.lua

@@ -392,7 +392,14 @@ Api.config.mappings.default_on_attach = Api.map.default_on_attach
 
 end
 
-Api.diagnostics.hi_test = wrap(appearance_hi_test)
+function Api.hydrate_health(health)
+  Api.health = health
+
+Api.health.hi_test = wrap(appearance_hi_test)
+
+-- TODO #3088 legacy mappings have to go somewhere
+Api.diagnostics.hi_test = Api.health.hi_test
+end
 
 Api.commands.get = wrap(function()
   return require("nvim-tree.commands").get()

lua/nvim-tree/api/filter.lua

@@ -1,17 +1,16 @@
 ---@meta
 local nvim_tree = { api = { filter = { live_filter = {} } } }
 
-
-
+---
 ---Enter live filter mode. Opens an input window with [filetype] `NvimTreeFilter`
+---
 function nvim_tree.api.filter.live_filter.start() end
 
-
+---
 ---Exit live filter mode.
+---
 function nvim_tree.api.filter.live_filter.clear() end
 
-
-
 require("nvim-tree.api").hydrate_filter(nvim_tree.api.filter)
 
 return nvim_tree.api.filter

lua/nvim-tree/api/health.lua

@@ -0,0 +1,13 @@
+---@meta
+local nvim_tree = { api = { health = {} } }
+
+---
+---Open a new buffer displaying all nvim-tree highlight groups, their link chain and concrete definition.
+---
+---Similar to `:so $VIMRUNTIME/syntax/hitest.vim` as per |:highlight|
+---
+function nvim_tree.api.health.hi_test() end
+
+require("nvim-tree.api").hydrate_health(nvim_tree.api.health)
+
+return nvim_tree.api.health

lua/nvim-tree/api/init.lua

@@ -1,5 +1,6 @@
 return {
   filter = require("nvim-tree.api.filter"),
+  health = require("nvim-tree.api.health"),
   map = require("nvim-tree.api.map"),
   tree = require("nvim-tree.api.tree"),
 }

lua/nvim-tree/api/map.lua

@@ -1,29 +1,24 @@
 ---@meta
 local nvim_tree = { api = { map = {} } }
 
-
-
+---
 ---Retrieve all buffer local mappings for nvim-tree. These are the mappings that are applied by [nvim_tree.Config] {on_attach}, which may include default mappings.
 ---
 ---@return vim.api.keyset.get_keymap[]
 function nvim_tree.api.map.get_keymap() end
 
-
-
+---
 --- Retrieves the buffer local mappings for nvim-tree that are applied by [nvim_tree.api.map.default_on_attach()]
 ---
 ---@return vim.api.keyset.get_keymap[]
 function nvim_tree.api.map.get_keymap_default() end
 
-
-
+---
 ---Apply all [nvim-tree-mappings-default]. Call from your [nvim_tree.Config] {on_attach}.
 ---
 ---@param bufnr integer use the `bufnr` passed to {on_attach}
 function nvim_tree.api.map.default_on_attach(bufnr) end
 
-
-
 require("nvim-tree.api").hydrate_map(nvim_tree.api.map)
 
 return nvim_tree.api.map

lua/nvim-tree/commands.lua

@@ -137,7 +137,7 @@ local CMDS = {
       desc = "nvim-tree: highlight test",
     },
     command = function()
-      require("nvim-tree.api").diagnostics.hi_test()
+      require("nvim-tree.api").health.hi_test()
     end,
   },
 }

scripts/gen_vimdoc_config.lua

@@ -32,6 +32,7 @@ local modules = {
   { helptag = "nvim-tree-config-log",                 title = "Class: Config.Log",                path = "./lua/nvim_tree/_meta/config/log.lua", },
 
   { helptag = "nvim-tree-api-filter",                 title = "Lua module: nvim_tree.api.filter", path = "./lua/nvim_tree/api/filter.lua", },
+  { helptag = "nvim-tree-api-health",                 title = "Lua module: nvim_tree.api.health", path = "./lua/nvim_tree/api/health.lua", },
   { helptag = "nvim-tree-api-map",                    title = "Lua module: nvim_tree.api.map",    path = "./lua/nvim_tree/api/map.lua", },
   { helptag = "nvim-tree-api-tree",                   title = "Lua module: nvim_tree.api.tree",   path = "./lua/nvim_tree/api/tree.lua", },
 }