finish textobject

Author: archibate

README.md

@@ -12,15 +12,15 @@ curl -sSLf https://142857.red/files/nvimrc-install.sh | bash
 
 如果安装遇到问题，欢迎通过 [GitHub issue](github.com/archibate/vimrc/issues) 反映，我会尽快帮您解决。
 
-* 目前只支持 Linux 系统，暂时不支持 MacOS 等系统。
+* 目前只支持 Linux 和 MacOS 系统，暂不支持 Wendous 系统。
 * 请勿以 root 身份运行！否则会为 root 安装 nvim 插件而不是当前用户，插件安装后仅对当前用户有效。
 * 您的系统中无需事先安装有 nvim，本整合包内部已经自带了最新版 nvim 的 AppImage，可无依赖直接运行。
 * 无需连接 GitHub，所有插件全部已经预下载在整合包内部，无需 GitHub 加速器！
 * 过程中会通过您系统的包管理器安装一些工具，所以只需确保包管理器的设置是国内源即可。
 * 为了能够使用补全，会为您安装如 clangd 一类的包，但即使其中一个安装失败，也不影响其他语言和编辑器整体的使用。
 * 安装脚本运行中可能产生一些冗余错误信息，属于正常现象，不影响使用，请忽视他们。
 
-安装完成后，输入 `nvim` 即可使用，按 q 或 :wqa 即可退出。
+安装完成后，输入 `nvim` 即可使用，按 `q` 或 `:wqa` 即可退出。
 
 如需更新，重新执行上面的一键安装命令即可。
 
@@ -46,8 +46,8 @@ curl -sSLf https://142857.red/files/nvimrc-install.sh | bash
 - Q: 出现乱码，无法正确显示符号？
 - A: 安装 [Nerd Font](https://www.cnblogs.com/zi-wang/p/12566898.html) 字体，并把终端设置为该字体。然后在 `nvim` 中输入 `:lua require'archvim.options'.nerd_fonts = true`，重启，这样以后就可以正确显示文件类型图标了。如果不喜欢，那就 `:lua require'archvim.options'.nerd_fonts = false` 关闭。
 
-- Q: 编辑 C/C++ 源码时不识别头文件目录，“飙红线”，怎么办？
-- A: 要么在 NeoVim 中用 `:CMakeGenerate` 命令，要么给 `cmake` 指定 `-DCMAKE_EXPORT_COMPILE_COMMANDS=ON` 参数，详见下方的 “C/C++/CMake 配置” 章节。
+- Q: 打开 C/C++ 源码时不识别头文件目录，“飙红线”，怎么办？
+- A: 请先在 NeoVim 中用 `:CMakeGenerate` 命令配置项目！否则无法识别你 CMake 里的编译选项。如果一定要命令行构建，请给 `cmake` 指定 `-DCMAKE_EXPORT_COMPILE_COMMANDS=ON` 参数，这样 C++ 补全才能正常工作，详见下方的 “C/C++/CMake 配置” 章节。
 
 - Q: 支持（非 Neo 的）Vim 吗？
 - A: 本分支只有 NeoVim 配置，对于来自 BV1H44y1V7DW 视频想领取老版 Vim 插件的同学，请移步 [main 分支](https://github.com/archibate/vimrc/tree/main)。
@@ -64,7 +64,7 @@ curl -sSLf https://142857.red/files/nvimrc-install.sh | bash
 - OpenSUSE (感谢 @sleeplessai 大佬)
 - CentOS (感谢 @xxy-im 大佬)
 - Deepin (感谢 @zhangasia 大佬)
-- MacOS (感谢 @YangZ2020 测试)
+- MacOS (感谢 @YangZ2020 测试确认)
 
 ## 开始上手
 
@@ -92,17 +92,35 @@ curl -sSLf https://142857.red/files/nvimrc-install.sh | bash
 **跳转**
 
 - `gd` 跳转到定义
+- `gD` 跳转到声明
 - `gy` 跳转到变量类型的定义
-- `gD` 跳转到虚函数实现
+- `gY` 跳转到虚函数实现
 - `go` 头文件和源文件来回跳转
 
 - `gr` 寻找符号引用
+- `gz` 罗列所有相关信息（定义、引用等）
 
 - `gf` 打开光标下的文件名
 - `gx` 打开光标下的网页链接
 
 - `<C-o>` 跳转回来
 
+**重构**
+
+- `gcc` 注释/取消注释当前选中的代码/行
+- `gn` 重命名变量
+- `gw` 尝试自动修复问题
+- `g=` 自动格式化当前代码
+- `<S-F4>` 格式化当前整个文件
+
+**预览**
+
+- `K` 悬浮窗查看文档
+- `gsf` 预览函数定义
+- `gsc` 预览类定义
+- `gsd` 查看所有语法错误
+- `<C-w>d` 查看当前光标下的语法错误
+
 **标签页**
 
 - `<F4>` 或 `:wa` 一键保存所有打开的文件
@@ -121,14 +139,6 @@ curl -sSLf https://142857.red/files/nvimrc-install.sh | bash
 
 - `g<Space>` 选择跳转到一个标签页
 
-**重构**
-
-- `gcc` 注释/取消注释当前选中的代码/行
-- `gn` 重命名变量
-- `gw` 尝试自动修复问题
-- `g=` 自动格式化当前代码
-- `<S-F4>` 格式化当前整个文件
-
 **文本查找**
 
 - `,,` 当前文件中模糊查找
@@ -155,12 +165,6 @@ curl -sSLf https://142857.red/files/nvimrc-install.sh | bash
 - `,;` 所有可用的 Vim 命令
 - `,?` 所有 Vim 帮助文档
 
-**预览**
-
-- `K` 悬浮窗查看文档
-- `gsf` 预览函数定义
-- `gsc` 预览类定义
-
 **选择**
 
 - `vac` 选中当前类
@@ -207,12 +211,14 @@ curl -sSLf https://142857.red/files/nvimrc-install.sh | bash
 
 **换位**
 
-- `gsh` 左移参数
-- `gsl` 右移参数
-- `gsj` 下移当前语句
-- `gsk` 上移当前语句
-- `gsf` 下移当前函数
-- `gsb` 上移当前函数
+- `mh` 左移参数
+- `ml` 右移参数
+- `mj` 下移当前语句
+- `mk` 上移当前语句
+- `maf` 下移当前函数
+- `mif` 上移当前函数
+- `mac` 下移当前类
+- `mic` 上移当前类
 
 **括号**
 
@@ -308,17 +314,19 @@ hello world
 
 这样是无需任何配置，所有 `CMakeLists.txt` 中配置的头文件都能找得到，语法高亮和代码提示就是正确的。
 
-* 如果你是 CMake 项目，但想要手动构建，那么请指定 `-DCMAKE_EXPORT_COMPILE_COMMANDS=ON` 参数：
+如果你想要手动命令行调用 `cmake`，那么也请指定 `-DCMAKE_EXPORT_COMPILE_COMMANDS=ON` 参数：
 
 ```bash
 cmake -B build -DCMAKE_EXPORT_COMPILE_COMMANDS=ON
 ```
 
 这会生成对 C++ 代码补全必不可少的 `build/compile_commands.json` 文件。
 
-否则本插件的语法高亮和代码提示插件将无法确定编译的参数，头文件的路径，可能无法正常工作（俗称“飙红线”）。
+否则，本插件的语法高亮和代码提示插件将无法确定头文件目录，语法检测可能无法正常工作（俗称“飙红线”）。
+
+> `:CMakeGenerate` 实际上就是默认自带了 `-DCMAKE_EXPORT_COMPILE_COMMANDS=ON` 这个参数，建议始终通过 `:CMakeGenerate` 和 `:CMakeBuild` 来构建项目。
 
-* 如果你用的是其他构建系统，可能需要自己在项目根目录下生成 `compile_commands.json` 文件。
+如果你用的是其他构建系统，可能需要自己在项目根目录下生成 `compile_commands.json` 文件。
 
 如需指定没有 `compile_commands.json` 时默认的 Clangd 选项（单文件编译的情况），编辑文件 [`~/.config/clangd/config.yaml`](dotfiles/.config-clangd-config.yaml)，内容为：
 

compile.sh

@@ -94,7 +94,11 @@ stat \"\$(which nvim)\" || true
 version=\"1\$(nvim --version | head -n1 | cut -f2 -dv | sed s/\\\\.//g)\"
 (nvim --version && [ \"\$version\" -ge 1$version_min ] ${version_max-" && [ \"\$version\" -le 1$version_max ]"}) || install_nvim
 nvim --version
-test -d ~/.config/nvim && mv ~/.config/nvim ~/.config/.nvim.backup.\$\$
+if [ -d ~/.config/nvim ]; then
+    echo \"-- Backup existing config to ~/.config/.nvim.backup.\$\$...\"
+    mv ~/.config/nvim ~/.config/.nvim.backup.\$\$
+fi
+echo '-- Copying to ~/.config/nvim...'
 mkdir -p ~/.config
 rm -rf ~/.config/nvim
 cp -r . ~/.config/nvim

key_details.md

@@ -52,10 +52,10 @@ vim.keymap.set("t", "kj", "<C-\\><C-n>", { silent = true })
 
 - `<F12>` / `:AerialToggle` 打开大纲
 - `<F10>` / `:Neogit` 打开 Git 面板
-- `<F9>` / `:TroubleToggle` 打开实时语法检查清单
+- `<F9>` / `:Trouble diagnostics toggle` 打开实时语法检查清单
 - `<F8>` / `:ToggleTerm` 打开内置终端
 - `<F7>` / `:NvimTreeToggle` 打开项目文件树
-- `<F6>` / `:copen` 打开编译器错误列表
+- `<F6>` / `:Trouble qflist toggle` 打开编译器错误列表
 - `<F5>` / `:TermExec cmd=./run.sh` 运行 `./run.sh`，这里面可以放你项目的构建和运行指令
 - `<S-F5>` / `:TermExec cmd=\<C-c>` 中断当前在终端中执行的程序（发送 Ctrl+C 的效果）
 
@@ -126,12 +126,14 @@ vim.keymap.set("t", "kj", "<C-\\><C-n>", { silent = true })
 我的一键安装脚本应该已经为你自动安装了 `clangd` 和 `pyright`，可以运行 `clangd --version` 来检查，如果没有 `clangd` 则无法在 C++ 文件中实现以下这些功能。
 
 - `gd` 跳转到当前光标下函数、变量、或类的定义。
+- `gD` 跳转到当前光标下函数、变量、或类的声明。
 
 如果光标悬浮在 `#include <cstdio>` 上使用 `gd`，则会打开并跳转到 `cstdio` 这个头文件中，对于 Python 的 `import package` 和 Lua 的 `require('package')` 也同样会跳转到模块对应的文件。
 
 - `gy` 跳转到当前光标下变量的类型的定义，与 `gd` 类似，但跳转到变量类型的定义，而不是变量本身的定义，例如 `std::vector<int> arr`，则光标悬停在 `arr` 上 `gy` 时，会跳转到其类型 `std::vector` 的定义。
 - `gr` 跳转到当前光标下函数、变量、或类的所有引用，也就是查找谁使用了当前这个函数或变量。会弹出一个列表，让你用 `j/k` 移动选择，按 `<CR>` 即可跳转到选中的那个引用所在的文件。
-- `gD` 跳转到当前光标下函数的所有实现，也就是查找当前虚函数的所有 override。如果有多个实现，则会弹出一个列表，让你用 `j/k` 移动选择，按 `<CR>` 即可跳转到选中的那个实现。
+- `gR` 跳转到当前光标下函数的所有实现，也就是查找当前虚函数的所有 override。如果有多个实现，则会弹出一个列表，让你用 `j/k` 移动选择，按 `<CR>` 即可跳转到选中的那个实现。
+- `gz` 查看所有（定义、引用、类型定义、声明）
 
 小贴士：使用 `gd` 跳转过去后，如果想要回来，只需要按 `<C-o>`（Ctrl+O）就能恢复到原来编辑的文件和位置，非常方便。
 
@@ -286,35 +288,43 @@ int main() {
 
 - `<Space>` 全屏任意移动
 
-#### 语法树换位 (nvim-treesitter)
+#### 定义预览 (LSP)
 
 语法树变换类的快捷键都以 `gs` 开头。
 
 - `gsc` 在小窗口中预览当前光标下类或变量的定义（但不跳转过去）
 - `gsf` 在小窗口中预览当前光标下函数的定义（但不跳转过去）
+- `gsd` 在弹出窗口中预览当前项目中的所有语法错误
+- `<C-w>d` 在小窗口中预览当前光标下存在的语法错误
+
+#### 语法树换位 (nvim-treesitter)
+
+语法树换位的快捷键都以 `m` 开头。
 
-- `gsh` 尝试左移当前的参数
-- `gsl` 尝试左移当前的参数
-- `gsj` 尝试下移当前的语句
-- `gsk` 尝试上移当前的语句
-- `gsf` 尝试下移当前的整个函数
-- `gsb` 尝试上移当前的整个函数
+- `mh` / `map` 尝试左移当前的参数
+- `ml` / `mip` 尝试左移当前的参数
+- `mj` / `mah` 尝试下移当前的语句
+- `mk` / `mih` 尝试上移当前的语句
+- `maf` 尝试下移当前的整个函数
+- `mif` 尝试上移当前的整个函数
+- `mac` 尝试下移当前的整个类
+- `mic` 尝试上移当前的整个类
 
 ```cpp
 func("hello", 42, Some());
 ```
 
-光标悬停在 `42` 上时按下 `gsl`，则得到：
+光标悬停在 `42` 上时按下 `ml`，则得到：
 
 ```cpp
 func(42, "hello", Some());
 ```
 
 用于快速调整参数的顺序，非常有用。
 
-当你看的不顺眼时，`gsf` 和 `gsb` 也可以用于调整多个函数之间的上下顺序。
+当你看的不顺眼时，`maf` 和 `mif` 也可以用于调整多个函数之间的上下顺序。
 
-所有这些都支持数字修饰，例如 `3gsb` 将当前函数向上移动三个函数的位置。
+所有这些都支持数字修饰，例如 `3mk` 将当前语句向上移动三格。
 
 #### 全局搜索功能 (telescope.nvim)
 

lua/archvim/config/nvim-treesitter.lua

@@ -95,14 +95,22 @@ require'nvim-treesitter.configs'.setup {
         swap = {
             enable = true,
             swap_next = {
-                ["gsl"] = "@parameter.inner",
-                ["gsj"] = "@statement.outer",
-                ["gsf"] = "@function.outer",
+                ["ml"] = "@parameter.inner",
+                ["mj"] = "@statement.outer",
+                ["mip"] = "@parameter.inner",
+                ["mib"] = "@block.outer",
+                ["mil"] = "@statement.outer",
+                ["mif"] = "@function.outer",
+                ["min"] = "@number.inner",
             },
             swap_previous = {
-                ["gsh"] = "@parameter.inner",
-                ["gsk"] = "@statement.outer",
-                ["gsb"] = "@function.outer",
+                ["mh"] = "@parameter.inner",
+                ["mk"] = "@statement.outer",
+                ["map"] = "@parameter.inner",
+                ["mab"] = "@block.outer",
+                ["mal"] = "@statement.outer",
+                ["maf"] = "@function.outer",
+                ["man"] = "@number.inner",
             },
         },
         move = {
@@ -121,7 +129,7 @@ require'nvim-treesitter.configs'.setup {
                 ["]t"] = "@comment.*",
                 ["]r"] = "@return.inner",
                 ["]l"] = "@statement.*",
-                ["]n"] = "@number.outer",
+                ["]n"] = "@number.*",
                 ["]h"] = "@assignment.outer",
             },
             goto_next_end = {
@@ -137,7 +145,7 @@ require'nvim-treesitter.configs'.setup {
                 ["]T"] = "@comment.*",
                 ["]R"] = "@return.inner",
                 ["]L"] = "@statement.*",
-                ["]N"] = "@number.outer",
+                ["]N"] = "@number.*",
                 ["]H"] = "@assignment.outer",
             },
             goto_previous_start = {
@@ -153,7 +161,7 @@ require'nvim-treesitter.configs'.setup {
                 ["[t"] = "@comment.*",
                 ["[r"] = "@return.inner",
                 ["[l"] = "@statement.*",
-                ["[n"] = "@number.outer",
+                ["[n"] = "@number.*",
                 ["[h"] = "@assignment.outer",
             },
             goto_previous_end = {
@@ -169,7 +177,7 @@ require'nvim-treesitter.configs'.setup {
                 ["[T"] = "@comment.*",
                 ["[R"] = "@return.inner",
                 ["[L"] = "@statement.*",
-                ["[N"] = "@number.outer",
+                ["[N"] = "@number.*",
                 ["[H"] = "@assignment.outer",
             },
             -- Below will go to either the start or the end, whichever is closer.

lua/archvim/config/telescope.lua

@@ -71,12 +71,3 @@ vim.keymap.set("n", "<leader>a", "<cmd>Telescope diagnostics<CR>")
 vim.keymap.set("n", "<leader>q", "<cmd>Telescope quickfix<CR>")
 -- 查看所有 Vim 通知
 vim.keymap.set("n", "<leader>n", "<cmd>Telescope notify<CR>")
-
--- 查找符号定义（LSP）
-vim.keymap.set("n", "gd", "<cmd>Telescope lsp_definitions<CR>")
--- 查找类型定义（LSP）
-vim.keymap.set("n", "gy", "<cmd>Telescope lsp_type_definitions<CR>")
--- 查找所有引用（LSP）
-vim.keymap.set("n", "gr", "<cmd>Telescope lsp_references<CR>")
--- 查找函数实现（LSP）
-vim.keymap.set("n", "gD", "<cmd>Telescope lsp_implementations<CR>")

lua/archvim/mappings.lua

@@ -105,9 +105,6 @@ vim.keymap.set({'v', 'n', 'i', 't'}, '<Ins>', [[<Cmd>ZenMode<CR>]])
 -- vim.keymap.set({"v", "n"}, "go", "<cmd>Ouroboros<CR>", { silent = true })
 -- vim.keymap.set({"v", "n"}, "gO", "<cmd>split | Ouroboros<CR>", { silent = true })
 -- vim.keymap.set({"v", "n"}, "g<C-o>", "<cmd>vsplit | Ouroboros<CR>", { silent = true })
-vim.keymap.set({"v", "n"}, "go", "<cmd>ClangdSwitchSourceHeader<CR>", { silent = true })
-vim.keymap.set({"v", "n"}, "gO", "<cmd>split | ClangdSwitchSourceHeader<CR>", { silent = true })
-vim.keymap.set({"v", "n"}, "g<C-o>", "<cmd>vsplit | ClangdSwitchSourceHeader<CR>", { silent = true })
 -- vim.keymap.set({"v", "n", "i"}, "<F10>", "<cmd>Neoformat<CR>", { silent = true })
 -- vim.keymap.set("n", "Q", "<cmd>wa<CR><cmd>qa!<CR>", { silent = true })
 
@@ -151,35 +148,57 @@ vim.keymap.set('t', '<Esc>', [[<C-\><C-n>]], { noremap = true })
 -- vim.keymap.set('t', [[<Esc>]], [[<Esc>]], { noremap = true })
 -- vim.keymap.set('t', [[jk]], [[<C-\><C-n>]], opts)
 
-vim.keymap.set({'v', 'n'}, '<F16>', function ()
+-- 格式化代码
+vim.keymap.set({'v'}, 'g=', [[<Cmd>Neoformat<CR>]])
+vim.keymap.set({'n'}, 'g=', function ()
     vim.lsp.buf.format()
 end)
-
+vim.keymap.set({'v', 'n', 'i'}, '<F16>', function()
+    vim.lsp.buf.format()
+end)
+-- 查看文档
 vim.keymap.set({'v', 'n'}, 'K', function ()
     vim.lsp.buf.hover()
 end)
-
+-- 函数签名
 vim.keymap.set({'v', 'n'}, 'gK', function ()
     vim.lsp.buf.signature_help()
 end)
-
+-- 代码修复
 vim.keymap.set({'v', 'n'}, 'gw', function ()
     vim.lsp.buf.code_action({
-        -- context = {
-        --     only = {
-        --         "source",
-        --     },
-        --     diagnostics = {},
-        -- },
         apply = true,
     })
 end)
+-- 重命名变量
 vim.keymap.set({'v', 'n'}, 'gn', function()
   return ":IncRename " .. vim.fn.expand("<cword>")
 end, { expr = true })
 vim.keymap.set({'v', 'n'}, 'gN', function()
   return ":IncRename "
 end, { expr = true })
+-- 查找符号定义
+vim.keymap.set("n", "gd", "<cmd>Telescope lsp_definitions<CR>")
+-- 查找符号声明
+vim.keymap.set("n", "gD", function()
+    vim.lsp.buf.declaration()
+end)
+vim.keymap.set("n", "gsd", "<cmd>Trouble diagnostics toggle<CR>")
+-- 查找类型定义
+vim.keymap.set("n", "gy", "<cmd>Telescope lsp_type_definitions<CR>")
+-- 查找所有引用
+vim.keymap.set("n", "gr", "<cmd>Telescope lsp_references<CR>")
+-- 查找函数实现
+vim.keymap.set("n", "gY", "<cmd>Telescope lsp_implementations<CR>")
+-- 查看全部
+vim.keymap.set("n", "gz", "<cmd>Trouble lsp toggle<CR>")
+-- 头文件/源文件跳转
+vim.keymap.set({"v", "n"}, "go", "<cmd>ClangdSwitchSourceHeader<CR>", { silent = true })
+vim.keymap.set({"v", "n"}, "gO", "<cmd>split | ClangdSwitchSourceHeader<CR>", { silent = true })
+vim.keymap.set({"v", "n"}, "g<C-o>", "<cmd>vsplit | ClangdSwitchSourceHeader<CR>", { silent = true })
+
+
+
 vim.keymap.set({'n'}, '<S-Tab>', '<C-o>')
 vim.keymap.set({'i'}, '<C-Space>', '<Space>')