解决nvim-dap中bash-debug-adapter参数传递问题

问题背景

在使用nvim-dap插件配合bash-debug-adapter进行bash脚本调试时，开发者发现当脚本尝试访问位置参数$1时，会得到"undefined"这个意外的值。这个问题源于bash-debug-adapter在参数传递处理上的一个特殊行为。

问题分析

通过深入研究bash-debug-adapter的源代码，发现问题的根源在于bash-debug-adapter/extension/out/bashDebug.js文件的第89行。该行代码会将args.argsString参数附加到命令的末尾，而默认配置中缺少了这个参数的明确定义，导致调试时位置参数被错误地设置为"undefined"。

解决方案

正确的配置方法需要在dap的lua配置文件中显式地设置argsString参数为空字符串。以下是完整的配置示例：

dap.adapters.bashdb = {
    type = "executable",
    command = vim.fn.stdpath("data") .. "/mason/packages/bash-debug-adapter/bash-debug-adapter",
    name = "bashdb",
}

dap.configurations.sh = {
    {
        type = "bashdb",
        request = "launch",
        name = "Launch file",
        showDebugOutput = true,
        pathBashdb = vim.fn.stdpath("data") .. "/mason/packages/bash-debug-adapter/extension/bashdb_dir/bashdb",
        pathBashdbLib = vim.fn.stdpath("data") .. "/mason/packages/bash-debug-adapter/extension/bashdb_dir",
        trace = true,
        file = "${file}",
        program = "${file}",
        cwd = "${workspaceFolder}",
        pathCat = "cat",
        pathBash = "/bin/bash",
        pathMkfifo = "mkfifo",
        pathPkill = "pkill",
        args = {},
        argsString = '',  -- 关键修复：显式设置argsString为空字符串
        env = {},
        terminalKind = "integrated",
    },
}

配置详解

1. dap.adapters.bashdb：定义了bash调试适配器的基本信息

   • type：指定为可执行类型
   • command：指定bash-debug-adapter的可执行文件路径
   • name：调试适配器的名称

2. dap.configurations.sh：定义了bash脚本的调试配置

   • type：指定使用bashdb调试器
   • request：设置为launch表示启动调试会话
   • 各种路径配置：指向调试器所需的各个组件
   • argsString：关键参数，必须显式设置为空字符串以避免参数传递问题

验证方法

要验证修复是否生效，可以创建一个简单的测试脚本：

#!/bin/bash
echo "参数个数: $#"
echo "第一个参数: $1"

在修复前，运行此脚本会输出：

参数个数: 1
第一个参数: undefined

修复后，正确的输出应该是：

参数个数: 0
第一个参数: 

总结

这个问题的解决展示了调试配置细节的重要性。在nvim-dap中使用bash-debug-adapter时，必须注意argsString参数的显式设置，即使它需要为空值。这个经验也提醒我们，在使用任何调试工具时，都应该仔细检查其参数传递机制，确保脚本能够接收到预期的参数值。