refactor(events): define autocmd events using lua (#1727)

Author: pynappo

lua/neo-tree/events/init.lua

@@ -52,39 +52,50 @@ local M = {
   VIM_WIN_ENTER = "vim_win_enter",
 }
 
+---@param autocmds string
+---@return string event
+---@return string? pattern
+local parse_autocmd_string = function(autocmds)
+  local parsed = vim.split(autocmds, " ")
+  return parsed[1], parsed[2]
+end
+
 ---@param event_name neotree.Event|string
+---@param autocmds string[]
+---@param debounce_frequency integer
+---@param seed_fn function
+---@param nested boolean
 M.define_autocmd_event = function(event_name, autocmds, debounce_frequency, seed_fn, nested)
-  local opts = {
+  log.debug("Defining autocmd event: %s", event_name)
+  local augroup_name = "NeoTreeEvent_" .. event_name
+  q.define_event(event_name, {
     setup = function()
-      local tpl =
-        ":lua require('neo-tree.events').fire_event('%s', { afile = vim.F.npcall(vim.fn.expand, '<afile>') or '' })"
-      local callback = string.format(tpl, event_name)
-      if nested then
-        callback = "++nested " .. callback
+      local augroup = vim.api.nvim_create_augroup(augroup_name, { clear = false })
+      for _, autocmd in ipairs(autocmds) do
+        local event, pattern = parse_autocmd_string(autocmd)
+        log.trace("Registering autocmds on %s %s", event, pattern or "")
+        vim.api.nvim_create_autocmd({ event }, {
+          pattern = pattern or "*",
+          group = augroup,
+          nested = nested,
+          callback = function(args)
+            ---@class neotree.Event.Autocmd.CallbackArgs : vim.api.keyset.create_autocmd.callback_args
+            ---@field afile string
+            local event_args = args
+            event_args.afile = args.file or ""
+            M.fire_event(event_name, event_args)
+          end,
+        })
       end
-
-      local autocmd = table.concat(autocmds, ",")
-      if not vim.startswith(autocmd, "User") then
-        autocmd = autocmd .. " *"
-      end
-      local cmds = {
-        "augroup NeoTreeEvent_" .. event_name,
-        "autocmd " .. autocmd .. " " .. callback,
-        "augroup END",
-      }
-      log.trace("Registering autocmds: %s", table.concat(cmds, "\n"))
-      vim.cmd(table.concat(cmds, "\n"))
     end,
     seed = seed_fn,
     teardown = function()
       log.trace("Teardown autocmds for ", event_name)
-      vim.cmd(string.format("autocmd! NeoTreeEvent_%s", event_name))
+      vim.api.nvim_create_augroup(augroup_name, { clear = true })
     end,
     debounce_frequency = debounce_frequency,
     debounce_strategy = utils.debounce_strategy.CALL_LAST_ONLY,
-  }
-  log.debug("Defining autocmd event: %s", event_name)
-  q.define_event(event_name, opts)
+  })
 end
 
 M.clear_all_events = q.clear_all_events

lua/neo-tree/events/queue.lua

@@ -57,6 +57,8 @@ M.destroy_event = function(event_name)
   return true
 end
 
+---@param event string
+---@param args table
 local fire_event_internal = function(event, args)
   local queue = event_queues[event]
   if queue == nil then
@@ -99,6 +101,8 @@ local fire_event_internal = function(event, args)
   end)
 end
 
+---@param event string
+---@param args table?
 M.fire_event = function(event, args)
   local freq = utils.get_value(event_definitions, event .. ".debounce_frequency", 0, true)
   local strategy = utils.get_value(event_definitions, event .. ".debounce_strategy", 0, true)