refactor(#3255): move Event to meta

Author: alex-courtis

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

@@ -1,6 +1,24 @@
 ---@meta
 local nvim_tree = { api = { events = {} } }
 
+nvim_tree.api.events.Event = {
+  Ready = "Ready",
+  WillRenameNode = "WillRenameNode",
+  NodeRenamed = "NodeRenamed",
+  TreePreOpen = "TreePreOpen",
+  TreeOpen = "TreeOpen",
+  TreeClose = "TreeClose",
+  WillCreateFile = "WillCreateFile",
+  FileCreated = "FileCreated",
+  WillRemoveFile = "WillRemoveFile",
+  FileRemoved = "FileRemoved",
+  FolderCreated = "FolderCreated",
+  FolderRemoved = "FolderRemoved",
+  Resize = "Resize",
+  TreeAttachedPost = "TreeAttachedPost",
+  TreeRendered = "TreeRendered",
+}
+
 ---
 ---Register a handler for an event, see [nvim-tree-events].
 ---

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

@@ -25,9 +25,11 @@ end
 ---Hydrate api functions and classes pre-setup
 ---@param api table not properly typed to prevent LSP from referencing implementations
 function M.hydrate(api)
-  -- default to the error message
+  -- default everything to the error message
   hydrate_error(api)
 
+  api.Decorator             = require("nvim-tree.renderer.decorator")
+
   api.appearance.hi_test    = function() require("nvim-tree.appearance.hi-test")() end
 
   api.commands.get          = function() return require("nvim-tree.commands").get() end
@@ -39,10 +41,6 @@ function M.hydrate(api)
   api.map.keymap.default    = function() return require("nvim-tree.keymap").get_keymap_default() end
   api.map.on_attach.default = function(bufnr) require("nvim-tree.keymap").on_attach_default(bufnr) end
 
-  -- classes
-  api.Decorator             = function() return require("nvim-tree.renderer.decorator"):extend() end
-  api.events.Event          = require("nvim-tree.events").Event -- TODO 3255 move this to meta
-
   -- Hydrate any legacy by mapping to concrete set above
   require("nvim-tree.legacy").map_api(api)
 end

lua/nvim-tree/events.lua

@@ -1,27 +1,10 @@
 local notify = require("nvim-tree.notify")
+local Event = require("nvim-tree._meta.api.events").Event
 
 local M = {}
 
 local global_handlers = {}
 
-M.Event = {
-  Ready = "Ready",
-  WillRenameNode = "WillRenameNode",
-  NodeRenamed = "NodeRenamed",
-  TreePreOpen = "TreePreOpen",
-  TreeOpen = "TreeOpen",
-  TreeClose = "TreeClose",
-  WillCreateFile = "WillCreateFile",
-  FileCreated = "FileCreated",
-  WillRemoveFile = "WillRemoveFile",
-  FileRemoved = "FileRemoved",
-  FolderCreated = "FolderCreated",
-  FolderRemoved = "FolderRemoved",
-  Resize = "Resize",
-  TreeAttachedPost = "TreeAttachedPost",
-  TreeRendered = "TreeRendered",
-}
-
 ---@param event_name string
 ---@return table
 local function get_handlers(event_name)
@@ -49,77 +32,77 @@ end
 
 --@private
 function M._dispatch_ready()
-  dispatch(M.Event.Ready)
+  dispatch(Event.Ready)
 end
 
 --@private
 function M._dispatch_will_rename_node(old_name, new_name)
-  dispatch(M.Event.WillRenameNode, { old_name = old_name, new_name = new_name })
+  dispatch(Event.WillRenameNode, { old_name = old_name, new_name = new_name })
 end
 
 --@private
 function M._dispatch_node_renamed(old_name, new_name)
-  dispatch(M.Event.NodeRenamed, { old_name = old_name, new_name = new_name })
+  dispatch(Event.NodeRenamed, { old_name = old_name, new_name = new_name })
 end
 
 --@private
 function M._dispatch_will_remove_file(fname)
-  dispatch(M.Event.WillRemoveFile, { fname = fname })
+  dispatch(Event.WillRemoveFile, { fname = fname })
 end
 
 --@private
 function M._dispatch_file_removed(fname)
-  dispatch(M.Event.FileRemoved, { fname = fname })
+  dispatch(Event.FileRemoved, { fname = fname })
 end
 
 --@private
 function M._dispatch_will_create_file(fname)
-  dispatch(M.Event.WillCreateFile, { fname = fname })
+  dispatch(Event.WillCreateFile, { fname = fname })
 end
 
 --@private
 function M._dispatch_file_created(fname)
-  dispatch(M.Event.FileCreated, { fname = fname })
+  dispatch(Event.FileCreated, { fname = fname })
 end
 
 --@private
 function M._dispatch_folder_created(folder_name)
-  dispatch(M.Event.FolderCreated, { folder_name = folder_name })
+  dispatch(Event.FolderCreated, { folder_name = folder_name })
 end
 
 --@private
 function M._dispatch_folder_removed(folder_name)
-  dispatch(M.Event.FolderRemoved, { folder_name = folder_name })
+  dispatch(Event.FolderRemoved, { folder_name = folder_name })
 end
 
 --@private
 function M._dispatch_on_tree_pre_open()
-  dispatch(M.Event.TreePreOpen, nil)
+  dispatch(Event.TreePreOpen, nil)
 end
 
 --@private
 function M._dispatch_on_tree_open()
-  dispatch(M.Event.TreeOpen, nil)
+  dispatch(Event.TreeOpen, nil)
 end
 
 --@private
 function M._dispatch_on_tree_close()
-  dispatch(M.Event.TreeClose, nil)
+  dispatch(Event.TreeClose, nil)
 end
 
 --@private
 function M._dispatch_on_tree_resize(size)
-  dispatch(M.Event.Resize, size)
+  dispatch(Event.Resize, size)
 end
 
 --@private
 function M._dispatch_tree_attached_post(buf)
-  dispatch(M.Event.TreeAttachedPost, buf)
+  dispatch(Event.TreeAttachedPost, buf)
 end
 
 --@private
 function M._dispatch_on_tree_rendered(bufnr, winnr)
-  dispatch(M.Event.TreeRendered, { bufnr = bufnr, winnr = winnr })
+  dispatch(Event.TreeRendered, { bufnr = bufnr, winnr = winnr })
 end
 
 return M