Neovim，要嘗一口不？

Neovim 風評很好，我機器上其實早裝了它來替代 vim。只不過這兩年用 vscode 較多，冷落了它，除了偶爾改改配置文件，很少用。難得大過年的有點兒空，就來倒騰它一下子，最終效果如下。

基礎配置

從 0.5 版開始，Neovim 允許使用 Lua 代替 VimL 作為配置語言，所以這裡也直接從 init.lua 開始了。

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

打開此文件，開始配置。

nvim ~/.config/nvim/init.lua

先設置一下縮進，預設是 8 個字元，改為 4 個字元且按 tab 鍵自動補空格：

vim.g.shiftround = true
vim.bo.expandtab = true
vim.bo.shiftwidth = 4
vim.bo.softtabstop = 4
vim.bo.tabstop = 4

再來顯示下行號及右邊界警示線。右邊界一般建議為 80，即代碼超過 80 個字元應該註意換行。對現在的屏幕解析度來說，80 其實有些窄，可以設為 120。

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

neovim 預設打開了不少之前在 vim 中需要單獨設置的選項，比如說自動縮進、文件類型檢測、語法高亮等等。有了上面這幾行，基礎的配置差不多就夠了，其它的安裝插件後再調整。

插件管理

選用 lazy，與 packer 相比，它不需要編譯、更快、界面也好看些，還有其它優點，不羅列了。總之，就是它了。

local lazypath = vim.fn.stdpath("data") .. "/lazy/lazy.nvim"
if not vim.loop.fs_stat(lazypath) then
  vim.fn.system({
    "git",
    "clone",
    "--filter=blob:none",
    "[email protected]:folke/lazy.nvim.git",
    "--branch=stable",
    lazypath,
  })
end
vim.opt.rtp:prepend(lazypath)

註意與官方文檔相比，我把 clone 地址由 https://github.com/folke/lazy.nvim.git 改為了 [email protected]:folke/lazy.nvim.git，原因你知道的，國內訪問 Github 網址抽風，改用後者要好一些。

接著就是讓 lazy 起作用了，加入如下配置：

require("lazy").setup({
	-- 插件寫這裡
}, {
    git = {
        url_format = "[email protected]:%s"
    }
})

以上同樣加了些針對 git 下載路徑的自定義設置，原因同上。

需要特別說明的是，為了節省篇幅，後續凡是提到安裝插件的，相關代碼都是追加到如下註釋的地方：

-- 以上省略
require("lazy").setup({
	-- 插件相關配置在這裡追加
}, {
-- 以下省略

然後輸入如下命令就可以打開安裝界面進行安裝了：

:Lazy

配色方案

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

    {
        "EdenEast/nightfox.nvim",
        lazy = false,
        priority = 1000,
        config = function()
            vim.cmd([[colorscheme nordfox]])
        end,
    },

安裝之後，界面長這樣：

還是很好看的。

字體與圖標

首先打開 NERD FONTS，找一款你喜歡的編程字體裝進系統里，然後設置你的終端使用該字體。接下來安裝插件 nvim-web-devicons：

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

以上操作目的是為了給 neovim 提供圖標支撐，目前暫時看不到變化，算是為後續做些準備工作。

狀態欄

選用 lualine 插件：

    {
        "nvim-lualine/lualine.nvim",
        opts = {
            options = {
                section_separators = '',
                component_separators = ''
            }
        }
    },

其實可以只保留如下一行，顯示效果可能還好一些。我個人偏愛簡潔樣式，用上述選項是為了去掉分隔符。

    "nvim-lualine/lualine.nvim",

文件管理

選 nvim-tree，用的人多，比較活躍。

    {
        "nvim-tree/nvim-tree.lua",
        config = function()
            vim.g.loaded_netrw = 1
            vim.g.loaded_netrwPlugin = 1
            vim.g.termguicolors = true

            require("nvim-tree").setup({
                sort_by = "case_sensitive",
            })
        end,
    },

安裝後，輸入命令：

:NvimTreeToggle

就會打開文件樹，如下圖：

但是每次輸入命令打開關閉文件樹不太爽，用快捷鍵就好多了。

快捷鍵

先定義一下全局的快捷起始鍵，通常用空格或逗號，如下定義為逗號：

vim.g.mapleader = ","

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

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

快捷鍵用熟了很好，剛定義時容易忘。想要提示的話，可以用 which-key 插件來定義快捷鍵。

    {
        "folke/which-key.nvim",
        config = function()
            vim.o.timeout = true
            vim.o.timeoutlen = 300

            local wk = require("which-key")
            -- 快捷鍵在這裡定義
            wk.setup()
        end,
    },

註意其中的註釋，後續對快捷鍵定義如無特殊說明，都寫在上述註釋所在的位置。

現在可以試一下了，按下 Ctrl-W 組合鍵，效果如下：

Amazing，比較帶勁是不是？

接下來註冊自己想要的快捷鍵，比如：

            wk.register({
                ["<space>"] = { "<cmd>nohlsearch<cr>", "取消搜索高亮" },
                ["d"] = { "<cmd>NvimTreeToggle<cr>", "顯示/隱藏目錄樹" },
            }, { prefix = "<leader>" })

這樣就可以用 ,+d 來切換目錄樹的顯示了。順便的，當使用 / 或 ? 搜索時，匹配項會高亮顯示，現在可以使用 ,+空格 來取消高亮了。如果按下 , 鍵，則會彈出以上快捷鍵的說明。相當不錯！

多文檔

vim/neovim 有兩種模式支持多文檔編輯：標簽頁或緩衝區。這裡選擇使用緩衝區，bufferline 插件可以展示多個緩衝區的文檔標簽：

    {
        "akinsho/bufferline.nvim",
        tag = "v3.*",
        config = function()
            vim.g.termguicolors = true

            require("bufferline").setup()
        end,
    },

試下效果吧。用 ,+d 打開目錄樹，按 j 或 k 選中個文件，再按 o 或直接回車就打開了，註意上方多出來的標簽頁。

試試用滑鼠點擊標簽頁以及其中的關閉按紐，功能正是你想要的，對吧？不過在 vim 中用滑鼠似乎有些 low，用命令 :bn、:bp 算是正常途徑。也可以定義快捷鍵，如下：

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

配置到現在，乍一看很象回事了。但是用來寫代碼的話，還不太夠，所以繼續。

參考線及特殊字元

先加兩行全局配置，以區分空格與製表符、以及折行與回車換行:

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

然後裝個 indent-blankline 插件：

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

代碼片斷

使用插件 luasnip，與自動完成的集成稍後再說。

    {
        "L3MON4D3/LuaSnip",
        version = "^1.1.0",
        dependencies = {
            "rafamadriz/friendly-snippets",
        },
        config = function()
            require("luasnip.loaders.from_vscode").lazy_load()
        end,
    },

自動完成

從這裡開始，進入稍微複雜的配置部分。先來弄自動完成。自動完成的原材料可以來源於當前文檔關鍵字、可以來源於代碼片斷，當然我們更希望它來源於我們的編程上下文語義，即 LSP 集成。如下是相關插件配置。

    {
        "hrsh7th/nvim-cmp",
        dependencies = {
            "hrsh7th/cmp-buffer",
            "hrsh7th/cmp-path",
            "hrsh7th/cmp-nvim-lsp",
            "L3MON4D3/LuaSnip",
            "saadparwaiz1/cmp_luasnip",
        },
        config = function()
            local cmp = require("cmp")

            cmp.setup({
                snippet = {
                    expand = function(args)
                        require("luasnip").lsp_expand(args.body)
                    end,
                },
                mapping = cmp.mapping.preset.insert({
                    ['<C-b>'] = cmp.mapping.scroll_docs(-4),
                    ['<C-f>'] = cmp.mapping.scroll_docs(4),
                    ['<C-Space>'] = cmp.mapping.complete(),
                    ['<C-e>'] = cmp.mapping.abort(),
                    ['<CR>'] = cmp.mapping.confirm({ select = true }),
                }),
                sources = cmp.config.sources({
                    { name = 'nvim_lsp' },
                    { name = 'luasnip' },
                }, {
                    { name = 'buffer' },
                    { name = "path" },
                }),
            })
        end,
    },

看起來比較複雜，對吧？簡單解釋一下：

• 自動完成使用了 nvim-cmp 插件；
• 提示內容可以來源於當前文檔、路徑、代碼片斷及上下文語義；
• 定義了幾個快捷鍵；

上下文語義（LSP）

可能是最複雜的部分，配置如下：

    {
        "neovim/nvim-lspconfig",
        dependencies = {
            "williamboman/mason.nvim",
            "williamboman/mason-lspconfig.nvim",
            "hrsh7th/cmp-nvim-lsp",
        },
        config = function()
            require("mason-lspconfig").setup({
                ensure_installed = {
                    "bashls",
                    "clangd",
                    "denols",
                    "pyright",
                    "rust_analyzer",
                },
            })

            local capabilities = require('cmp_nvim_lsp').default_capabilities()

            local lspcfg = require("lspconfig")
            lspcfg.bashls.setup({
                capabilities = capabilities,
                on_attach = on_attach
            })
            lspcfg.clangd.setup({
                capabilities = capabilities,
                on_attach = on_attach
            })
            lspcfg.denols.setup({
                capabilities = capabilities,
                on_attach = on_attach
            })
            lspcfg.pyright.setup({
                capabilities = capabilities,
                on_attach = on_attach
            })
            lspcfg.rust_analyzer.setup({
                capabilities = capabilities,
                on_attach = on_attach
            })
        end,
    },

仍然是最簡單的解釋一下：

• 使用了 nvim-lspconfig 插件來做 LSP 的配置；
• 不同的編程語言要安裝不同的語言服務，使用 mason 來統一管理這些語言服務組件；
• 自動安裝 bash、c/c++、js/ts、python、rust 語言服務；
• 集成上述編程語言的語義化自動完成功能；

其中有個 on_attach 在給出的配置代碼中暫未給出，是因為這是個公用函數，下文的代碼格式化也會用到，所以稍後再描述。

格式化及診斷

這兩項內容均使用 null-ls 插件實現，配置如下：

    {
        "jose-elias-alvarez/null-ls.nvim",
        dependencies = {
            "nvim-lua/plenary.nvim",
        },
        config = function()
            local nl = require("null-ls")
            local sources = {
                nl.builtins.diagnostics.eslint_d,
                nl.builtins.diagnostics.ruff,
                nl.builtins.formatting.beautysh,
                nl.builtins.formatting.black,
                nl.builtins.formatting.clang_format,
                nl.builtins.formatting.prettierd,
                nl.builtins.formatting.rustfmt,
                nl.builtins.formatting.sql_formatter,
            }
            nl.setup({
                sources = sources,
                on_attach = on_attach,
            })
        end,
    },

很明顯，診斷與格式化也都與編程語言相關，同樣依賴一些第三方組件。儘管上述配置沒用明確給出，也可以通過 mason 管理，之前已經安裝過些插件。輸入 :Mason 即可打開其界面如下：

可以看到我已經安裝了 LSP 及格式化與診斷相關的幾個組件。

是時候說一下 on_attach 了，其代碼如下：

local on_attach = function(client, bufnr)
    vim.api.nvim_buf_set_option(bufnr, 'omnifunc', 'v:lua.vim.lsp.omnifunc')

    local bufopts = { noremap=true, silent=true, buffer=bufnr }
    vim.keymap.set('n', 'gD', vim.lsp.buf.declaration, bufopts)
    vim.keymap.set('n', 'gd', vim.lsp.buf.definition, bufopts)
    vim.keymap.set('n', 'gi', vim.lsp.buf.implementation, bufopts)
    vim.keymap.set('n', 'gr', vim.lsp.buf.references, bufopts)
    vim.keymap.set('n', 'K', vim.lsp.buf.hover, bufopts)
    vim.keymap.set('n', '<C-k>', vim.lsp.buf.signature_help, bufopts)
    vim.keymap.set('n', '<leader>wa', vim.lsp.buf.add_workspace_folder, bufopts)
    vim.keymap.set('n', '<leader>wr', vim.lsp.buf.remove_workspace_folder, bufopts)
    vim.keymap.set('n', '<leader>wl', function()
        print(vim.inspect(vim.lsp.buf.list_workspace_folders()))
    end, bufopts)
    vim.keymap.set('n', '<leader>D', vim.lsp.buf.type_definition, bufopts)
    vim.keymap.set('n', '<leader>rn', vim.lsp.buf.rename, bufopts)
    vim.keymap.set('n', '<leader>ca', vim.lsp.buf.code_action, bufopts)
    vim.keymap.set('n', '<leader>f', function()
        vim.lsp.buf.format { async = true }
    end, bufopts)

    local augroup = vim.api.nvim_create_augroup("LspFormatting", {})
    if client.supports_method("textDocument/formatting") then
        vim.api.nvim_clear_autocmds({ group = augroup, buffer = bufnr })
        vim.api.nvim_create_autocmd("BufWritePre", {
            group = augroup,
            buffer = bufnr,
            callback = function()
                vim.lsp.buf.format({
                    filter = function(client)
                        return client.name == "null-ls"
                    end,
                    bufnr = bufnr,
                })
            end,
        })
    end
end

主要是定義了一些快捷鍵，例如：

• gd 可以跳轉至關鍵字定義；
• gi 可以跳轉至類型實現；
• ,D 可以跳轉至類型定義；
• ,f 代碼格式化；
• 保存時自動進行代碼格式化；

其它

• 註釋，使用插件：comment.nvim；
• 錯誤列表，使用插件：trouble.nvim；

完整配置

vim.o.listchars = "eol:↵,lead:‧"
vim.wo.list = true
vim.wo.number = true
vim.wo.signcolumn = "yes"
vim.wo.colorcolumn = "80"

vim.g.shiftround = true
vim.bo.expandtab = true
vim.bo.shiftwidth = 4
vim.bo.softtabstop = 4
vim.bo.tabstop = 4

vim.g.termguicolors = true
vim.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)
    vim.api.nvim_buf_set_option(bufnr, 'omnifunc', 'v:lua.vim.lsp.omnifunc')

    local bufopts = { noremap=true, silent=true, buffer=bufnr }
    vim.keymap.set('n', 'gD', vim.lsp.buf.declaration, bufopts)
    vim.keymap.set('n', 'gd', vim.lsp.buf.definition, bufopts)
    vim.keymap.set('n', 'gi', vim.lsp.buf.implementation, bufopts)
    vim.keymap.set('n', 'gr', vim.lsp.buf.references, bufopts)
    vim.keymap.set('n', 'K', vim.lsp.buf.hover, bufopts)
    vim.keymap.set('n', '<C-k>', vim.lsp.buf.signature_help, bufopts)
    vim.keymap.set('n', '<leader>wa', vim.lsp.buf.add_workspace_folder, bufopts)
    vim.keymap.set('n', '<leader>wr', vim.lsp.buf.remove_workspace_folder, bufopts)
    vim.keymap.set('n', '<leader>wl', function()
        print(vim.inspect(vim.lsp.buf.list_workspace_folders()))
    end, bufopts)
    vim.keymap.set('n', '<leader>D', vim.lsp.buf.type_definition, bufopts)
    vim.keymap.set('n', '<leader>rn', vim.lsp.buf.rename, bufopts)
    vim.keymap.set('n', '<leader>ca', vim.lsp.buf.code_action, bufopts)
    vim.keymap.set('n', '<leader>f', function()
        vim.lsp.buf.format { async = true }
    end, bufopts)

    local augroup = vim.api.nvim_create_augroup("LspFormatting", {})
    if client.supports_method("textDocument/formatting") then
        vim.api.nvim_clear_autocmds({ group = augroup, buffer = bufnr })
        vim.api.nvim_create_autocmd("BufWritePre", {
            group = augroup,
            buffer = bufnr,
            callback = function()
                vim.lsp.buf.format({
                    filter = function(client)
                        return client.name == "null-ls"
                    end,
                    bufnr = bufnr,
                })
            end,
        })
    end
end

local lazypath = vim.fn.stdpath("data") .. "/lazy/lazy.nvim"
if not vim.loop.fs_stat(lazypath) then
    vim.fn.system({
        "git",
        "clone",
        "--filter=blob:none",
        "[email protected]:folke/lazy.nvim.git",
        "--branch=stable",
        lazypath,
    })
end
vim.opt.rtp:prepend(lazypath)

require("lazy").setup({
    "nvim-tree/nvim-web-devicons",
    {
        "EdenEast/nightfox.nvim",
        lazy = false,
        priority = 1000,
        config = function()
            vim.cmd([[colorscheme nordfox]])
        end,
    },
    {
        "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", "<leader>d", "<cmd>NvimTreeToggle<cr>", { 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 })
            vim.keymap.set("n", "<leader>bn", "<cmd>BufferLineCycleNext<cr>", { silent = true })
            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 = " ",
        },
    },
    {
        "L3MON4D3/LuaSnip",
        version = "^1.1.0",
        dependencies = {
            "rafamadriz/friendly-snippets",
        },
        config = function()
            require("luasnip.loaders.from_vscode").lazy_load()
        end,
    },
    {
        "hrsh7th/nvim-cmp",
        dependencies = {
            "hrsh7th/cmp-buffer",
            "hrsh7th/cmp-path",
            "hrsh7th/cmp-nvim-lsp",
            "L3MON4D3/LuaSnip",
            "saadparwaiz1/cmp_luasnip",
        },
        config = function()
            local cmp = require("cmp")

            cmp.setup({
                snippet = {
                    expand = function(args)
                        require("luasnip").lsp_expand(args.body)
                    end,
                },
                mapping = cmp.mapping.preset.insert({
                    ['<C-b>'] = cmp.mapping.scroll_docs(-4),
                    ['<C-f>'] = cmp.mapping.scroll_docs(4),
                    ['<C-Space>'] = cmp.mapping.complete(),
                    ['<C-e>'] = cmp.mapping.abort(),
                    ['<CR>'] = cmp.mapping.confirm({ select = true }),
                }),
                sources = cmp.config.sources({
                    { name = 'nvim_lsp' },
                    { name = 'luasnip' },
                }, {
                    { name = 'buffer' },
                    { name = "path" },
                }),
            })
        end,
    },
    {
        "williamboman/mason.nvim",
        opts = {
            ui = {
                check_outdated_packages_on_open = false,
            },
        },
    },
    {
        "neovim/nvim-lspconfig",
        dependencies = {
            "williamboman/mason.nvim",
            "williamboman/mason-lspconfig.nvim",
            "hrsh7th/cmp-nvim-lsp",
        },
        config = function()
            require("mason-lspconfig").setup({
                ensure_installed = {
                    "bashls",
                    "clangd",
                    "denols",
                    "pyright",
                    "rust_analyzer",
                },
            })

            local capabilities = require('cmp_nvim_lsp').default_capabilities()

            local lspcfg = require("lspconfig")
            lspcfg.bashls.setup({
                capabilities = capabilities,
                on_attach = on_attach
            })
            lspcfg.clangd.setup({
                capabilities = capabilities,
                on_attach = on_attach
            })
            lspcfg.denols.setup({
                capabilities = capabilities,
                on_attach = on_attach
            })
            lspcfg.pyright.setup({
                capabilities = capabilities,
                on_attach = on_attach
            })
            lspcfg.rust_analyzer.setup({
                capabilities = capabilities,
                on_attach = on_attach
            })
        end,
    },
    {
        "jose-elias-alvarez/null-ls.nvim",
        dependencies = {
            "nvim-lua/plenary.nvim",
        },
        config = function()
            local nl = require("null-ls")
            local sources = {
                nl.builtins.diagnostics.eslint_d,
                nl.builtins.diagnostics.ruff,
                nl.builtins.formatting.beautysh,
                nl.builtins.formatting.black,
                nl.builtins.formatting.clang_format,
                nl.builtins.formatting.prettierd,
                nl.builtins.formatting.rustfmt,
                nl.builtins.formatting.sql_formatter,
            }
            nl.setup({
                sources = sources,
                on_attach = on_attach,
            })
        end,
    },
    {
        'numToStr/Comment.nvim',
        config = true,
    },
    {
        "folke/trouble.nvim",
        dependencies = {
            "nvim-tree/nvim-web-devicons",
        },
        config = true,
    },
}, {
    git = {
        url_format = "[email protected]:%s",
    },
})