feat(event): custom lazy event hook for distros

folke · Oct 11, 2023 · b65d308 · b65d308
1 parent 303a3ed
commit b65d308
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/lua/lazy/core/handler/event.lua b/lua/lazy/core/handler/event.lua
@@ -23,6 +23,16 @@ M.triggers = {
   BufReadPost = "BufReadPre",
 }
 
+-- A table of mappings for custom events
+-- Can be used by distros to add custom events (see usage in LazyVim)
+---@type table<string, LazyEvent>
+M.mappings = {
+  VeryLazy = { id = "VeryLazy", event = "User", pattern = "VeryLazy" },
+  -- Example:
+  -- LazyFile = { id = "LazyFile", event = { "BufReadPost", "BufNewFile", "BufWritePre" } },
+}
+M.mappings["User VeryLazy"] = M.mappings.VeryLazy
+
 M.group = vim.api.nvim_create_augroup("lazy_handler_event", { clear = true })
 
 ---@param spec LazyEventSpec