如何在Neovim中复制Vim API并实现修改后回滚？

问题原因解析 #

• 直接赋值backup = vim无效：这只是传递引用，vim和backup指向同一个全局对象，修改vim的属性时backup会同步变化，执行vim = backup只是让变量重新指向同一个对象，没有任何恢复效果。
• vim.deepcopy报错：vim全局对象包含大量C层实现的userdata类型（如vim.api中的核心接口对象），而vim.deepcopy不支持拷贝该类型，因此抛出Cannot deepcopy object of type userdata错误。

可行解决方案 #

1. 针对性备份配置选项（推荐） #

如果只是需要备份和回滚vim.o/vim.opt这类编辑器配置，直接备份需要修改的选项即可，无需操作整个vim对象：

单选项备份

-- 备份行号配置
local number_backup = vim.o.number
-- 修改配置
vim.o.number = false
-- 回滚
vim.o.number = number_backup

批量备份所有可拷贝选项

-- 备份所有非userdata类型的选项
local function backup_all_opts()
  local opts_backup = {}
  for key, val in pairs(vim.o) do
    if type(val) ~= 'userdata' then
      opts_backup[key] = val
    end
  end
  return opts_backup
end

-- 恢复备份的选项
local function restore_opts(opts_backup)
  for key, val in pairs(opts_backup) do
    vim.o[key] = val
  end
end

-- 使用示例
local backup = backup_all_opts()
vim.o.number = false
vim.o.relativenumber = true
-- 回滚到之前状态
restore_opts(backup)

2. 备份与回滚快捷键/自动命令 #

如果需要修改vim.api管理的快捷键、自动命令等，需针对性备份对应的状态：

快捷键备份与回滚

-- 备份全局快捷键
local function backup_global_keymaps()
  return vim.api.nvim_get_keymap('n') -- 可替换为其他模式，如'i'/'v'
end

-- 恢复全局快捷键（先删除现有，再重新设置）
local function restore_global_keymaps(keymaps)
  -- 删除当前模式下的所有快捷键
  for _, km in ipairs(vim.api.nvim_get_keymap('n')) do
    vim.api.nvim_del_keymap('n', km.lhs)
  end
  -- 重新设置备份的快捷键
  for _, km in ipairs(keymaps) do
    vim.api.nvim_set_keymap(km.mode, km.lhs, km.rhs, { noremap = km.noremap, silent = km.silent })
  end
end

自动命令备份与回滚

-- 备份指定自动命令组
local function backup_autocmds(group_name)
  return vim.api.nvim_get_autocmds({ group = group_name })
end

-- 恢复自动命令（先清空组，再重新创建）
local function restore_autocmds(group_name, autocmds)
  vim.api.nvim_create_augroup(group_name, { clear = true })
  for _, ac in ipairs(autocmds) do
    vim.api.nvim_create_autocmd(ac.event, {
      group = group_name,
      pattern = ac.pattern,
      callback = ac.callback,
      command = ac.command
    })
  end
end

3. 代理对象实现API临时修改与回滚（高级用法） #

如果需要临时替换vim对象的部分API方法，可通过Lua元表创建代理，记录修改前的状态，回滚时恢复：

-- 创建vim代理对象及回滚函数
local function create_vim_proxy()
  local original_props = {}
  -- 代理对象，默认继承原vim的属性，修改时记录原始值
  local proxy = setmetatable({}, {
    __index = vim,
    __newindex = function(_, key, value)
      if original_props[key] == nil then
        original_props[key] = vim[key]
      end
      vim[key] = value
    end
  })
  -- 回滚函数：恢复所有被修改的属性
  local restore = function()
    for key, val in pairs(original_props) do
      vim[key] = val
    end
  end
  return proxy, restore
end

-- 使用示例
local vim_proxy, restore_vim = create_vim_proxy()
-- 通过代理修改vim属性
vim_proxy.o.number = false
-- 执行其他操作...
-- 回滚到初始状态
restore_vim()

总结 #

永远不要尝试备份整个vim全局对象——它包含大量不可拷贝的底层userdata结构。正确的做法是仅备份需要修改的具体模块或配置项，通过记录原始状态或代理拦截修改的方式实现回滚，既高效又避免不必要的错误。

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