一体化插件
由 45+ 个独立 Lua 模块组成的库,以最小投入提升整体 Neovim(版本 0.10 及更高)使用体验。它们都采用相同的配置方式和通用设计原则。
可以把这个项目看作 Neovim 插件中的“瑞士军刀”:它包含许多不同的独立工具(模块),适用于大多数常见任务。每个模块都可以单独使用,不会带来任何启动和使用开销。
如果你希望帮助这个项目成长但不知道从何入手:
- 为 'mini.nvim'(在任意受支持的代码托管平台上)和/或其他任何 MINI 项目点一个 star。
- 查看贡献指南。
变更历史(包括当前开发版本)请参见变更日志。
基于 'mini.nvim' 的完整配置示例请参见 MiniMax。
本项目此前托管在 echasnovski/mini.nvim。为提升项目的长期稳定性,它已被转移到一个专门的组织。更多详情请参见此处。
目录
- 安装
- 通用原则
- 插件配色方案
- 计划中的模块
安装
本项目托管在多个代码托管平台上(在安装代码片段中使用你偏好的链接):
- https://github.com/nvim-mini/mini.nvim (主)
- https://tangled.org/nvim-mini.org/mini.nvim (镜像)
- https://codeberg.org/nvim-mini/mini.nvim (镜像)
有两个分支可供安装:
- main(默认,推荐)包含插件的最新开发版本。自上一个稳定版本以来的所有变更都应被视为处于 beta 测试阶段(即它们已经通过了 alpha 测试并且基本稳定)。
- stable 仅在发布时更新,其代码已在 main 分支的公开 beta 测试阶段经过测试。
以下是一些常见安装方式的代码片段:
- (推荐)使用 vim.pack(在 Neovim 0.12 及更新版本上):Main 分支:vim.pack.add({ 'https://github.com/nvim-mini/mini.nvim' }) Stable 分支:vim.pack.add({ { src = 'https://github.com/nvim-mini/mini.nvim', version = 'stable' }, })
(推荐)使用 vim.pack(在 Neovim 0.12 及更新版本上):
- Main 分支:vim.pack.add({ 'https://github.com/nvim-mini/mini.nvim' })
Main 分支:
vim.pack.add({ 'https://github.com/nvim-mini/mini.nvim' })
- Stable 分支:vim.pack.add({ { src = 'https://github.com/nvim-mini/mini.nvim', version = 'stable' }, })
Stable 分支:
vim.pack.add({
{ src = 'https://github.com/nvim-mini/mini.nvim', version = 'stable' },
})
- 使用 git clone 手动安装(兼容 mini.deps):-- Put this at the top of 'init.lua' local path_package = vim.fn.stdpath('data') .. '/site' local mini_path = path_package .. '/pack/deps/start/mini.nvim' if not vim.uv.fs_stat(mini_path) then vim.cmd('echo "Installing
mini.nvim" | redraw') local clone_cmd = { 'git', 'clone', '--filter=blob:none', -- Uncomment next line to use 'stable' branch -- '--branch', 'stable', 'https://github.com/nvim-mini/mini.nvim', mini_path } vim.fn.system(clone_cmd) vim.cmd('packadd mini.nvim | helptags ALL') vim.cmd('echo "Installedmini.nvim" | redraw') end
使用 git clone 手动安装(兼容 mini.deps):
-- Put this at the top of 'init.lua'
local path_package = vim.fn.stdpath('data') .. '/site'
local mini_path = path_package .. '/pack/deps/start/mini.nvim'
if not vim.uv.fs_stat(mini_path) then
vim.cmd('echo "Installing `mini.nvim`" | redraw')
local clone_cmd = {
'git', 'clone', '--filter=blob:none',
-- Uncomment next line to use 'stable' branch
-- '--branch', 'stable',
'https://github.com/nvim-mini/mini.nvim', mini_path
}
vim.fn.system(clone_cmd)
vim.cmd('packadd mini.nvim | helptags ALL')
vim.cmd('echo "Installed `mini.nvim`" | redraw')
end
- 使用 folke/lazy.nvim:Main 分支:{ 'nvim-mini/mini.nvim', version = false }, Stable 分支:{ 'nvim-mini/mini.nvim', version = '*' },
使用 folke/lazy.nvim:
- Main 分支:{ 'nvim-mini/mini.nvim', version = false },
Main 分支:
{ 'nvim-mini/mini.nvim', version = false },
- 稳定分支:{ 'nvim-mini/mini.nvim', version = '*' },
稳定分支:
{ 'nvim-mini/mini.nvim', version = '*' },
- 每个模块也作为独立的 Git 仓库分发。查看模块的信息以了解更多详情。
重要:不要忘记调用模块的 setup()(如有需要)以启用其功能。
注意:如果使用 Windows,可能会遇到文件路径过长的问题(例如错误:unable to create file <some file name>: Filename too long)。尝试执行以下操作之一:
- 启用对应的 git 全局配置值:git config --system core.longpaths true。然后尝试重新安装。
- 将插件安装到路径更短的其他位置。
模块
'mini.nvim' 包含许多模块,一开始可能略显繁多。所有模块都可以独立使用,一次一个。
为便于探索,这里按模块的主要功能将它们分组呈现(尽管有些模块可能适合多个分组)。在此查看更详细的列表。
文本编辑
这些模块改善你的文本编辑体验。可从 'mini.ai'、'mini.operators' 和 'mini.surround' 开始。
| 模块 | 描述 | 概览 | 详情 |
|---|---|---|---|
| mini.ai | 扩展并创建 a / i 文本对象 | README | 文档 |
| mini.align | 交互式对齐文本 | README | 文档 |
| mini.comment | 注释行 | README | 文档 |
| mini.completion | 补全和签名帮助 | README | 文档 |
| mini.keymap | 特殊键映射 | README | 文档 |
| mini.move | 向任意方向移动任意选择 | README | 文档 |
| mini.operators | 文本编辑操作符 | README | 文档 |
| mini.pairs | 自动配对 | README | 文档 |
| mini.snippets | 管理和展开代码片段 | README | 文档 |
| mini.splitjoin | 拆分和合并参数 | README | 文档 |
| mini.surround | 环绕操作 | README | 文档 |
通用工作流
这些模块改善你的通用工作流。可从 'mini.bracketed'、'mini.files' 和 'mini.pick' 开始。
| 模块 | 描述 | 概览 | 详情 |
|---|---|---|---|
| mini.basics | 常用配置预设 | README | 文档 |
| mini.bracketed | 使用方括号向前/向后跳转 | README | 文档 |
| mini.bufremove | 移除缓冲区 | README | 文档 |
| mini.clue | 显示下一个按键提示 | README | 文档 |
| mini.cmdline | 命令行调整 | README | 文档 |
| mini.deps | 插件管理器 | README | 文档 |
| mini.diff | 处理差异块 | README | 文档 |
| mini.extra | 'mini.nvim' 的额外功能 | README | 文档 |
| mini.files | 浏览和操作文件系统 | README | 文档 |
| mini.git | Git 集成 | README | 文档 |
| mini.input | 获取用户输入 | README | 文档 |
| mini.jump | 跳转到下一个/上一个单个字符 | README | 文档 |
| mini.jump2d | 在可见行内跳转 | README | 文档 |
| mini.misc | 杂项函数 | README | 文档 |
| mini.pick | 选择任意内容 | README | 文档 |
| mini.sessions | 会话管理 | README | 文档 |
| mini.visits | 跟踪并复用文件系统访问记录 | README | 文档 |
外观
这些模块改善你的 Neovim 外观。可从 'mini.hues'、'mini.icons' 和 'mini.statusline' 开始。
| 模块 | 描述 | 概览 | 详情 |
|---|---|---|---|
| mini.animate | 为常见 Neovim 操作添加动画 | README | 文档 |
| mini.base16 | 创建 Base16 配色方案 | README | 文档 |
| mini.colors | 调整并保存任意配色方案 | README | 文档 |
| mini.cursorword | 自动高亮光标下的单词 | README | 文档 |
| mini.hipatterns | 高亮文本中的模式 | README | 文档 |
| mini.hues | 生成可配置的配色方案 | README | 文档 |
| mini.icons | 图标提供者 | README | 文档 |
| mini.indentscope | 可视化并操作缩进范围 | README | 文档 |
| mini.map | 带缓冲区文本概览的窗口 | README | 文档 |
| mini.notify | 显示通知 | README | 文档 |
| mini.starter | 启动屏幕 | README | 文档 |
| mini.statuscolumn | 状态列 | README | 文档 |
| mini.statusline | 状态行 | README | 文档 |
| mini.tabline | 标签行 | README | 文档 |
| mini.trailspace | 行尾空白(高亮与移除) | README | 文档 |
其他
这些模块不太适合归入之前的任何类别。
| 模块 | 描述 | 概览 | 详情 |
|---|---|---|---|
| mini.doc | 生成 Neovim 帮助文件 | README | 文档 |
| mini.fuzzy | 模糊匹配 | README | 文档 |
| mini.test | 测试 Neovim 插件 | README | 文档 |
通用原则
设计
每个模块都旨在解决特定问题,力求在功能丰富性(尽可能处理更多边缘情况)与实现/支持的简洁性之间取得平衡。诚然,并非所有模块最终都达到了相同的平衡,但这仍是目标。
独立性
模块之间相互独立,无需外部依赖即可运行。尽管其中一些模块可能需要依赖才能获得完整体验。
结构
每个模块都是占位“mini”模块的子模块。因此,例如“surround”模块应被称为“mini.surround”。后文将会说明,该插件也可被称为“MiniSurround”。
设置
- 你想使用的每个模块都应通过 require(<name of module>).setup({}) 单独启用。可以将 {} 替换为你的配置表,或完全省略以使用默认值。你可以只提供部分配置,其余部分将从默认值推断。
- 调用模块的 setup() 总是会创建一个全局 Lua 对象,其名称采用一致的驼峰式命名:require('mini.surround').setup() 会创建 _G.MiniSurround。这样可以更简单地使用插件功能:无需使用 require('mini.surround'),而是使用 MiniSurround(或在命令行中手动执行 :lua MiniSurround.*);可通过 v:lua 访问,如 v:lua.MiniSurround。因此,“模块”和“Lua 对象”的名称可以互换使用:'mini.surround' 和 'MiniSurround' 含义相同。
- 每个提供的配置表都存储在全局对象的 config 字段中,如 MiniSurround.config。
- 影响运行时活动的配置值可以即时更改并生效。例如,MiniSurround.config.n_lines 可以在运行时更改;但更改 MiniSurround.config.mappings 不会产生任何效果(因为映射是在 setup() 期间一次性创建的)。
- 如果模块在某个特定的非默认选项值下效果最佳,则该值会在 setup() 期间设置。如果该值对模块功能并非必要,则仅在用户或其他插件之前未设置过(无论值为何)的情况下才会设置。
缓冲区局部配置
每个模块还可以额外配置为在缓冲区本地使用特定的运行时配置设置。更多信息请参阅帮助文件中的 mini.nvim-buffer-local-config 部分。
缓冲区名称
Mini.nvim 现已登陆 Tangled
所有模块相关缓冲区都按以下格式命名:mini<module-name>://<buffer-number>/<useful-info>(在任何平台上都使用正斜杠;<useful-info> 可以为空)。这种结构允许创建可识别、合理唯一且有意义的缓冲区名称。例如,'mini.files' 的缓冲区按显示的目录/文件创建,名称类似 minifiles://10/path/to/displayed/directory。
禁用
每个模块的核心功能可以全局禁用,也可以针对缓冲区局部禁用。更多细节请参见模块帮助页中的“Disabling”部分。常见用法请参见主帮助文件中的 mini.nvim-disabling-recipes 部分。
静默
每个提供非错误反馈的模块(例如在 'mini.ai'、'mini.jump2d'、'mini.surround' 中空闲一段时间后提醒按键)都可以通过设置 config.silent = true(在 setup() 调用中或运行时)来配置为不进行此类反馈。
高亮
模块输出的外观由特定的一组高亮组控制(参见 :h highlight-groups)。默认情况下,它们通常会链接到语义上接近的内置高亮组,并确保在任何配色方案生效后定义。使用 :highlight 命令或 vim.api.nvim_set_hl() Lua 函数来自定义高亮。要查看更经过校准的外观,请使用 'mini.hues'、'mini.base16' 或插件的配色方案。
稳定性
每个模块在发布时都被
这是目前我打算最终实现(在自由时间和精力允许的情况下)的模块列表,按字母顺序排列:
- 'mini.abbrev' —— 用于管理/设置插入模式缩写的辅助模块。
- 'mini.cycle' —— 按预定义规则在备选项之间循环切换。类似 monaqa/dial.nvim 和 AndrewRadev/switch.vim。
- 'mini.folds' —— 功能更强、更易用的折叠。
- 'mini.repl' —— 可扩展的 REPL 封装,内置对 R、Python、Julia 的支持,或许(只是或许)还会支持一些 AI 工具。
- 'mini.sendtext' —— 在缓冲区之间发送文本,特别是普通缓冲区与内置终端缓冲区之间。
- 'mini.terminals' —— 统一管理交互式终端缓冲区。类似 kassio/neoterm。可能还会加入在 shell 中异步运行代码并对结果做后处理的功能。
- 'mini.quickfix' —— 功能更强、更易用的 quickfix 列表。可能带有预览与行内编辑,以支持搜索替换工作流。
- 'mini.windows' —— 窗口管理器。交互式选择器、布局整理,或许还有更多。