在lsp-zero.nvim中配置EFM语言服务器

EFM (Error Formatter Manager) 是一个通用的语言服务器，它可以将各种命令行工具集成到Neovim的LSP生态系统中。本文将详细介绍如何在lsp-zero.nvim项目中配置EFM来支持Markdown文件的格式化和语法检查。

EFM配置基础

EFM的核心功能是通过配置文件将外部工具包装成LSP服务。在lsp-zero.nvim中，我们可以直接通过lspconfig来设置EFM服务器。一个典型的EFM配置包含以下几个关键部分：

1. 工具定义：描述要使用的外部工具及其参数
2. 语言关联：指定哪些工具用于哪些文件类型
3. 功能启用：明确EFM提供的LSP功能

Markdown工具配置实例

对于Markdown文件处理，我们通常会配置两个工具：

1. markdownlint：用于语法检查和风格验证
2. pandoc：用于文档格式化

以下是完整的配置示例：

-- 定义EFM要使用的工具
local efm_tools = {
  pandoc = {
    formatCommand = "pandoc -f markdown -t gfm -sp --tab-stop=2",
  },
  markdownlint = {
    lintCommand = "markdownlint -s",
    lintStdin = true,
    lintFormats = {
      "%f:%l %m",
      "%f:%l:%c %m",
      "%f: %l: %m",
    },
  }
}

-- 配置EFM服务器
require('lspconfig').efm.setup({
  init_options = {
    -- 启用EFM支持的功能
    documentFormatting = true,    -- 文档格式化
    documentRangeFormatting = false, -- 范围格式化(禁用)
    hover = false,                -- 悬停信息(禁用)
    documentSymbol = false,       -- 文档符号(禁用)
    completion = false,           -- 自动补全(禁用)
    codeAction = false            -- 代码操作(禁用)
  },
  settings = {
    rootMarkers = {'.git/'},      -- 项目根目录标记
    -- 按语言配置工具
    languages = {
      markdown = {
        efm_tools.pandoc,        -- 应用于Markdown的格式化工具
        efm_tools.markdownlint,  -- 应用于Markdown的语法检查工具
      },
    }
  },
  -- EFM将激活的文件类型列表
  filetypes = {
    'markdown',
  },
})

配置详解

工具定义部分

每个工具配置包含以下关键属性：

1. formatCommand：格式化命令，用于文档格式化
2. lintCommand：语法检查命令
3. lintStdin：是否通过标准输入传递文件内容
4. lintFormats：定义如何解析工具的输出并转换为LSP诊断信息

EFM服务器设置

1. init_options：控制EFM提供的LSP功能

   • 只启用真正需要的功能可以提高性能
   • 对于Markdown，通常只需要文档格式化

2. settings.languages：

   • 按文件类型组织工具
   • 可以为一个语言指定多个工具

3. filetypes：

   • 明确EFM将处理的文件类型
   • 避免不必要的服务器激活

注意事项

1. 确保系统中已安装所有配置的工具(pandoc和markdownlint)
2. 工具路径可能需要根据系统环境调整
3. 复杂的项目可能需要更细致的rootMarkers配置
4. 性能敏感的项目可以进一步限制EFM的功能

通过以上配置，开发者可以在lsp-zero.nvim中充分利用EFM的强大功能，将各种命令行工具无缝集成到Neovim的LSP工作流中，特别是对Markdown文档的支持将变得更加完善和专业。