从零开始配置vim(22)——lsp简介与treesitter 配置

截止到上一篇文章，我们配置了neovim的很多内容了。具备了一些编辑器的常用功能了，而且可以胜任日常的文档编辑工作了。但是想作为一个可靠的代码编辑器还缺少重要的一环，即代码语法部分的支持。

在过去的vim配置中，我们基于 you-complete-me这个插件配置。但是对于不懂c语言甚至vim的小白来说简直是灾难。各种兼容问题、报错频出，而且效果也远不如 visual studio code等编辑器。也有可能是我那个时候比较菜，当初针对 python配置的补全效果很一般只能补全内置函数，自己定义的类和方法无法补全，而且跳转时好时坏。后来我抛弃了vim很长一段时间。好在微软提供了lsp这个大杀器，让vim、emacs这类编辑器的代码编辑体验提升了很大一截。而且配置还相对简单。

lsp 简介

过去的编辑器包揽了诸如代码高亮、语法分析、跳转等功能，这样就导致了所有编辑器都有自己专有的一套显示、跳转等方案。而第三方编辑器想要达到完全相同的效果几乎是不可能的。但是微软提出的 lsp（language server protocol） 确改变了这一格局。

lsp最重要的就是将语法分析、跳转、自动补全功能这些语言的核心功能和最终呈现效果分开。即server端主要提供了语法分析、补全、跳转的核心功能，而在客户端要做的就是调用服务端提供的这些功能来展示以及通过快捷键或者其他用户接口以便用户使用。而且语言服务器是以进程的方式单独运行，并不会影响客户端的运行。它们之间通过本地网络的形式进行信息交换

lsp-flow-diagram.png

• 用户在工具中打开一个的文件, 该工具通知语言服务器文档打开 ('textDocument/didOpen') 。 从现在起，有关文档内容不再位于文件系统上，而是保存在编辑器开辟的一块内容中
• 用户进行编辑：该工具通知服务器文档更改 ('textDocument/didChange') ，程序语义信息由语言服务器更新。 发生这种情况时，语言服务器会分析此信息，并通知工具 ('textDocument/publishDiagnostics') 检测到的错误和警告，并且还可能返回一些可能的用于补全的内容
• 用户对编辑器中的符号执行“转到定义”：该工具发送具有两个参数的“textDocument/definition”请求： (1) 文档 URI， (2) 从服务器启动 Go to Definition 请求的文本位置。 服务器使用文档 URI 和符号定义在文档中的位置进行响应。客户端接到返回后，根据服务器标记的位置进行跳转
• 用户关闭文档 (文件) ：工具发送“textDocument/didClose”通知，通知语言服务器文档现在不再处于内存中，并且将当前内容保存到文件系统中。

treesitter 配置

我们简单介绍过 neovim-treesitter 这个插件，它可以用来做代码高亮。它采用 lsp 协议实现，比起单纯使用正则表达式来说，它具有更好的渲染效果。那么我们体验 lsp 效果的第一步就来配置它吧。

treesitter 想要工作，需要根据语言下载配套语言对应的语法解析模块，我们可以使用 :TSInstallInfo 来查看当前我们安装了哪些解析模块。

我们发现并没有安装任何的模块，基于当前配置文件的工程，我们先来体验一下 lua 的效果。

我们使用 :TSInstall 的命令可以下载指定语言的模块。这里我们使用 :TSInstall lua 来下载lua模块。后续我们可以使用 :TSUpdate lua 来更新该模块。跟 packer 类似的 :TSUpdate 即可以用来下载也可以用来更新。也就是一条命令就搞定了

安装完成之后我们可以使用 :TSBufToggle highlight 来使用 treesitter 进行高亮

2.gif

如果我们每次都需要手工调用命令来进行高亮的话，就太不智能了。我们可以在配置文件中配置它自动加载语法高亮。

require('nvim-treesitter.configs').setup({                                               
    -- 支持的语言
    ensure_installed = {"html", "css", "vim", "lua", "javascript", "typescript", "c", "cpp", "python"},
    -- 启用代码高亮
    highlight = {
        enable = true,
        additional_vim_regex_highlighting = false
    },
    --启用增量选择
    incremental_selection = {
        enable = true,
        keymaps = {
            init_selection = '',
            node_incremental = '',
            node_decremental = '',
            scope_incremental = ''
        }
    },
    -- 启用基于 Treesitter 的代码格式化(=)
    indent = {
        enable = true
    },
})
-- 开启代码折叠
vim.wo.foldmethod = 'expr'
vim.wo.foldexpr = 'nvim_treesitter#foldexpr()'
-- 默认不折叠
vim.wo.foldlevel = 99

我们来一条条的解释这些配置
ensure_installed 表示需要支持哪些语言，如果里面设置了某些语言，那么在启动之后它会自动调用 :TSUpdate 来下载和更新对应语言的 server 部分。

等它下载完了对应的语言模块之后，我们发现它已经很好的完成了代码着色的功能。

增量选择可以一次选择一块的代码，依次扩大或者缩小所选择的语言块，我们使用回车来开始和扩大增量选择，使用退格键来减少增量选择代码块。各位小伙伴可以根据自己的习惯来定义快捷键

3.gif

另外我们可以使用 = 来格式化代码。为了方便我们定义自动命令，每当执行 :w 写入前前自动格式化代码

local auto_indent = vim.api.nvim_create_augroup("AUTO_INDENT", {clear = true})
vim.api.nvim_create_autocmd({"BufWritePost"}, {
    pattern = "*",
    group = auto_indent,
    command = 'normal! gg=G``'
})

这里因为提前使用了 gg改变了光标位置，在格式化之后使用 `` 来回到上次跳转之前的位置。

4.gif

最后我们可以使用 zc 和 zo 来折叠和展开代码。不过我自己很少用，需要查看文件中的符号例如函数、变量等我可以使用其他插件来解决，如果要成块的跳转代码我比较喜欢使用 %。

5.gif

好了，到此为止我们先体验了一下基于 lsp 实现的 treesitter 的功能，后面将展开讲述 lsp 对一些语言的支持，敬请期待