Legendary.nvim：你的Neovim快捷键图例助手

Legendary.nvim：你的Neovim快捷键图例助手

legendary.nvim 🗺️ A legend for your keymaps, commands, and autocmds, integrates with which-key.nvim, lazy.nvim, and more. 项目地址: https://gitcode.com/gh_mirrors/le/legendary.nvim

项目介绍

Legendary.nvim 是一个专为 Neovim 用户设计的插件，它旨在通过简单易懂的 Lua 表结构让你定义键映射（keymaps）、命令（commands）及自动命令（autocmds），同时构建一个直观的“图例”界面。这一功能类似于 Visual Studio Code 的命令面板，但完全适配于 Neovim 环境。它无缝集成 which-key.nvim 提供的提示，并支持 lazy.nvim 动态加载机制，增加工作流程的灵活性。

主要特性：

• Lua 表定义：使用简洁的 Lua 结构来定义复杂的操作。
• 集成与扩展性：与 which-key.nvim 和 lazy.nvim 高度兼容，支持自动从其他插件加载配置。
• 智能化排序：基于使用频率和最近使用时间的综合排序（frecency sort）。
• 缓冲区本地化：特定缓冲区的操作仅在对应缓冲区可见。
• 灵活性：匿名映射显示，不需要 Legendary 处理映射创建。
• 自动管理：可以自动化加载其他插件的键映射和命令。

项目快速启动

为了快速开始使用 Legendary.nvim，首先确保你的 Neovim 已经安装了必要的依赖，特别是对 telescope.nvim 与 dressing.nvim 的搭配推荐用于展示界面。

安装步骤

如果你使用的是 lazy.nvim:

-- 在 lazy.nvim 的配置中添加 Legendary.nvim
local lazy = require('lazy.nvim')
lazy.config.set({
  plugins = {
    ['mrjones2014/legendary.nvim'] = {
      version = 'v最新版本',
      priority = 10000,
      lazy = false, -- 建议提前加载 Legendary
      extensions = { lazy_nvim = true } -- 自动加载 lazy.nvim 中的键映射
    },
    -- 根据需要可能还需要加入 sqlite.lua 支持 frecency 排序
  },
})

如果是 vim-plug 用户，则可以在 .vimrc 或 Neovim 的配置文件中添加：

Plug 'mrjones2014/legendary.nvim', { 'tag': 'v具体版本号' }
Plug 'kkharji/sqlite.lua' " 若想启用 frecency 功能需安装此插件

之后运行 :PlugInstall 来安装插件。

初始化配置

在 Neovim 启动后，通过以下方式初始化 Legendary.nvim：

require('legendary').setup({
  -- 可以在此处添加自定义配置
  extensions = {
    lazy_nvim = true, -- 开启 lazy.nvim 插件的键映射自动加载
  },
  keymaps = { ... }, -- 添加你的键映射定义
})

应用案例和最佳实践

将你的日常快捷键组织成逻辑分组，通过 Legendary.nvim，你可以轻松实现这一点。例如，为文件搜索定义一个键映射：

require('legendary').setup({
  keymaps = {
    ['<leader>ff'] = {
      ':Telescope find_files',
      description = '查找文件'
    },
  },
})

这允许你通过 <Leader>ff 快速调用 Telescope 来寻找文件，同时保持你的键映射清晰有序。

典型生态项目集成

Legendary.nvim 能够与 Neovim 生态中的其他重要工具紧密结合。例如：

• which-key.nvim: 利用现有的 which-key 配置或让两者自动同步，让你的快捷键提示更加统一和强大。
• lazy.nvim: 动态加载机制减少启动时间，同时也使得 Legendary.nvim 能与你的延迟加载策略一致。
• nvim-tree: 通过配置 Legendary.nvim 的特定扩展，可以让你的文件树导航操作直接整合到图例中。
• diffview.nvim: 当处理代码差异时，针对性地访问相关命令和快捷键。

确保查看官方文档了解更多细节，以及如何针对特定插件进行配置，利用 Legendary.nvim 让你的 Neovim 编辑体验更上一层楼。

legendary.nvim 🗺️ A legend for your keymaps, commands, and autocmds, integrates with which-key.nvim, lazy.nvim, and more. 项目地址: https://gitcode.com/gh_mirrors/le/legendary.nvim