使用lsp-zero.nvim从零配置Neovim的LSP支持教程-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00062/article/details/148549886

使用lsp-zero.nvim从零配置Neovim的LSP支持教程

lsp-zero.nvim A starting point to setup some lsp related features in neovim. 项目地址: https://gitcode.com/gh_mirrors/ls/lsp-zero.nvim

前言

对于现代代码编辑器而言，语言服务器协议(LSP)支持已成为提升开发效率的关键功能。本文将详细介绍如何使用lsp-zero.nvim插件为Neovim配置完整的LSP支持环境，从基础配置到高级功能一应俱全。

环境准备

在开始前，请确保满足以下条件：

熟悉Neovim基本操作：了解普通模式、插入模式和命令模式的切换
已安装Neovim v0.10或更高版本
系统已安装git工具

初始化配置

创建配置文件

Neovim的配置文件init.lua位置因操作系统而异，可通过以下命令查询：

nvim --headless -c 'echo stdpath("config")' -c 'echo ""' -c 'quit'

创建该目录并新建init.lua文件。之后可通过命令快速访问配置文件：

nvim -c 'edit $MYVIMRC'

验证配置加载

添加以下代码测试配置是否生效：

if vim.fn.has('nvim-0.10') == 1 then
  vim.cmd('colorscheme morning')
else
  vim.cmd('colorscheme blue')
end

保存后重启Neovim，若显示浅色主题则版本符合要求。验证后可替换为更美观的暗色主题：

vim.cmd('colorscheme habamax')

插件管理配置

虽然Neovim可以不使用插件管理器，但使用lazy.nvim能极大简化插件管理流程。

安装lazy.nvim

添加以下代码实现自动安装：

local lazypath = vim.fn.stdpath('data') .. '/lazy/lazy.nvim'

if not vim.uv.fs_stat(lazypath) then
  print('正在安装lazy.nvim...')
  vim.fn.system({
    'git',
    'clone',
    '--filter=blob:none',
    'https://github.com/folke/lazy.nvim.git',
    '--branch=stable',
    lazypath,
  })
  print('安装完成。')
end

vim.opt.rtp:prepend(lazypath)

基本使用

初始化插件管理器：

require('lazy').setup({
  -- 插件列表将放在这里
})

添加首个插件

以tokyonight.nvim主题插件为例：

在setup中添加插件：

require('lazy').setup({
  {'folke/tokyonight.nvim'},
})

删除旧的主题设置
在文件末尾添加：

vim.opt.termguicolors = true
vim.cmd.colorscheme('tokyonight')

保存并重启Neovim

首次启动时会自动安装插件管理器及配置的插件。

LSP核心配置

添加必要插件

require('lazy').setup({
  {'folke/tokyonight.nvim'},
  {'neovim/nvim-lspconfig'},
  {'hrsh7th/cmp-nvim-lsp'},
  {'hrsh7th/nvim-cmp'},
})

基础LSP设置

-- 保留侧边栏空间
vim.opt.signcolumn = 'yes'

-- 配置LSP能力
local lspconfig_defaults = require('lspconfig').util.default_config
lspconfig_defaults.capabilities = vim.tbl_deep_extend(
  'force',
  lspconfig_defaults.capabilities,
  require('cmp_nvim_lsp').default_capabilities()
)

-- LSP快捷键绑定
vim.api.nvim_create_autocmd('LspAttach', {
  desc = 'LSP操作',
  callback = function(event)
    local opts = {buffer = event.buf}

    vim.keymap.set('n', 'K', '<cmd>lua vim.lsp.buf.hover()<cr>', opts)
    vim.keymap.set('n', 'gd', '<cmd>lua vim.lsp.buf.definition()<cr>', opts)
    -- 更多快捷键...
  end,
})

语言服务器配置

手动安装方式

按语言服务器文档安装所需LSP
在配置中启用：

require('lspconfig').gopls.setup({})
require('lspconfig').rust_analyzer.setup({})

使用mason.nvim管理

添加额外插件：

require('lazy').setup({
  {'folke/tokyonight.nvim'},
  {'williamboman/mason.nvim'},
  {'williamboman/mason-lspconfig.nvim'},
  {'neovim/nvim-lspconfig'},
  {'hrsh7th/cmp-nvim-lsp'},
  {'hrsh7th/nvim-cmp'},
})

配置自动安装：

require('mason').setup({})
require('mason-lspconfig').setup({
  handlers = {
    function(server_name)
      require('lspconfig')[server_name].setup({})
    end,
  },
})

使用:LspInstall命令安装语言服务器。

Lua语言服务器特殊配置

创建.luarc.json文件解决全局变量警告：

{
  "runtime.version": "LuaJIT",
  "diagnostics.globals": ["vim"],
  "workspace.library": ["$VIMRUNTIME"]
}

自动补全配置

配置nvim-cmp实现代码补全：

local cmp = require('cmp')

cmp.setup({
  sources = {
    {name = 'nvim_lsp'},
  },
  mapping = cmp.mapping.preset.insert({
    ['<C-p>'] = cmp.mapping.select_prev_item(),
    ['<C-n>'] = cmp.mapping.select_next_item(),
    ['<CR>'] = cmp.mapping.confirm({select = false}),
    ['<C-Space>'] = cmp.mapping.complete(),
  }),
  snippet = {
    expand = function(args)
      vim.snippet.expand(args.body)
    end,
  },
})

完整配置示例

提供两种完整配置方案：手动管理语言服务器和使用mason自动管理。

手动管理方案

-- [前面配置代码...]

-- 语言服务器示例
require('lspconfig').gopls.setup({})
require('lspconfig').rust_analyzer.setup({})

-- [自动补全配置...]

自动管理方案

-- [前面配置代码...]

require('mason').setup({})
require('mason-lspconfig').setup({
  handlers = {
    function(server_name)
      require('lspconfig')[server_name].setup({})
    end,
  },
})

-- [自动补全配置...]