docs(#3088): extract api/events.lua

Author: alex-courtis

doc/nvim-tree-lua.txt

@@ -2862,6 +2862,17 @@ Class: Config.Log                                       *nvim-tree-config-log*
 
 
 
+==============================================================================
+Lua module: nvim_tree.api.events                        *nvim-tree-api-events*
+
+subscribe({event_type}, {callback})         *nvim_tree.api.events.subscribe()*
+    Register a handler for an event, see |nvim-tree-events|.
+
+    Parameters: ~
+      • {event_type}  (`string`) |nvim_tree_events_kind|
+      • {callback}    (`fun(payload: table?)`)
+
+
 ==============================================================================
 Lua module: nvim_tree.api.filter                        *nvim-tree-api-filter*
 

lua/nvim-tree/api.lua

@@ -354,9 +354,14 @@ end)
 
 -- Api.git.reload = wrap_explorer("reload_git")
 
+function Api.hydrate_events(ev)
+  Api.events = ev
+
 Api.events.subscribe = events.subscribe
 Api.events.Event = events.Event
 
+end
+
 function Api.hydrate_filter(filter)
   Api.filter = filter
 

lua/nvim-tree/api/events.lua

@@ -0,0 +1,20 @@
+---@meta
+
+local events = require("nvim-tree.events")
+
+local nvim_tree = { api = { events = {} } }
+
+---
+---Register a handler for an event, see [nvim-tree-events].
+---
+---@param event_type string [nvim_tree_events_kind]
+---@param callback fun(payload: table?)
+function nvim_tree.api.events.subscribe(event_type, callback) end
+
+
+nvim_tree.api.events.Event = events.Event
+
+
+require("nvim-tree.api").hydrate_events(nvim_tree.api.events)
+
+return nvim_tree.api.events

lua/nvim-tree/api/init.lua

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

scripts/gen_vimdoc_config.lua

@@ -31,10 +31,11 @@ local modules = {
   { helptag = "nvim-tree-config-experimental",        title = "Class: Config.Experimental",       path = "./lua/nvim_tree/_meta/config/experimental.lua", },
   { helptag = "nvim-tree-config-log",                 title = "Class: Config.Log",                path = "./lua/nvim_tree/_meta/config/log.lua", },
 
+  { helptag = "nvim-tree-api-events",                 title = "Lua module: nvim_tree.api.events", path = "./lua/nvim_tree/api/events.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-marks",                    title = "Lua module: nvim_tree.api.marks",    path = "./lua/nvim_tree/api/marks.lua", },
+  { helptag = "nvim-tree-api-marks",                  title = "Lua module: nvim_tree.api.marks",  path = "./lua/nvim_tree/api/marks.lua", },
   { helptag = "nvim-tree-api-tree",                   title = "Lua module: nvim_tree.api.tree",   path = "./lua/nvim_tree/api/tree.lua", },
 }