从零开始配置vim(25)——关于 c++ python 的配置

Posted 2022-10-10 aluluka

从9月份到国庆这段时间，因为得了女儿，于是回老家帮忙料理家事以及陪伴老婆和女儿。一时之间无暇顾及该系列教程的更新。等我回来的时候发现很多小伙伴私信我催更。在这里向支持本人这一拙劣教程的各位小伙伴表示真诚的感谢。言归正传，让我们开始吧

之前我们根据lua语言配置了基于lsp的代码高亮、自动跳转、自动补全等等功能，那个时候我们安装了很多插件，像 nvim-lspconfig、nvim-lsp-installernvim-cmp等等，每个插件都在干嘛，虽然我们配置好了 lua相关的内容，但是可能仍然有小伙伴有疑问，碰到其他语言该如何配置，是不是要重新下载对应的插件呢？为了解答这些问题，这篇文章我们将要来根据 c++和 python的日常习惯来进行配置，给大家演示一下在上述内容都配置完成之后面对其他语言我们该如何进行处理

安装配置 c++ 相关的lsp服务

关于c++ 的服务，我们根据 nvim-lsp-installer 官方给出的表格中显示它可以使用 ccls 和 clang，这里我们以 ccls 作为示例进行讲解。

首先通过命令安装 :LspInstall ccls

接着我们新建一个 ftplugin/c.lua 和 ftplugin/cpp.lua 来配置 c/c++ 。不过他们两个采用相同的配置，我们暂时将一份配置复制两遍

require("lsp/cpp")

他们的作用只有一个，那就是加载 lsp/cpp 这个文件，我们将他们的配置放到一个文件中

然后我们再在 lua/lsp/cpp.lua 文件中加入以下内容用于启动 lsp服务端

local lspconfig = require('lspconfig')
lspconfig.ccls.setup 
  init_options = 
    cache = 
      directory = ".ccls-cache";
    ;
  

我们进入一个 .c/.cpp 文件发现已经加载了 ccls 了。如果没有加载可以使用 :LspStart 命令手工加载或者使用 LspInfo 查看是否有问题

现在我们已经可以看到lsp服务给出的提示了

修改之前的配置

我们在第22篇文章中给出了基于 lsp 的 lua 的配置，主要是使用 lsp 服务端的配置和对应的跳转之类的快捷键配置，我们将它放到了 lsp/lua.lua 目录下了。但是一想想我们使用 c++、Python 或者其他什么语言的时候，这些快捷键应该是不会修改的，这个时候自然就想到了要重用快捷键了。所以来配置之前的第一件事就是想办法重用这些快捷键。

这个时候我们想到的办法就是将之前定义的快捷键封装成函数，然后在 on_attach 的回调函数中调用该函数。我们将那些快捷键定义放到 lua/keybindings.lua 中

local lsp_keybinds = 
lsp_keybinds.set_keymap = function (bufnr)
    -- 跳转到声明
    vim.api.nvim_buf_set_keymap(bufnr, "n", "gd", "<cmd>lua vim.lsp.buf.declaration()<CR>", silent = true, noremap = true)
    -- 跳转到定义
    vim.api.nvim_buf_set_keymap(bufnr, "n", "gD", "<cmd>lua vim.lsp.buf.definition()<CR>", silent = true, noremap = true)
    -- 显示注释文档
    vim.api.nvim_buf_set_keymap(bufnr, "n", "gh", "<cmd>lua vim.lsp.buf.hover()<CR>", silent = true, noremap = true)
    -- 跳转到实现
    vim.api.nvim_buf_set_keymap(bufnr, "n", "gi", "<cmd>lua vim.lsp.buf.implementation()<CR>", silent = true, noremap = true)
    -- 跳转到引用位置
    vim.api.nvim_buf_set_keymap(bufnr, "n", "gr", "<cmd>lua vim.lsp.buf.references()<CR>", silent = true, noremap = true)
    -- 以浮窗形式显示错误
    vim.api.nvim_buf_set_keymap(bufnr, "n", "go", "<cmd>lua vim.diagnostic.open_float()<CR>", silent = true, noremap = true)
    vim.api.nvim_buf_set_keymap(bufnr, "n", "gp", "<cmd>lua vim.diagnostic.goto_prev()<CR>", silent = true, noremap = true)
    vim.api.nvim_buf_set_keymap(bufnr, "n", "gn", "<cmd>lua vim.diagnostic.goto_next()<CR>", silent = true, noremap = true)
end
return lsp_keybinds

我们将它打包到lsp_keybinds 模块中作为 keybinds.lua 文件的导出模块。然后在 lsp/lua.lua文件的 on_attach 函数中调用这个函数完成快捷键的配置工作

local lsp_set_keymap = require("keybindings")                     
local on_attach = function(_, bufnr)
    lsp_set_keymap.set_keymap(bufnr)
end

现在我们就完成了 c/c++ 相关的配置

尝试一下绑定的那些快捷键，发现它可以正常进行跳转

是不是很简单了，我们没有安装任何的插件，只是安装了 c++ lsp 的服务端。剩下的配置依然延续之前的就好了

python 相关配置

我们再来以 python 的配置作为例子来讲lsp的配置。python 的服务端我们采用 pyright 。还有一个方法可以安装 lsp 服务。我们可以在命令模式中输入 :LspInstallInfo 查看当前已安装的 lsp 服务。下面会列出一堆的未安装的 lsp 服务。这个时候我们可以将光标移动到某个服务上，按下 i 来安装该服务。

这里我提前已经安装好了，所以它显示在 Installed Server 中，没有安装它应该显示在下方的Available Server 列表中。

安装完成之后我们还是按照惯例，在 ftplugin 目录下建立一个 python.lua 文件并且在该文件中加载 lua/lsp/python.lua 文件

我们在 lua/lsp/python.lua 文件中加入下面的代码

local lsp_set_keymap = require("keybindings")
local util = require 'lspconfig/util'

require('lspconfig').pyright.setup
    on_attach = function(_, bufnr)
        lsp_set_keymap.set_keymap(bufnr)
    end,
    cmd =  "pyright-langserver", "--stdio" ,
    filetypes =  "python" ,
    settings = 
        python = 
            analysis = 
                autoSearchPaths = true,
                diagnosticMode = "workspace",
                useLibraryCodeForTypes = true,
                typeCheckingMode = "off"
            ,
        ,
    ,
    root_dir = function(fname)
        local root_files = 
            'pyproject.toml',
            'setup.py',
            'setup.cfg',
            'requirements.txt',
            'Pipfile',
            'pyrightconfig.json',
        
        return util.root_pattern(unpack(root_files))(fname) or util.find_git_ancestor(fname) or util.path.dirname(fname)
    end,

前面的配置与 c++ 的配置类似。主要设置快捷键，这里需要注意的是 root_dir 这里的配置，想要在对应缓冲中启动相应的 lsp 服务，需要buffer处在对应语言的项目中，root_dir 规定在 buffer 所在目录中存在这些文件或者目录时将该目录作为对应项目文件

如果我们不加该配置，可能会导致lsp 服务启动失败。如果失败的话我们使用 :LspInfo 来查看失败原因

这个根目录设置是可以作用于它下面所有子目录的。这里我根据 python 中常用文件给出了一个列表，各位小伙伴可以根据自己的需求自行添加
另外需要注意的一个问题时，pyright 依赖于 node 的 work_threads 模块，该模块从12版本以后才被支持，如果小伙伴的 node 版本低于该版本需要考虑升级 node

根据这两个例子，相信各位已经熟悉了该如何配置不同语言的 lsp 服务了。这里面没有什么深奥的代码，也没有什么个性化到只有自己才会用的配置，希望能起到抛砖引玉的作用，后面再碰到什么其他语言小伙伴们应该可以很容易的添加它的lsp服务了。