feat(breakpoints): custom formatting

Author: igorlfs

docs/src/routes/custom-formatting/+page.md

@@ -3,7 +3,7 @@ title: Custom Formatting
 category: Recipes
 ---
 
-You can control how the text is displayed for some views, using special `format` functions. Each customizable view has its own parameters, but the expected return type is the same: an array of `{part: string, hl?: string}`. The `part` is the "content" itself, and `hl` is one of `nvim-dap-view`'s [highlight groups](./highlight-groups) (without the `NvimDapView` prefix).
+You can control how the text is displayed for some views, using special `format` functions. Each customizable view has its own parameters, but the expected return type is the same: an array of `{part: string, hl?: string, separator?: string}`. The `part` is the "content" itself, `hl` is one of `nvim-dap-view`'s [highlight groups](./highlight-groups) (without the `NvimDapView` prefix) and the separator can be used to customize the divider between the current part and the next one.
 
 ## Threads
 
@@ -47,3 +47,25 @@ return {
     },
 }
 ```
+
+## Breakpoints
+
+Besides the path (and line number) to the breakpoint, one can also manipulate the content of the line itself. It can be highlighted with treesitter by using the specifying `hl` as `true`.
+
+### Example
+
+```lua
+return {
+    render = {
+        breakpoints = {
+            -- The line number HATER
+            format = function(line, _, path)
+                return {
+                    { part = path, hl = "FileName" },
+                    { part = line, hl = true },
+                }
+            end,
+        },
+    },
+}
+```

lua/dap-view/breakpoints/view.lua

@@ -2,12 +2,18 @@ local state = require("dap-view.state")
 local vendor = require("dap-view.breakpoints.vendor")
 local extmarks = require("dap-view.breakpoints.util.extmarks")
 local treesitter = require("dap-view.breakpoints.util.treesitter")
+local setup = require("dap-view.setup")
 local views = require("dap-view.views")
 local util = require("dap-view.util")
 local hl = require("dap-view.util.hl")
 
 local M = {}
 
+---@class dapview.Breakpoint
+---@field path string
+---@field lnum string
+---@field line string
+
 local api = vim.api
 
 M.show = function()
@@ -37,11 +43,7 @@ M.show = function()
                 local buf_lines = api.nvim_buf_get_lines(buf, entry.lnum - 1, entry.lnum, true)
                 local text = table.concat(buf_lines, "\n")
 
-                local parts = {
-                    { part = relative_path, hl = "FileName" },
-                    { part = tostring(entry.lnum), hl = "LineNumber" },
-                    { part = text, hl = true },
-                }
+                local parts = setup.config.render.breakpoints.format(text, tostring(entry.lnum), relative_path)
 
                 table.insert(state.breakpoint_paths_by_line, relative_path)
                 table.insert(state.breakpoint_lines_by_line, entry.lnum)
@@ -62,6 +64,7 @@ M.show = function()
                         local hl_end = hl_init + #p.part
 
                         if type(p.hl) == "string" then
+                            ---@cast p {hl: string}
                             hl.hl_range(p.hl, { line, hl_init }, { line, hl_end })
                         else
                             treesitter.copy_highlights(buf, entry.lnum - 1, line, hl_init)

lua/dap-view/config.lua

@@ -73,12 +73,16 @@ local M = {}
 ---@class dapview.HelpConfig
 ---@field border? string|string[] Override `winborder` in the help window
 
+---@class dapview.RenderBreakpointsConfig
+---@field format fun(line: string, lnum: string, path: string): dapview.Content[]
+
 ---@class dapview.RenderThreadsConfig
 ---@field format fun(name: string, lnum: string, path: string): dapview.Content[]
 
 ---@class dapview.RenderConfig
 ---@field sort_variables? fun(lhs: dap.Variable, rhs: dap.Variable): boolean Override order of variables
 ---@field threads dapview.RenderThreadsConfig
+---@field breakpoints dapview.RenderBreakpointsConfig
 
 ---@class (exact) dapview.ConfigStrict
 ---@field winbar dapview.WinbarConfig
@@ -193,6 +197,15 @@ M.config = {
                 }
             end,
         },
+        breakpoints = {
+            format = function(line, lnum, path)
+                return {
+                    { part = path, hl = "FileName" },
+                    { part = lnum, hl = "LineNumber" },
+                    { part = line, hl = true },
+                }
+            end,
+        },
     },
     switchbuf = "usetab,uselast",
     auto_toggle = false,

lua/dap-view/setup/validate/render.lua

@@ -7,12 +7,18 @@ function M.validate(config)
     validate("render", {
         sort_variables = { config.sort_variables, { "function", "nil" } },
         threads = { config.threads, { "table" } },
+        breakpoints = { config.breakpoints, { "table" } },
     }, config)
 
     local threads = config.threads
     validate("render.threads", {
         format = { threads.format, { "function" } },
     }, threads)
+
+    local breakpoints = config.breakpoints
+    validate("render.breakpoints", {
+        format = { breakpoints.format, { "function" } },
+    }, breakpoints)
 end
 
 return M

lua/dap-view/types.lua

@@ -13,10 +13,13 @@
 ---@field base_sections? table<dapview.Section,dapview.SectionConfigPartial>
 ---@field controls? dapview.ControlsConfigPartial
 
+---@class dapview.RenderBreakpointsConfigPartial : dapview.RenderBreakpointsConfig, {}
+
 ---@class dapview.RenderThreadsConfigPartial : dapview.RenderThreadsConfig, {}
 
 ---@class dapview.RenderConfigPartial : dapview.RenderConfig, {}
 ---@field threads? dapview.RenderThreadsConfigPartial
+---@field breakpoints? dapview.RenderBreakpointsConfigPartial
 
 ---@class dapview.HelpConfigPartial : dapview.HelpConfig, {}