NVIM-SURROUND 使用教程

NVIM-SURROUND 使用教程

nvim-surroundAdd/change/delete surrounding delimiter pairs with ease. Written with :heart: in Lua.项目地址:https://gitcode.com/gh_mirrors/nv/nvim-surround

1. 项目介绍

NVIM-SURROUND 是一个由 Kyle Chui 开发的 Neovim 插件，它提供了一种方便的方式来添加、删除或改变文本周围的括号、引号或其他结构。该插件受到了 Vim-Surround 的启发，专为 Neovim 用户设计，让你可以优雅地处理文本的包围结构。

2. 项目快速启动

安装（以 Packer.nvim 为例）

首先确保你已经安装了 Packer.nvim。然后，在你的 init.vim 或 .config/nvim/init.vim 文件中加入以下配置：

use({
    "kylechui/nvim-surround",
    requires = { "folke/which-key.nvim" },
})

接着运行 :PackerSync 更新并安装插件。

配置

在你的配置文件中启用并配置 NVIM-SURROUND：

require('nvim-surround').setup({
    root_key = "S", -- 设置触发环绕操作的基础键
})

快捷键示例

• ysiw) 将选中的单词包裹在圆括号里。
• ds" 删除选定的双引号。
• cs}' 改变选定内容的括号类型，从大括号到花括号。

启动使用

重启 Neovim 后，你可以通过设置的 root_key（默认是 "S"）来访问 NVIM-SURROUND 提供的功能。例如，在正常模式下输入 S 然后选择相应的操作。

3. 应用案例和最佳实践

案例1：批量修改括号类型

如果你有一段代码需要将所有大括号更改为尖括号，你可以先移动光标到一对大括号内的任何位置，然后执行 cs> 命令。

案例2：创建 Markdown 列表

在文本光标处输入 - ，然后使用 yss 来包裹当前单词，快速创建一个列表项。

最佳实践：与 Which-Key 插件结合

使用 folke/which-key.nvim 可以显示快捷键提示，这样更容易记住 NVIM-SURROUND 的各种命令。

4. 典型生态项目

• Surround UI：roobert/surround-ui.nvim，这是一个辅助或训练工具，用于 NVIM-SURROUND 的操作，提供了键绑定可视化。
• Vim-Sandwich：另一个用于包围和编辑文本结构的 Vim 插件，虽然不是直接相关的 Neovim 插件，但它提供了类似的解决方案。

现在，你应该对 NVIM-SURROUND 有了基本了解，可以开始尝试在自己的 Neovim 中运用这些功能了。记得多练习，你会发现它的强大之处。

nvim-surroundAdd/change/delete surrounding delimiter pairs with ease. Written with :heart: in Lua.项目地址:https://gitcode.com/gh_mirrors/nv/nvim-surround