Add way to provide extra initCommands

[gollth]

Hello,

first of all thanks for this great plugin, it's my daily driver for a long time one 🙏

I have a particular feature that I'm lacking or don't know how to achieve in rustaceanvim when it comes to debugging: I have a custom lldb init script in my repo (which adds some custom formatters) which I want to apply to every debuggable target there is (executables, nvim-dap targets & neotest debug targets), when using the codelldb adapter.

AFAIK I can only provide initCommands in the .vscode/launch.json, which works for executables, but not for the tests, right?

My idea was let the user configure an optional command in its config, which gets appended to all other init commands of all targets. My user config now looks like this:

  {
    "mrcjkb/rustaceanvim",
    dependencies = { "mfussenegger/nvim-dap" },
    version = "^5",
    lazy = false,
    ft = { "rust" },
    opts = {
      dap = {
        autoload_configurations = true,
        init_commands = "command script import ./lldb/fleet.py",
      },
    }
    -- other config...
}

Maybe there is another already built in way how to solve this, comments very welcome (=

[github-actions]

Review Checklist

Does this PR follow the Contribution Guidelines? Following is a partial checklist:

Proper conventional commit scoping:

• For example, fix(lsp): some lsp-related bugfix

• Pull request title has the appropriate conventional commit prefix.

If applicable:

• Tested
  • Tests have been added.
  • Tested manually (Steps to reproduce in PR description).
• Updated documentation.

[mrcjkb]

Hey 👋

Thanks for the PR.
Is something like this supported by the rust-analyzer VSCode plugin or by rust-analyzer?
If not, I'd prefer it be requested there first.

Adding it to the rustaceanvim config feels quite hacky. I'd potentially be open to a more general solution, in which rustaceanvim doesn't have to be concerned with which extra fields are added to the DAP configurations.

[gollth]

Hey there, sorry for the late reply, was quite busy with work.

I wouldn't know of any way to configure this with codelldb but am really no expert here. Do you have a pointer how to research this?

[mrcjkb]

No worries, I'm not in a rush 😄

Do you have a pointer how to research this?

I stopped using debuggers years ago, and only carried over the DAP features from rust-tools.nvim.
But I just had another look at this PR. It looks like what you're trying to achieve is already possible with the dap.configuration.initCommands option:

vim.g.rustaceanvim = {
  dap = {
    configuration = {
      -- ...
      initCommands = {
        "command script import ./lldb/fleet.py",
        -- ...
      },
    },
  },
}

See :h rustaceanvim.dap.client.Config.

[gollth]

I tried your suggestion, but this fails for me:

Error executing vim.schedule lua callback: ...al/share/nvim/lazy/rustaceanvim/lua/rustaceanvim/dap.lua:372: attempt to concatenate field 'type' (a nil value)
stack traceback:
	...al/share/nvim/lazy/rustaceanvim/lua/rustaceanvim/dap.lua:372: in function <...al/share/nvim/lazy/rustaceanvim/lua/rustaceanvim/dap.lua:311>

[mrcjkb]

I tried your suggestion, but this fails for me:

Error executing vim.schedule lua callback: ...al/share/nvim/lazy/rustaceanvim/lua/rustaceanvim/dap.lua:372: attempt to concatenate field 'type' (a nil value)
stack traceback:
	...al/share/nvim/lazy/rustaceanvim/lua/rustaceanvim/dap.lua:372: in function <...al/share/nvim/lazy/rustaceanvim/lua/rustaceanvim/dap.lua:311>

You need to set all non-optional fields in the :h rustaceanvim.dap.client.Config type when overriding the default dap.configuration.

Example:

vim.g.rustaceanvim = {
  dap = {
    configuration = {
      name = "Rust debug adapter",
      type = "lldb", -- or "codelldb",
      request = "launch",
      initCommands = {
        "command script import ./lldb/fleet.py",
        -- ...
      },
      stopOnEntry = false,
    },
  },
}