chore: Fix some EmmyLua annotations.

Author: sindrets

lua/winshift/lib.lua

@@ -4,8 +4,7 @@ local api = vim.api
 local M = {}
 local win_option_store = {}
 
----@class Node
----@type table<integer, Node>
+---@class Node : { [integer]: Node }
 ---@field type '"leaf"'|'"row"'|'"col"'
 ---@field parent Node
 ---@field index integer
@@ -142,7 +141,7 @@ end
 ---Move a row into a target window, replacing the target.
 ---@param row Node
 ---@param target integer Window id
----@param ignore table<integer, boolean>
+---@param ignore? table<integer, boolean>
 function M.move_row(row, target, ignore)
   ignore = ignore or {}
   local opt = { vertical = true, rightbelow = false }
@@ -164,7 +163,7 @@ end
 ---Move a column into a target window, replacing the target.
 ---@param col Node
 ---@param target integer Window id
----@param ignore table<integer, boolean>
+---@param ignore? table<integer, boolean>
 function M.move_col(col, target, ignore)
   ignore = ignore or {}
   local opt = { vertical = false, rightbelow = false }
@@ -391,7 +390,7 @@ function M.pick_window(ignore)
 end
 
 ---@param leaf Node
----@param flatten boolean
+---@param flatten? boolean
 ---@return VirtualNode|nil
 function M.create_virtual_set(leaf, flatten)
   if not leaf.parent then
@@ -628,7 +627,7 @@ end
 function M.restore_win_options(winid)
   for option, _ in pairs(config.get_config().moving_win_options) do
     if win_option_store[winid][option] then
-      utils.set_local(winid, option, win_option_store[winid][option])
+      utils.set_local(winid, { [option] = win_option_store[winid][option] })
     else
       utils.unset_local(winid, option)
     end

lua/winshift/utils.lua

@@ -43,13 +43,17 @@ function M.err(msg, schedule)
   M._echo_multiline("[WinShift.nvim] " .. msg, "ErrorMsg", schedule)
 end
 
-function M.no_win_event_call(cb)
-  local last = vim.opt.eventignore._value
-  vim.opt.eventignore = (
-      "WinEnter,WinLeave,WinNew,WinClosed,BufEnter,BufLeave"
-      .. (last ~= "" and "," .. last or "")
-    )
-  local ok, err = pcall(cb)
+---Call the function `f`, ignoring most of the window and buffer related
+---events. The function is called in protected mode.
+---@param f function
+---@return boolean success
+---@return any result Return value
+function M.no_win_event_call(f)
+  local last = vim.o.eventignore
+  vim.opt.eventignore:prepend(
+    "WinEnter,WinLeave,WinNew,WinClosed,BufWinEnter,BufWinLeave,BufEnter,BufLeave"
+  )
+  local ok, err = pcall(f)
   vim.opt.eventignore = last
   return ok, err
 end
@@ -259,59 +263,47 @@ function M.pause(msg)
   )
 end
 
+---@class SetLocalSpec
+---@field method '"set"'|'"remove"'|'"append"'|'"prepend"' Assignment method. (default: "set")
+
+---@class SetLocalListSpec : string[]
+---@field opt SetLocalSpec
+
 ---HACK: workaround for inconsistent behavior from `vim.opt_local`.
 ---@see [Neovim issue](https://github.com/neovim/neovim/issues/14670)
 ---@param winids number[]|number Either a list of winids, or a single winid (0 for current window).
----`opt` fields:
----   @tfield method '"set"'|'"remove"'|'"append"'|'"prepend"' Assignment method. (default: "set")
----@overload fun(winids: number[]|number, option: string, value: string[]|string|boolean, opt?: any)
----@overload fun(winids: number[]|number, map: table<string, string[]|string|boolean>, opt?: table)
-function M.set_local(winids, x, y, z)
+---@param option_map table<string, SetLocalListSpec|string|boolean>
+---@param opt? SetLocalSpec
+function M.set_local(winids, option_map, opt)
   if type(winids) ~= "table" then
     winids = { winids }
   end
 
-  local map, opt
-  if y == nil or type(y) == "table" then
-    map = x
-    opt = y
-  else
-    map = { [x] = y }
-    opt = z
-  end
-
   opt = vim.tbl_extend("keep", opt or {}, { method = "set" })
 
   local cmd
-  local ok, err = M.no_win_event_call(function()
-    for _, id in ipairs(winids) do
-      api.nvim_win_call(id, function()
-        for option, value in pairs(map) do
+  for _, id in ipairs(winids) do
+    api.nvim_win_call(id, function()
+      for option, value in pairs(option_map) do
+        if type(value) == "boolean" then
+          cmd = string.format("setl %s%s", value and "" or "no", option)
+        else
+          ---@type SetLocalSpec
           local o = opt
-
-          if type(value) == "boolean" then
-            cmd = string.format("setl %s%s", value and "" or "no", option)
-          else
-            if type(value) == "table" then
-              ---@diagnostic disable-next-line: undefined-field
-              o = vim.tbl_extend("force", opt, value.opt or {})
-              value = table.concat(value, ",")
-            end
-
-            cmd = M.str_template(
-              setlocal_opr_templates[o.method],
-              { option = option, value = tostring(value):gsub("'", "''") }
-            )
+          if type(value) == "table" then
+            o = vim.tbl_extend("force", opt, value.opt or {})
+            value = table.concat(value, ",")
           end
 
-          vim.cmd(cmd)
+          cmd = M.str_template(
+            setlocal_opr_templates[o.method],
+            { option = option, value = tostring(value):gsub("'", "''") }
+          )
         end
-      end)
-    end
-  end)
 
-  if not ok then
-    error(err)
+        vim.cmd(cmd)
+      end
+    end)
   end
 end
 
@@ -322,13 +314,11 @@ function M.unset_local(winids, option)
     winids = { winids }
   end
 
-  M.no_win_event_call(function()
-    for _, id in ipairs(winids) do
-      api.nvim_win_call(id, function()
-        vim.cmd(string.format("set %s<", option))
-      end)
-    end
-  end)
+  for _, id in ipairs(winids) do
+    api.nvim_win_call(id, function()
+      vim.cmd(string.format("set %s<", option))
+    end)
+  end
 end
 
 return M