使用 mason 和 lsp-zero 在 Neovim 中设置格式化程序

Question

我正在使用 lsp-zero & mason 来安装 LSP、格式化程序和 linter。但是，我不确定格式化程序如何工作以及如何配置它们。

例如，即使我安装了

yml

和

yamlls

，

yamlfmt

文件的格式化程序似乎也无法工作。另一方面，Golang 的格式化程序似乎工作得很好，当我保存

*.go

文件时，它会自动格式化。

在这种情况下，您将如何设置 YAML 格式化程序？这是我的配置片段：

lsp.lua

local lsp = require("lsp-zero")

lsp.preset("recommended")

-- Fix Undefined global 'vim'
lsp.nvim_workspace()

local cmp = require('cmp')
local cmp_select = {behavior = cmp.SelectBehavior.Select}
local cmp_mappings = lsp.defaults.cmp_mappings({
  ['<C-p>'] = cmp.mapping.select_prev_item(cmp_select),
  ['<C-n>'] = cmp.mapping.select_next_item(cmp_select),
  ['<CR>'] = cmp.mapping.confirm({ select = true }),
  ["<C-Space>"] = cmp.mapping.complete(),
})

cmp_mappings['<Tab>'] = nil
cmp_mappings['<S-Tab>'] = nil

lsp.setup_nvim_cmp({
  mapping = cmp_mappings
})

lsp.set_preferences({
    suggest_lsp_servers = false,
    sign_icons = {
        error = 'E',
        warn = 'W',
        hint = 'H',
        info = 'I'
    }
})

lsp.on_attach(function(client, bufnr)
  local opts = {buffer = bufnr, remap = false}

  vim.keymap.set("n", "gd", function() vim.lsp.buf.definition() end, opts)
  vim.keymap.set("n", "K", function() vim.lsp.buf.hover() end, opts)
  vim.keymap.set("n", "<leader>vws", function() vim.lsp.buf.workspace_symbol() end, opts)
  vim.keymap.set("n", "<leader>vd", function() vim.diagnostic.open_float() end, opts)
  vim.keymap.set("n", "[d", function() vim.diagnostic.goto_next() end, opts)
  vim.keymap.set("n", "]d", function() vim.diagnostic.goto_prev() end, opts)
  vim.keymap.set("n", "<leader>vca", function() vim.lsp.buf.code_action() end, opts)
  vim.keymap.set("n", "<leader>vrr", function() vim.lsp.buf.references() end, opts)
  vim.keymap.set("n", "<leader>vrn", function() vim.lsp.buf.rename() end, opts)
  vim.keymap.set("i", "<C-h>", function() vim.lsp.buf.signature_help() end, opts)
end)

vim.diagnostic.config({
    virtual_text = true
})

mason.lua

require('mason-tool-installer').setup {
  ensure_installed = {
    'golangci-lint',
    'bash-language-server',
    'lua-language-server',
    'vim-language-server',
    'gopls',
    'stylua',
    'shellcheck',
    'sqlfmt',
    'editorconfig-checker',
    'gofumpt',
    'golines',
    'gomodifytags',
    'gotests',
    'goimports',
    'impl',
    'json-to-struct',
    'jq',
    'misspell',
    'revive',
    'shellcheck',
    'shfmt',
    'staticcheck',
    'vint',
    'yamllint',
    'yamlfmt',
    'yamlls',
    'hadolint',
    'dockerls',
    'diagnosticls',
    'sqlls',
    'terraformls',
    'delve'
  }
}

Answer 1

Mason 是一个包管理器，允许您管理包。有些软件包可以开箱即用，其他软件包则需要手动设置和/或通过命令调用所需的功能——格式化程序就是这样的一个例子。

通过 Mason 安装格式化程序后，您可以设置 Neovim 自动命令，使用所需参数对特定文件调用格式化程序。例如，对于

yamlfmt

，您可以创建一个文件（例如

~/.config/nvim/lua/autocmds.lua

）并添加以下代码：

-- Create group to assign commands
-- "clear = true" must be set to prevent loading an
-- auto-command repeatedly every time a file is resourced
local autocmd_group = vim.api.nvim_create_augroup("Custom auto-commands", { clear = true })

vim.api.nvim_create_autocmd({ "BufWritePost" }, {
    pattern = { "*.yaml", "*.yml" },
    desc = "Auto-format YAML files after saving",
    callback = function()
        local fileName = vim.api.nvim_buf_get_name(0)
        vim.cmd(":!yamlfmt " .. fileName)
    end,
    group = autocmd_group,
})

然后，通过将

autocmds.lua

添加到您的

require("autocmds")

文件中，确保每次启动 Neovim 时都获取此文件 (

~/.config/nvim/init.lua

)。

现在，每次写入以

BufWritePost

或

.yaml

扩展名结尾的缓冲区 (

.yml

)（即保存文件）时，都会进行回调，获取当前缓冲区中加载的文件的绝对路径(

nvim_buf_get_name(0)

)，然后执行非交互式终端命令，调用该文件上的 YAML 格式化程序。

要抑制命令的输出，请将

silent

添加到非交互式终端命令中：

vim.cmd(":silent !yamlfmt " .. fileName)

您还可以向回调添加多个终端命令。例如，在编辑 Python 文件时，我调用以下格式化程序，每个格式化程序处理代码的特定部分：

vim.api.nvim_create_autocmd({ "BufWritePost" }, {
    pattern = { "*.py" },
    desc = "Auto-format Python files after saving",
    callback = function()
        local fileName = vim.api.nvim_buf_get_name(0)
        vim.cmd(":silent !black --preview -q " .. fileName)
        vim.cmd(":silent !isort --profile black --float-to-top -q " .. fileName)
        vim.cmd(":silent !docformatter --in-place --black " .. fileName)
    end,
    group = autocmd_group,
})

不要忘记将每个自动命令添加到设置了

clear

标志的自动命令组中，以避免每次为文件提供资源时重复加载命令。您可以通过手册阅读有关自动命令的更多信息

:h autocmd

。