Help creating PR for local-lua-debugger-vscode

[cprn]

Hi,

The local-lua-debugger-vscode entry is the only DAP available for Lua via Mason, but neither Mason nor this repository provide config for it, so I wanted to send a PR.

So far I've figured something like this starts the love project with 1 issue:

dap = require('dap')

dap.adapters.llua = {
    type = "executable",
    command = "node",
    args = {
        vim.fn.expand('$MASON/share/local-lua-debugger-vscode/extension/debugAdapter.js') -- different on Windows (?)
    }
}

dap.configurations.lua = {
    {
        name = "Local Lua Debugger: Run Love Project",
        type = "llua",
        request = 'launch',
        cwd = "${workspaceFolder}",
        project = "${workspaceFolder}",
        program = { command = "love" },
        args = { "." },
    },
}

The issue is that the user has to know to require('lldebugger').start() at the beginning of the debugged project, and what's even worse, that lldebugger provided by local-lua-debugger-vscode is in a path that a debugged process can't really know about. It's not uncommon for debuggers to require some extra steps - e.g. PHP requires the user to modify their php.ini to inject Xdebug hooks - so I'm guessing currently it's expected that the user makes their own research.

outdated part - skip unless relevant

It'd be cool, though, if it was somehow solved by whatever provides the default config, though.

Any thoughts on how (or where) to solve this?

So far, I've figured the default Mason DAP config for this debugger could come with a script like so:

-- lldebug.lua

local home = os.getenv("HOME") or os.getenv("USERPROFILE") -- USERPROFILE is used on Windows

local debugger_path
if package.config:sub(1,1) == '\\' then -- Windows
    debugger_path = home .. "\\AppData\\Local\\nvim\\mason\\share\\local-lua-debugger-vscode\\debugger\\?.lua"
else                                    -- Linux
    debugger_path = home .. "/.local/share/nvim/mason/share/local-lua-debugger-vscode/debugger/?.lua"
end

package.path = package.path .. ";" .. debugger_path

if os.getenv("LOCAL_LUA_DEBUGGER_VSCODE") == "1" then
    local ok, lldebugger = pcall(require, "lldebugger")
    if ok and lldebugger and lldebugger.start then
        lldebugger.start()
    end
end

Then all the user has to do is copy (or link) that script into their project and add require('lldebug') in their main.lua. But ideally it'd just "magically happen" with zero effort from the user. Or at least the user was somehow informed they have to do extra steps.

I asked on nvim-dap's discussions as well.

Cheers,
Cy

[cprn]

Guys from nvim-dap gave me a solution for that ugly script in the "outdated part":

dap.configurations.lua.extensionPath = vim.fn.expand('$MASON/share/local-lua-debugger-vscode/'),

This way, when a process is started by nvim-dap, the path to lldebugger package is known.

It still doesn't solve the necessity to call .start() at the beginning of main.lua in every debugged project that's run by external binary. When scripts are read directly by Lua interpreter, the debugger injects this call as an arbitrary code with lua -e ..., but it's not possible when debugging something like Love2D. So I guess it just has to stay in the user's competence.

On the bright side, default config could provide the option to debug Love2D projects only when it finds the love executable. 🤔

[cprn]

I'll try to send a PR within the next week, before I forget what's what and why.

[cprn]

There's not enough interest from Love2D community. Closing this.