Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/niuiic/dap-utils.nvim
Better use of nvim-dap
https://github.com/niuiic/dap-utils.nvim
Last synced: about 2 months ago
JSON representation
Better use of nvim-dap
- Host: GitHub
- URL: https://github.com/niuiic/dap-utils.nvim
- Owner: niuiic
- License: mit
- Created: 2023-07-12T00:33:48.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-11T04:36:12.000Z (4 months ago)
- Last Synced: 2024-05-11T05:27:55.316Z (4 months ago)
- Language: Lua
- Homepage:
- Size: 19.5 KB
- Stars: 33
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-neovim - niuiic/dap-utils - Utilities to provide a better experience for using nvim-dap. (Debugging / CSV Files)
README
# dap-utils.nvim
Utilities to provide a better experience for using `nvim-dap`.
[More neovim plugins](https://github.com/niuiic/awesome-neovim-plugins)
## Dependencies
- [niuiic/core.nvim](https://github.com/niuiic/core.nvim)
- [mfussenegger/nvim-dap](https://github.com/mfussenegger/nvim-dap)
- [rcarriga/nvim-dap-ui](https://github.com/rcarriga/nvim-dap-ui)
- [nvim-telescope/telescope.nvim](https://github.com/nvim-telescope/telescope.nvim)
## Usage
### continue
- Safely inject custom operations before start to debug.
- Replace the original `continue` with `require("dap-utils").continue()`, and start to debug with this function.
> Async functions or some ui operations may cause error if they are called in `program` function.
### store_breakpoints
- Store all breakpoints to a file.
- `require("dap-utils").store_breakpoints(file_path, root_pattern)`
- `root_pattern` is `.git` by default.
> Use it with a session manager, see [niuiic/multiple-session.nvim](https://github.com/niuiic/multiple-session.nvim).
### restore_breakpoints
- Restore all breakpoints from a file.
- `require("dap-utils").restore_breakpoints(file_path, root_pattern)`
- `root_pattern` is `.git` by default.
### search_breakpoints
- Search breakpoints with `telescope.nvim`.
- `require("dap-utils").search_breakpoints(opts)`
- `opts` is optional, it's same to telescope picker opts.
### toggle_breakpoints
- Enable/Disable all breakpoints.
- `require("dap-utils").toggle_breakpoints(root_pattern)`.
- Breakpoints disabled can be stored by `store_breakpoints`.
- `require("dap").clear_breakpoints()` cannot remove disabled breakpoints, use `require("dap-utils").clear_breakpoints()` instead.
### store_watches
- Store all watches to a file.
- `require("dap-utils").store_watches(file_path)`
### restore_watches
- Restore all watches from a file.
- `require("dap-utils").restore_watches(file_path)`
### remove_watches
- Remove all watches.
- `require("dap-utils").remove_watches()`
## Config
Here is an example to debug rust in a workspace.
```lua
require("dap-utils").setup({
-- filetype = function while returns dap config
rust = function(run)
-- nvim-dap start to work after call `run`
-- the arguments of `run` is same to `dap.run`, see :h dap-api.
local config = {
-- `name` is required for config
name = "Launch",
type = "lldb",
request = "launch",
program = nil,
cwd = "${workspaceFolder}",
stopOnEntry = false,
args = {},
}
local core = require("core")
vim.cmd("!cargo build")
local root_path = core.file.root_path()
local target_dir = root_path .. "/target/debug/"
if core.file.file_or_dir_exists(target_dir) then
local executable = {}
for path, path_type in vim.fs.dir(target_dir) do
if path_type == "file" then
local perm = vim.fn.getfperm(target_dir .. path)
if string.match(perm, "x", 3) then
table.insert(executable, path)
end
end
end
if #executable == 1 then
config.program = target_dir .. executable[1]
run(config)
else
vim.ui.select(executable, { prompt = "Select executable" }, function(choice)
if not choice then
return
end
config.program = target_dir .. choice
run(config)
end)
end
else
vim.ui.input({ prompt = "Path to executable: ", default = root_path .. "/target/debug/" }, function(input)
config.program = input
run(config)
end)
end
end,
})
```
You can also pass multiple configurations into `run`.
```lua
require("dap-utils").setup({
javascript = function(run)
local core = require("core")
run({
{
name = "Launch project",
type = "pwa-node",
request = "launch",
cwd = "${workspaceFolder}",
runtimeExecutable = "pnpm",
runtimeArgs = {
"debug",
},
},
{
name = "Launch cmd",
type = "pwa-node",
request = "launch",
cwd = core.file.root_path(),
runtimeExecutable = "pnpm",
runtimeArgs = {
"debug:cmd",
},
},
{
name = "Launch file",
type = "pwa-node",
request = "launch",
program = "${file}",
cwd = "${workspaceFolder}",
},
{
name = "Attach",
type = "pwa-node",
request = "attach",
processId = require("dap.utils").pick_process,
cwd = "${workspaceFolder}",
},
})
end,
})
```