解决nvim-lint中缺失linter二进制文件时的错误处理

问题背景

在使用nvim-lint插件进行代码检查时，开发者常常会遇到一个常见问题：当配置了某个linter但系统中未安装对应的二进制文件时，插件会抛出错误信息。例如，当配置了phpcs但未安装时，会出现"Error running phpcs: ENOENT: no such file or directory"的错误提示。

现有解决方案分析

目前社区中主要有两种处理方式：

1. 忽略所有错误：通过try_lint(nil, { ignore_errors = true })参数可以忽略所有错误，但这会同时忽略其他类型的错误（如权限问题、配置错误等），不够理想。

2. 预检查二进制文件存在性：在配置阶段预先检查各linter的二进制文件是否存在，只启用可用的linter。这种方法虽然有效，但需要编写额外的配置代码。

推荐解决方案

对于大多数用户，推荐采用预检查二进制文件存在性的方法。以下是完整的实现示例：

{
  "mfussenegger/nvim-lint",
  opts = function(_, opts)
    local lint = require("lint")
    local linters = { "phpstan", "phpcs", "cpplint" } -- 所有可能的linter列表
    
    opts.linters_by_ft = opts.linters_by_ft or {}
    opts.linters_by_ft.php = opts.linters_by_ft.php or {}
    
    -- 过滤出可用的linter
    local available_linters = vim.tbl_filter(function(linter)
      local linter_def = lint.linters[linter]
      if not linter_def then return false end
      
      -- 处理cmd可能是函数或字符串的情况
      local cmd = type(linter_def.cmd) == "function" and linter_def.cmd() or linter_def.cmd
      return vim.fn.executable(cmd) == 1
    end, linters)
    
    -- 合并到现有配置
    vim.list_extend(opts.linters_by_ft.php, available_linters)
    
    return opts
  end,
}

实现原理详解

1. 获取linter定义：通过require("lint").linters[linter]获取linter的配置定义。

2. 处理cmd字段：linter的cmd字段可能是函数或字符串，需要分别处理：

   • 如果是函数，调用它获取实际命令
   • 如果是字符串，直接使用

3. 检查可执行性：使用vim.fn.executable()检查命令是否可用，返回1表示可用。

4. 过滤可用linter：使用vim.tbl_filter过滤出所有可用的linter。

高级用法

对于需要为多种文件类型配置linter的情况，可以扩展为更通用的解决方案：

local function setup_lint()
  local lint = require("lint")
  local linter_map = {
    php = { "phpstan", "phpcs" },
    cpp = { "cpplint" },
    -- 其他文件类型配置
  }
  
  for ft, linters in pairs(linter_map) do
    lint.linters_by_ft[ft] = vim.tbl_filter(function(linter)
      local linter_def = lint.linters[linter]
      if not linter_def then return false end
      local cmd = type(linter_def.cmd) == "function" and linter_def.cmd() or linter_def.cmd
      return vim.fn.executable(cmd) == 1
    end, linters)
  end
end

setup_lint()

注意事项

1. 某些linter可能有复杂的cmd定义，可能需要特殊处理。

2. 在Neovim启动时执行此检查，避免每次触发lint时都进行检查。

3. 考虑将配置缓存起来，提高性能。

通过这种解决方案，开发者可以像使用conform.nvim一样，配置所有可能用到的linter，而插件会自动过滤出当前环境中可用的linter，既保持了配置的简洁性，又避免了不必要的错误提示。