如何捕获Neovim内嵌交互式终端的输出与退出码？

核心结论：可以实现类似plenary.job的功能，但需要通过额外的包装逻辑来捕获交互式Shell内CLI命令的输出与退出码——因为交互式Shell本身不会主动暴露子进程的这些信息。

以下是几种可行的实现思路：

1. 临时文件捕获法 #

给要执行的CLI命令添加包装，让它将输出和退出码写入唯一的临时文件，之后插件读取该文件解析结果：

• 先生成唯一临时文件：local temp_file = vim.fn.tempname()
• 构造带包装的命令：

  local wrapped_cmd = string.format(
    "%s > %s 2>&1; echo 'EXIT_CODE:$?' >> %s",
    your_cli_command,
    temp_file,
    temp_file
  )
  

• 通过PTY发送该命令到交互式Shell
• 等待命令执行完成后（可通过定时轮询或监听Shell输出的结束标记），读取临时文件内容，分离原始输出和退出码：

  local content = vim.fn.readfile(temp_file)
  local exit_code = nil
  local output = {}
  for _, line in ipairs(content) do
    local code_match = line:match("EXIT_CODE:(%d+)")
    if code_match then
      exit_code = tonumber(code_match)
    else
      table.insert(output, line)
    end
  end
  -- 处理output和exit_code
  vim.fn.delete(temp_file) -- 清理临时文件
  

• 优点：逻辑简单，兼容性好；缺点：依赖临时文件，需用tempname生成唯一文件避免多实例冲突。

2. 终端缓冲区标记监听法 #

在CLI命令末尾添加自定义结束标记，通过监听终端缓冲区的新增内容来捕获结果：

• 构造带标记的命令：

  local wrapped_cmd = string.format(
    "%s; echo '===CLI_CMD_COMPLETED===$?'",
    your_cli_command
  )
  

• 发送命令前记录当前终端缓冲区的行数：local start_line = vim.api.nvim_buf_line_count(term_bufnr)
• 通过PTY发送命令后，定时轮询或用BufWritePost/CursorHold事件监听缓冲区变化，当检测到包含===CLI_CMD_COMPLETED===的行时：
  • 提取从start_line+1到标记行之前的内容作为命令输出
  • 从标记行中解析退出码：local exit_code = tonumber(line:match("===CLI_CMD_COMPLETED===(%d+)"))
• 优点：无需临时文件；缺点：需要处理终端输出的换行、回显干扰（比如Shell提示符、命令本身的回显），需过滤无关内容。

3. 终端Job Channel监听法 #

利用Neovim终端对应的Job Channel直接捕获输出：

• 获取当前终端缓冲区的Job ID：local job_id = vim.api.nvim_buf_get_var(term_bufnr, 'terminal_job_id')
• 注册Channel的stdout监听回调：

  vim.api.nvim_chan_register(job_id, 'stdout', function(data)
    -- data是输出的行列表，包含Shell的所有输出（提示符、命令回显、CLI输出等）
    -- 需要自行过滤出目标CLI命令的输出
    -- 可结合命令的开始/结束标记来识别有效内容
  end)
  

• 发送命令到Shell：vim.api.nvim_chan_send(job_id, your_cli_command..'\n')
• 优点：直接捕获输出，无需临时文件；缺点：需要处理大量无关输出的过滤逻辑，复杂度较高。

注意事项 #

• 所有方法都需要处理命令执行的异步性，避免插件阻塞Neovim主线程
• 要确保包装后的命令在用户的Shell（bash/zsh/fish等）中能正常执行，可能需要针对不同Shell做兼容处理
• 若要避免命令回显干扰，可在发送命令前先发送stty -echo，执行完后再发送stty echo，但会影响用户当前Shell的状态，需谨慎使用

内容的提问来源于stack exchange，提问作者Mark Whitfield