如何通过循环在Lua中动态创建Neovim按键映射函数？

问题背景 #

在Neovim的mappings.lua文件中，原本通过手动方式为不同模式（普通模式n、可视模式v、终端模式t、插入模式i等）创建了快捷映射函数，示例代码如下：

local km = vim.api.nvim_set_keymap
local op = { noremap = true, silent = true }

local n = function(lhs, rhs)                                                                                                          
    return km('n', lhs, rhs, op)
end

local v = function(lhs, rhs)
    return km('v', lhs, rhs, op)
end

local t = function(lhs, rhs)
    return km('t', lhs, rhs, op)
end

local i = function(lhs, rhs)
    return km('i', lhs, rhs, op)
end

这些函数可以简化按键映射的编写，使用示例：

v('kj', '<esc>')

n('<a-h>', '<c-w>h')
n('<a-j>', '<c-w>j')
n('<a-k>', '<c-w>k')
n('<a-l>', '<c-w>l')

尝试通过loadstring循环批量创建这类函数但未成功，失败代码如下：

for k, v in pairs({'n','v','t','i','x'}) do
    loadstring("local function "..v.."(lhs,rhs) return km("..v..", lhs, rhs, op) end")
end

解决方案 #

方法一：直接在环境中动态创建函数（推荐） #

不需要使用loadstring，直接通过循环为每个模式生成对应的函数，可选择挂载到全局环境或自定义表中：

挂载到全局环境（保持原有调用方式）

local km = vim.api.nvim_set_keymap
local op = { noremap = true, silent = true }

-- 定义需要生成函数的模式列表
local modes = {'n', 'v', 't', 'i', 'x'}

for _, mode in ipairs(modes) do
    -- 将函数绑定到全局环境，直接调用模式名即可
    _G[mode] = function(lhs, rhs)
        return km(mode, lhs, rhs, op)
    end
end

挂载到自定义表（避免污染全局环境）

如果不想污染全局命名空间，可以把所有映射函数放到一个自定义表中：

local km = vim.api.nvim_set_keymap
local op = { noremap = true, silent = true }

local map = {}
local modes = {'n', 'v', 't', 'i', 'x'}

for _, mode in ipairs(modes) do
    map[mode] = function(lhs, rhs)
        return km(mode, lhs, rhs, op)
    end
end

-- 使用方式调整为：
map.v('kj', '<esc>')
map.n('<a-h>', '<c-w>h')

方法二：修复loadstring的使用方式 #

如果一定要使用loadstring，需要注意执行编译后的函数，并为其传入包含局部变量km和op的环境，同时修正字符串拼接的错误（模式名需要作为字符串传入km）：

local km = vim.api.nvim_set_keymap
local op = { noremap = true, silent = true }

local modes = {'n', 'v', 't', 'i', 'x'}
for _, mode in ipairs(modes) do
    -- 创建包含所需局部变量的环境
    local env = { km = km, op = op }
    setmetatable(env, { __index = _G })
    
    -- 编译代码，注意模式名要加引号
    local fn = loadstring("function "..mode.."(lhs,rhs) return km('"..mode.."', lhs, rhs, op) end")
    -- 设置函数的执行环境
    setfenv(fn, env)
    -- 执行函数以定义映射函数
    fn()
end

说明 #

• 方法一避免了字符串拼接的潜在问题，代码更简洁易读，性能也更优，是推荐方案。
• 方法二中，原失败代码的问题在于：未执行loadstring生成的函数、未将局部变量传入环境、模式名未作为字符串传入km函数。

内容的提问来源于stack exchange，提问作者Hamza Zubair