feat: add types to arguments of register, and validate it

pogyomo · Jun 18, 2024 · 597c2a7 · 597c2a7
1 parent 766c3cd
commit 597c2a7
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/lua/submode/init.lua b/lua/submode/init.lua
@@ -71,7 +71,15 @@ function M.create(name, opts, default)
         })
     end
 
+    ---@param lhs string
+    ---@param rhs string | fun():string?
+    ---@param opts_ vim.keymap.set.Opts?
     local register = function(lhs, rhs, opts_)
+        vim.validate {
+            lhs = { lhs, "string" },
+            rhs = { rhs, { "string", "function" } },
+            opts = { opts_, "table", true },
+        }
         M.state.submode_to_default_mappings[name][lhs] = {
             rhs = rhs,
             opts = opts_,

diff --git a/lua/submode/types.lua b/lua/submode/types.lua
@@ -26,6 +26,6 @@
 ---Infomation of mapping except lhs.
 ---@class SubmodeMappingElement
 ---@field rhs string | fun():string?
----@field opts? table
+---@field opts? vim.keymap.set.Opts
 
 ---@alias SubmodeDefaultMappingRegister fun(lhs: string, rhs: string | function, opts: vim.keymap.set.Opts?)