Neovim，要尝一口不？

扣尘

Neovim 风评很好，我机器上其实早装了它来替代 vim。只不过这两年用 vscode 较多，冷落了它，除了偶尔改改配置文件，很少用。难得大过年的有点儿空，就来倒腾它一下子，最终效果如下。

基础配置

从 0.5 版开始，Neovim 允许使用 Lua 代替 VimL 作为配置语言，所以这里也直接从 init.lua 开始了。

1. mkdir -p ~/.config/nvim
2. touch ~/.config/nvim/init.lua

复制代码

打开此文件，开始配置。

1. nvim ~/.config/nvim/init.lua

复制代码

先设置一下缩进，默认是 8 个字符，改为 4 个字符且按 tab 键自动补空格：

1. vim.g.shiftround = true
2. vim.bo.expandtab = true
3. vim.bo.shiftwidth = 4
4. vim.bo.softtabstop = 4
5. vim.bo.tabstop = 4

复制代码

再来显示下行号及右边界警示线。右边界一般建议为 80，即代码超过 80 个字符应该注意换行。对现在的屏幕分辨率来说，80 其实有些窄，可以设为 120。

1. vim.wo.number = true
2. vim.wo.colorcolumn = "120"

复制代码

neovim 默认打开了不少之前在 vim 中需要单独设置的选项，比如说自动缩进、文件类型检测、语法高亮等等。有了上面这几行，基础的配置差不多就够了，其它的安装插件后再调整。
插件管理

选用 lazy，与 packer 相比，它不需要编译、更快、界面也好看些，还有其它优点，不罗列了。总之，就是它了。

1. local lazypath = vim.fn.stdpath("data") .. "/lazy/lazy.nvim"
2. if not vim.loop.fs_stat(lazypath) then
3.   vim.fn.system({
4.     "git",
5.     "clone",
6.     "--filter=blob:none",
7.     "git@github.com:folke/lazy.nvim.git",
8.     "--branch=stable",
9.     lazypath,
10.   })
11. end
12. vim.opt.rtp:prepend(lazypath)

复制代码

注意与官方文档相比，我把 clone 地址由 https://github.com/folke/lazy.nvim.git 改为了 git@github.com:folke/lazy.nvim.git，原因你知道的，国内访问 Github 网址抽风，改用后者要好一些。
接着就是让 lazy 起作用了，加入如下配置：

1. require("lazy").setup({
2.         -- 插件写这里
3. }, {
4.     git = {
5.         url_format = "git@github.com:%s"
6.     }
7. })

复制代码

以上同样加了些针对 git 下载路径的自定义设置，原因同上。
需要特别说明的是，为了节省篇幅，后续凡是提到安装插件的，相关代码都是追加到如下注释的地方：

1. -- 以上省略
2. require("lazy").setup({
3.         -- 插件相关配置在这里追加
4. }, {
5. -- 以下省略

复制代码

然后输入如下命令就可以打开安装界面进行安装了：

1. :Lazy

复制代码

配色方案

配色方案也是插件，可选的太多了，我使用 Nightfox。它本身又包含了多套方案，如下用的是 nordfox：

1.     {
2.         "EdenEast/nightfox.nvim",
3.         lazy = false,
4.         priority = 1000,
5.         config = function()
6.             vim.cmd([[colorscheme nordfox]])
7.         end,
8.     },

复制代码

安装之后，界面长这样：

还是很好看的。
字体与图标

首先打开 NERD FONTS，找一款你喜欢的编程字体装进系统里，然后设置你的终端使用该字体。接下来安装插件 nvim-web-devicons：

1.     "nvim-tree/nvim-web-devicons",

复制代码

以上操作目的是为了给 neovim 提供图标支撑，目前暂时看不到变化，算是为后续做些准备工作。
状态栏

选用 lualine 插件：

1.     {
2.         "nvim-lualine/lualine.nvim",
3.         opts = {
4.             options = {
5.                 section_separators = '',
6.                 component_separators = ''
7.             }
8.         }
9.     },

复制代码

其实可以只保留如下一行，显示效果可能还好一些。我个人偏爱简洁样式，用上述选项是为了去掉分隔符。

1.     "nvim-lualine/lualine.nvim",

复制代码

文件管理

选 nvim-tree，用的人多，比较活跃。

1.     {
2.         "nvim-tree/nvim-tree.lua",
3.         config = function()
4.             vim.g.loaded_netrw = 1
5.             vim.g.loaded_netrwPlugin = 1
6.             vim.g.termguicolors = true
8.             require("nvim-tree").setup({
9.                 sort_by = "case_sensitive",
10.             })
11.         end,
12.     },

复制代码

安装后，输入命令：

1. :NvimTreeToggle

复制代码

就会打开文件树，如下图：

但是每次输入命令打开关闭文件树不太爽，用快捷键就好多了。
快捷键

先定义一下全局的快捷起始键，通常用空格或逗号，如下定义为逗号：

1. vim.g.mapleader = ","

复制代码

如下定义 ,+空格 取消搜索高亮：

1. vim.keymap.set("n", "<leader><space>", "<cmd>nohlsearch<cr>", { silent = true })

复制代码

快捷键用熟了很好，刚定义时容易忘。想要提示的话，可以用 which-key 插件来定义快捷键。

1.     {
2.         "folke/which-key.nvim",
3.         config = function()
4.             vim.o.timeout = true
5.             vim.o.timeoutlen = 300
7.             local wk = require("which-key")
8.             -- 快捷键在这里定义
9.             wk.setup()
10.         end,
11.     },

复制代码

注意其中的注释，后续对快捷键定义如无特殊说明，都写在上述注释所在的位置。
现在可以试一下了，按下 Ctrl-W 组合键，效果如下：

Amazing，比较带劲是不是？
接下来注册自己想要的快捷键，比如：

1.             wk.register({
2.                 ["<space>"] = { "<cmd>nohlsearch<cr>", "取消搜索高亮" },
3.                 ["d"] = { "<cmd>NvimTreeToggle<cr>", "显示/隐藏目录树" },
4.             }, { prefix = "<leader>" })

复制代码

这样就可以用 ,+d 来切换目录树的显示了。顺便的，当使用 / 或 ? 搜索时，匹配项会高亮显示，现在可以使用 ,+空格 来取消高亮了。如果按下 , 键，则会弹出以上快捷键的说明。相当不错！
多文档

vim/neovim 有两种模式支持多文档编辑：标签页或缓冲区。这里选择使用缓冲区，bufferline 插件可以展示多个缓冲区的文档标签：

1.     {
2.         "akinsho/bufferline.nvim",
3.         tag = "v3.*",
4.         config = function()
5.             vim.g.termguicolors = true
7.             require("bufferline").setup()
8.         end,
9.     },

复制代码

试下效果吧。用 ,+d 打开目录树，按 j 或 k 选中个文件，再按 o 或直接回车就打开了，注意上方多出来的标签页。

试试用鼠标点击标签页以及其中的关闭按纽，功能正是你想要的，对吧？不过在 vim 中用鼠标似乎有些 low，用命令 :bn、:bp 算是正常途径。也可以定义快捷键，如下：

1.             vim.keymap.set("n", "<leader>bp", "<cmd>BufferLineCyclePrev<cr>", { silent = true })
2.             vim.keymap.set("n", "<leader>bn", "<cmd>BufferLineCycleNext<cr>", { silent = true })
3.             vim.keymap.set("n", "<leader>bd", "<cmd>bd<cr>", { silent = true })

复制代码

配置到现在，乍一看很象回事了。但是用来写代码的话，还不太够，所以继续。
参考线及特殊字符

先加两行全局配置，以区分空格与制表符、以及折行与回车换行:

1. vim.o.listchars = "eol:↵,lead:‧"
2. vim.wo.list = true

复制代码

然后装个 indent-blankline 插件：

1.     {
2.             "lukas-reineke/indent-blankline.nvim",
3.     },

复制代码

代码片断

使用插件 luasnip，与自动完成的集成稍后再说。

1.     {
2.         "L3MON4D3/LuaSnip",
3.         version = "^1.1.0",
4.         dependencies = {
5.             "rafamadriz/friendly-snippets",
6.         },
7.         config = function()
8.             require("luasnip.loaders.from_vscode").lazy_load()
9.         end,
10.     },

复制代码

自动完成

从这里开始，进入稍微复杂的配置部分。先来弄自动完成。自动完成的原材料可以来源于当前文档关键字、可以来源于代码片断，当然我们更希望它来源于我们的编程上下文语义，即 LSP 集成。如下是相关插件配置。

1.     {
2.         "hrsh7th/nvim-cmp",
3.         dependencies = {
4.             "hrsh7th/cmp-buffer",
5.             "hrsh7th/cmp-path",
6.             "hrsh7th/cmp-nvim-lsp",
7.             "L3MON4D3/LuaSnip",
8.             "saadparwaiz1/cmp_luasnip",
9.         },
10.         config = function()
11.             local cmp = require("cmp")
13.             cmp.setup({
14.                 snippet = {
15.                     expand = function(args)
16.                         require("luasnip").lsp_expand(args.body)
17.                     end,
18.                 },
19.                 mapping = cmp.mapping.preset.insert({
20.                     ['<C-b>'] = cmp.mapping.scroll_docs(-4),
21.                     ['<C-f>'] = cmp.mapping.scroll_docs(4),
22.                     ['<C-Space>'] = cmp.mapping.complete(),
23.                     ['<C-e>'] = cmp.mapping.abort(),
24.                     ['<CR>'] = cmp.mapping.confirm({ select = true }),
25.                 }),
26.                 sources = cmp.config.sources({
27.                     { name = 'nvim_lsp' },
28.                     { name = 'luasnip' },
29.                 }, {
30.                     { name = 'buffer' },
31.                     { name = "path" },
32.                 }),
33.             })
34.         end,
35.     },

复制代码

看起来比较复杂，对吧？简单解释一下：

• 自动完成使用了 nvim-cmp 插件；
  
• 提示内容可以来源于当前文档、路径、代码片断及上下文语义；
  
• 定义了几个快捷键；
  

上下文语义（LSP）

可能是最复杂的部分，配置如下：

1.     {
2.         "neovim/nvim-lspconfig",
3.         dependencies = {
4.             "williamboman/mason.nvim",
5.             "williamboman/mason-lspconfig.nvim",
6.             "hrsh7th/cmp-nvim-lsp",
7.         },
8.         config = function()
9.             require("mason-lspconfig").setup({
10.                 ensure_installed = {
11.                     "bashls",
12.                     "clangd",
13.                     "denols",
14.                     "pyright",
15.                     "rust_analyzer",
16.                 },
17.             })
19.             local capabilities = require('cmp_nvim_lsp').default_capabilities()
21.             local lspcfg = require("lspconfig")
22.             lspcfg.bashls.setup({
23.                 capabilities = capabilities,
24.                 on_attach = on_attach
25.             })
26.             lspcfg.clangd.setup({
27.                 capabilities = capabilities,
28.                 on_attach = on_attach
29.             })
30.             lspcfg.denols.setup({
31.                 capabilities = capabilities,
32.                 on_attach = on_attach
33.             })
34.             lspcfg.pyright.setup({
35.                 capabilities = capabilities,
36.                 on_attach = on_attach
37.             })
38.             lspcfg.rust_analyzer.setup({
39.                 capabilities = capabilities,
40.                 on_attach = on_attach
41.             })
42.         end,
43.     },

复制代码

仍然是最简单的解释一下：

• 使用了 nvim-lspconfig 插件来做 LSP 的配置；
  
• 不同的编程语言要安装不同的语言服务，使用 mason 来统一管理这些语言服务组件；
  
• 自动安装 bash、c/c++、js/ts、python、rust 语言服务；
  
• 集成上述编程语言的语义化自动完成功能；
  

其中有个 on_attach 在给出的配置代码中暂未给出，是因为这是个公用函数，下文的代码格式化也会用到，所以稍后再描述。
格式化及诊断

这两项内容均使用 null-ls 插件实现，配置如下：

1.     {
2.         "jose-elias-alvarez/null-ls.nvim",
3.         dependencies = {
4.             "nvim-lua/plenary.nvim",
5.         },
6.         config = function()
7.             local nl = require("null-ls")
8.             local sources = {
9.                 nl.builtins.diagnostics.eslint_d,
10.                 nl.builtins.diagnostics.ruff,
11.                 nl.builtins.formatting.beautysh,
12.                 nl.builtins.formatting.black,
13.                 nl.builtins.formatting.clang_format,
14.                 nl.builtins.formatting.prettierd,
15.                 nl.builtins.formatting.rustfmt,
16.                 nl.builtins.formatting.sql_formatter,
17.             }
18.             nl.setup({
19.                 sources = sources,
20.                 on_attach = on_attach,
21.             })
22.         end,
23.     },

复制代码

很明显，诊断与格式化也都与编程语言相关，同样依赖一些第三方组件。尽管上述配置没用明确给出，也可以通过 mason 管理，之前已经安装过些插件。输入 :Mason 即可打开其界面如下：

可以看到我已经安装了 LSP 及格式化与诊断相关的几个组件。
是时候说一下 on_attach 了，其代码如下：

1. local on_attach = function(client, bufnr)
2.     vim.api.nvim_buf_set_option(bufnr, 'omnifunc', 'v:lua.vim.lsp.omnifunc')
4.     local bufopts = { noremap=true, silent=true, buffer=bufnr }
5.     vim.keymap.set('n', 'gD', vim.lsp.buf.declaration, bufopts)
6.     vim.keymap.set('n', 'gd', vim.lsp.buf.definition, bufopts)
7.     vim.keymap.set('n', 'gi', vim.lsp.buf.implementation, bufopts)
8.     vim.keymap.set('n', 'gr', vim.lsp.buf.references, bufopts)
9.     vim.keymap.set('n', 'K', vim.lsp.buf.hover, bufopts)
10.     vim.keymap.set('n', '<C-k>', vim.lsp.buf.signature_help, bufopts)
11.     vim.keymap.set('n', '<leader>wa', vim.lsp.buf.add_workspace_folder, bufopts)
12.     vim.keymap.set('n', '<leader>wr', vim.lsp.buf.remove_workspace_folder, bufopts)
13.     vim.keymap.set('n', '<leader>wl', function()
14.         print(vim.inspect(vim.lsp.buf.list_workspace_folders()))
15.     end, bufopts)
16.     vim.keymap.set('n', '<leader>D', vim.lsp.buf.type_definition, bufopts)
17.     vim.keymap.set('n', '<leader>rn', vim.lsp.buf.rename, bufopts)
18.     vim.keymap.set('n', '<leader>ca', vim.lsp.buf.code_action, bufopts)
19.     vim.keymap.set('n', '<leader>f', function()
20.         vim.lsp.buf.format { async = true }
21.     end, bufopts)
23.     local augroup = vim.api.nvim_create_augroup("LspFormatting", {})
24.     if client.supports_method("textDocument/formatting") then
25.         vim.api.nvim_clear_autocmds({ group = augroup, buffer = bufnr })
26.         vim.api.nvim_create_autocmd("BufWritePre", {
27.             group = augroup,
28.             buffer = bufnr,
29.             callback = function()
30.                 vim.lsp.buf.format({
31.                     filter = function(client)
32.                         return client.name == "null-ls"
33.                     end,
34.                     bufnr = bufnr,
35.                 })
36.             end,
37.         })
38.     end
39. end

复制代码

主要是定义了一些快捷键，例如：

• gd 可以跳转至关键字定义；
  
• gi 可以跳转至类型实现；
  
• ,D 可以跳转至类型定义；
  
• ,f 代码格式化；
  
• 保存时自动进行代码格式化；
  

其它

• 注释，使用插件：comment.nvim；
  
• 错误列表，使用插件：trouble.nvim；
  

完整配置

1. vim.o.listchars = "eol:↵,lead:‧"
2. vim.wo.list = truevim.wo.number = truevim.wo.signcolumn = "yes"vim.wo.colorcolumn = "80"vim.g.shiftround = true
3. vim.bo.expandtab = true
4. vim.bo.shiftwidth = 4
5. vim.bo.softtabstop = 4
6. vim.bo.tabstop = 4vim.g.termguicolors = truevim.g.completeopt = "menu,menuone,noselect"vim.g.mapleader = ","vim.keymap.set("n", "<leader><space>", "<cmd>nohlsearch<cr>", { silent = true })-- vim.lsp.set_log_level("debug")local on_attach = function(client, bufnr)
7.     vim.api.nvim_buf_set_option(bufnr, 'omnifunc', 'v:lua.vim.lsp.omnifunc')
9.     local bufopts = { noremap=true, silent=true, buffer=bufnr }
10.     vim.keymap.set('n', 'gD', vim.lsp.buf.declaration, bufopts)
11.     vim.keymap.set('n', 'gd', vim.lsp.buf.definition, bufopts)
12.     vim.keymap.set('n', 'gi', vim.lsp.buf.implementation, bufopts)
13.     vim.keymap.set('n', 'gr', vim.lsp.buf.references, bufopts)
14.     vim.keymap.set('n', 'K', vim.lsp.buf.hover, bufopts)
15.     vim.keymap.set('n', '<C-k>', vim.lsp.buf.signature_help, bufopts)
16.     vim.keymap.set('n', '<leader>wa', vim.lsp.buf.add_workspace_folder, bufopts)
17.     vim.keymap.set('n', '<leader>wr', vim.lsp.buf.remove_workspace_folder, bufopts)
18.     vim.keymap.set('n', '<leader>wl', function()
19.         print(vim.inspect(vim.lsp.buf.list_workspace_folders()))
20.     end, bufopts)
21.     vim.keymap.set('n', '<leader>D', vim.lsp.buf.type_definition, bufopts)
22.     vim.keymap.set('n', '<leader>rn', vim.lsp.buf.rename, bufopts)
23.     vim.keymap.set('n', '<leader>ca', vim.lsp.buf.code_action, bufopts)
24.     vim.keymap.set('n', '<leader>f', function()
25.         vim.lsp.buf.format { async = true }
26.     end, bufopts)
28.     local augroup = vim.api.nvim_create_augroup("LspFormatting", {})
29.     if client.supports_method("textDocument/formatting") then
30.         vim.api.nvim_clear_autocmds({ group = augroup, buffer = bufnr })
31.         vim.api.nvim_create_autocmd("BufWritePre", {
32.             group = augroup,
33.             buffer = bufnr,
34.             callback = function()
35.                 vim.lsp.buf.format({
36.                     filter = function(client)
37.                         return client.name == "null-ls"
38.                     end,
39.                     bufnr = bufnr,
40.                 })
41.             end,
42.         })
43.     end
44. endlocal lazypath = vim.fn.stdpath("data") .. "/lazy/lazy.nvim"if not vim.loop.fs_stat(lazypath) then    vim.fn.system({        "git",        "clone",        "--filter=blob:none",        "git@github.com:folke/lazy.nvim.git",        "--branch=stable",        lazypath,    })endvim.opt.rtp:prepend(lazypath)require("lazy").setup({    "nvim-tree/nvim-web-devicons",    {
45.         "EdenEast/nightfox.nvim",
46.         lazy = false,
47.         priority = 1000,
48.         config = function()
49.             vim.cmd([[colorscheme nordfox]])
50.         end,
51.     },    {        "nvim-tree/nvim-tree.lua",        config = function()            vim.g.loaded_netrw = 1            vim.g.loaded_netrwPlugin = 1            require("nvim-tree").setup({                sort_by = "case_sensitive",            })            vim.keymap.set("n", "d", "NvimTreeToggle", { silent = true })        end,    },    {        "nvim-lualine/lualine.nvim",        dependencies = {            "nvim-tree/nvim-web-devicons",        },        opts = {            options = {                section_separators = "",                component_separators = "⁞",            },        },    },    {        "akinsho/bufferline.nvim",        version = "^3.1.0",        config = function()            require("bufferline").setup()            vim.keymap.set("n", "<leader>bp", "<cmd>BufferLineCyclePrev<cr>", { silent = true })
52.             vim.keymap.set("n", "<leader>bn", "<cmd>BufferLineCycleNext<cr>", { silent = true })
53.             vim.keymap.set("n", "<leader>bd", "<cmd>bd<cr>", { silent = true })        end,    },    {        "lukas-reineke/indent-blankline.nvim",        opts = {            show_end_of_line = true,            space_char_blankline = " ",        },    },    {
54.         "L3MON4D3/LuaSnip",
55.         version = "^1.1.0",
56.         dependencies = {
57.             "rafamadriz/friendly-snippets",
58.         },
59.         config = function()
60.             require("luasnip.loaders.from_vscode").lazy_load()
61.         end,
62.     },    {
63.         "hrsh7th/nvim-cmp",
64.         dependencies = {
65.             "hrsh7th/cmp-buffer",
66.             "hrsh7th/cmp-path",
67.             "hrsh7th/cmp-nvim-lsp",
68.             "L3MON4D3/LuaSnip",
69.             "saadparwaiz1/cmp_luasnip",
70.         },
71.         config = function()
72.             local cmp = require("cmp")
74.             cmp.setup({
75.                 snippet = {
76.                     expand = function(args)
77.                         require("luasnip").lsp_expand(args.body)
78.                     end,
79.                 },
80.                 mapping = cmp.mapping.preset.insert({
81.                     ['<C-b>'] = cmp.mapping.scroll_docs(-4),
82.                     ['<C-f>'] = cmp.mapping.scroll_docs(4),
83.                     ['<C-Space>'] = cmp.mapping.complete(),
84.                     ['<C-e>'] = cmp.mapping.abort(),
85.                     ['<CR>'] = cmp.mapping.confirm({ select = true }),
86.                 }),
87.                 sources = cmp.config.sources({
88.                     { name = 'nvim_lsp' },
89.                     { name = 'luasnip' },
90.                 }, {
91.                     { name = 'buffer' },
92.                     { name = "path" },
93.                 }),
94.             })
95.         end,
96.     },    {        "williamboman/mason.nvim",        opts = {            ui = {                check_outdated_packages_on_open = false,            },        },    },    {
97.         "neovim/nvim-lspconfig",
98.         dependencies = {
99.             "williamboman/mason.nvim",
100.             "williamboman/mason-lspconfig.nvim",
101.             "hrsh7th/cmp-nvim-lsp",
102.         },
103.         config = function()
104.             require("mason-lspconfig").setup({
105.                 ensure_installed = {
106.                     "bashls",
107.                     "clangd",
108.                     "denols",
109.                     "pyright",
110.                     "rust_analyzer",
111.                 },
112.             })
114.             local capabilities = require('cmp_nvim_lsp').default_capabilities()
116.             local lspcfg = require("lspconfig")
117.             lspcfg.bashls.setup({
118.                 capabilities = capabilities,
119.                 on_attach = on_attach
120.             })
121.             lspcfg.clangd.setup({
122.                 capabilities = capabilities,
123.                 on_attach = on_attach
124.             })
125.             lspcfg.denols.setup({
126.                 capabilities = capabilities,
127.                 on_attach = on_attach
128.             })
129.             lspcfg.pyright.setup({
130.                 capabilities = capabilities,
131.                 on_attach = on_attach
132.             })
133.             lspcfg.rust_analyzer.setup({
134.                 capabilities = capabilities,
135.                 on_attach = on_attach
136.             })
137.         end,
138.     },    {
139.         "jose-elias-alvarez/null-ls.nvim",
140.         dependencies = {
141.             "nvim-lua/plenary.nvim",
142.         },
143.         config = function()
144.             local nl = require("null-ls")
145.             local sources = {
146.                 nl.builtins.diagnostics.eslint_d,
147.                 nl.builtins.diagnostics.ruff,
148.                 nl.builtins.formatting.beautysh,
149.                 nl.builtins.formatting.black,
150.                 nl.builtins.formatting.clang_format,
151.                 nl.builtins.formatting.prettierd,
152.                 nl.builtins.formatting.rustfmt,
153.                 nl.builtins.formatting.sql_formatter,
154.             }
155.             nl.setup({
156.                 sources = sources,
157.                 on_attach = on_attach,
158.             })
159.         end,
160.     },    {        'numToStr/Comment.nvim',        config = true,    },    {        "folke/trouble.nvim",        dependencies = {            "nvim-tree/nvim-web-devicons",        },        config = true,    },}, {    git = {        url_format = "git@github.com:%s",    },})

复制代码

来源:https://www.cnblogs.com/rockety/p/17282830.html
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！