feat(threads): custom formatting

Author: igorlfs

docs/sidebar.ts

@@ -57,6 +57,14 @@ export const sidebar = {
                     title: "Advanced 'switchbuf'",
                     to: '/advanced-switchbuf'
                 },
+                {
+                    title: 'Custom Formatting',
+                    to: '/custom-formatting'
+                },
+                {
+                    title: 'Custom Views',
+                    to: '/custom-views'
+                },
                 {
                     title: "Dynamic Layout",
                     to: '/dynamic-layout',
@@ -65,10 +73,6 @@ export const sidebar = {
                     title: 'Hide Terminal',
                     to: '/hide-terminal'
                 },
-                {
-                    title: 'Custom Views',
-                    to: '/custom-views'
-                },
                 {
                     title: 'Restoring Sessions',
                     to: '/restoring-sessions'

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

@@ -0,0 +1,49 @@
+---
+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).
+
+## Threads
+
+You can manipulate the frame _name_ (usually the function name), its line and path.
+
+### Examples
+
+#### Display just the file name, instead of relative path
+
+```lua
+return {
+    render = {
+        threads = {
+            format = function(name, line, path)
+                return {
+                    { part = name, separator = " " },
+                    -- See :h filename-modifiers
+                    { part = vim.fn.fnamemodify(buf_name, ":t"), hl = "FileName", separator = ":" },
+                    { part = line, hl = "LineNumber" },
+                }
+            end,
+        },
+    },
+}
+```
+
+#### Restore pre v1.0.0 behavior
+
+```lua
+return {
+    render = {
+        threads = {
+            format = function(name, line, path)
+                return {
+                    { part = path, hl = "FileName" },
+                    { part = line, hl = "LineNumber" },
+                    { part = name },
+                }
+            end,
+        },
+    },
+}
+```

lua/dap-view/config.lua

@@ -10,6 +10,11 @@ local M = {}
 
 ---@alias dapview.Position 'right' | 'left' | 'above' | 'below'
 
+---@class dapview.Content
+---@field part string
+---@field hl? string|boolean
+---@field separator? string
+
 ---@class dapview.TerminalConfig
 ---@field hide string[] List of adapters for which the terminal should be hidden
 ---@field position dapview.Position|fun(position: dapview.Position): dapview.Position Can be a function, receiving the main window's position as its argument
@@ -68,8 +73,12 @@ local M = {}
 ---@class dapview.HelpConfig
 ---@field border? string|string[] Override `winborder` in the help window
 
+---@class dapview.RenderThreadsConfig
+---@field format fun(name: string, line: 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
 
 ---@class (exact) dapview.ConfigStrict
 ---@field winbar dapview.WinbarConfig
@@ -175,6 +184,15 @@ M.config = {
     },
     render = {
         sort_variables = nil,
+        threads = {
+            format = function(name, line, path)
+                return {
+                    { part = name, separator = " " },
+                    { part = path, hl = "FileName", separator = ":" },
+                    { part = line, hl = "LineNumber" },
+                }
+            end,
+        },
     },
     switchbuf = "usetab,uselast",
     auto_toggle = false,

lua/dap-view/listeners.lua

@@ -1,7 +1,6 @@
 local dap = require("dap")
 
 local state = require("dap-view.state")
-local breakpoints = require("dap-view.breakpoints.view")
 local util = require("dap-view.util")
 local term = require("dap-view.console.view")
 local setup = require("dap-view.setup")

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

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

lua/dap-view/threads/view.lua

@@ -8,9 +8,15 @@ local setup = require("dap-view.setup")
 
 local M = {}
 
----@class dapview.Label
----@field labels {part: string, hl?: string}[]
----@field id string
+---@class dapview.Frame
+---@field path string
+---@field line string
+---@field name string
+---@field id number
+
+---@class dapview.FrameContent
+---@field content dapview.Content[]
+---@field id number
 
 M.show = function()
     -- We have to check if the win is valid, since this function may be triggered by an event when the window is closed
@@ -45,17 +51,18 @@ M.show = function()
         end
 
         local line = 0
+        local config = setup.config
 
         if state.threads_filter ~= "" then
-            local filter = setup.config.icons["filter"] .. " "
+            local filter = config.icons["filter"] .. " "
             local filter_icon_len = #filter
 
             filter = filter .. state.threads_filter
 
             local omit_icon_len = 0
 
             if state.threads_filter_invert then
-                local omit_icon = " " .. setup.config.icons["negate"]
+                local omit_icon = " " .. config.icons["negate"]
                 omit_icon_len = #omit_icon
                 filter = filter .. omit_icon
             end
@@ -75,13 +82,14 @@ M.show = function()
 
         for k, thread in pairs(session.threads) do
             local is_stopped_thread = session.stopped_thread_id == thread.id
-            local thread_name = is_stopped_thread and thread.name .. " " .. setup.config.icons["pause"] or thread.name
+            local thread_name = is_stopped_thread and thread.name .. " " .. config.icons["pause"] or thread.name
             util.set_lines(state.bufnr, line, line, true, { thread_name })
 
             hl.hl_range(is_stopped_thread and "ThreadStopped" or "Thread", { line, 0 }, { line, -1 })
 
             line = line + 1
 
+            ---@type dap.StackFrame[]
             local valid_frames = vim.iter(thread.frames or {})
                 :filter(
                     ---@param f dap.StackFrame
@@ -99,7 +107,7 @@ M.show = function()
                     line = line + 1
                 end
             else
-                ---@type dapview.Label[]
+                ---@type dapview.Frame[]
                 local frames = vim.iter(valid_frames):fold(
                     {},
                     ---@param acc string[]
@@ -116,25 +124,31 @@ M.show = function()
                             state.frame_line_by_frame_id[f.id] = f.line
 
                             table.insert(acc, {
-                                labels = {
-                                    { part = relative_path, hl = "FileName" },
-                                    { part = tostring(f.line), hl = "LineNumber" },
-                                    { part = f.name },
-                                },
+                                path = relative_path,
+                                line = tostring(f.line),
+                                name = f.name,
                                 id = f.id,
                             })
                         end
                         return acc
                     end
                 )
 
-                ---@type dapview.Label[]
-                local filtered_frames = vim.iter(frames)
+                local formated_frames = vim.iter(frames):map(
+                    ---@param frame dapview.Frame
+                    function(frame)
+                        local format = config.render.threads.format(frame.name, frame.line, frame.path)
+                        return { content = format, id = frame.id }
+                    end
+                )
+
+                ---@type dapview.FrameContent[]
+                local filtered_frames = formated_frames
                     :filter(
-                        ---@param f dapview.Label
+                        ---@param f dapview.FrameContent
                         function(f)
                             local label = ""
-                            for _, l in ipairs(f.labels) do
+                            for _, l in ipairs(f.content) do
                                 label = label .. l.part
                             end
                             local match = label:match(state.threads_filter)
@@ -147,13 +161,13 @@ M.show = function()
                 ---@type string[]
                 local content = vim.iter(filtered_frames)
                     :map(
-                        ---@param f dapview.Label
+                        ---@param f dapview.FrameContent
                         function(f)
                             local label = "\t"
-                            for n, l in ipairs(f.labels) do
+                            for n, l in ipairs(f.content) do
                                 label = label .. l.part
-                                if n ~= #f.labels then
-                                    label = label .. "|"
+                                if n ~= #f.content then
+                                    label = label .. (l.separator or "|")
                                 end
                             end
                             return label
@@ -170,10 +184,11 @@ M.show = function()
                         hl.hl_range("FrameCurrent", { actual_line, 0 }, { actual_line, -1 })
                     else
                         local hl_init = 1
-                        for _, p in ipairs(f.labels) do
+                        for _, p in ipairs(f.content) do
                             local hl_end = hl_init + #p.part
 
-                            if p.hl then
+                            if type(p.hl) == "string" then
+                                ---@cast p {hl: string}
                                 hl.hl_range(p.hl, { actual_line, hl_init }, { actual_line, hl_end })
                             end
 

lua/dap-view/types.lua

@@ -13,6 +13,9 @@
 ---@field base_sections? table<dapview.Section,dapview.SectionConfigPartial>
 ---@field controls? dapview.ControlsConfigPartial
 
+---@class dapview.RenderConfigPartial : dapview.RenderConfig, {}
+---@field threads? dapview.RenderThreadsConfig
+
 ---@class dapview.HelpConfigPartial : dapview.HelpConfig, {}
 
 ---@class dapview.RenderConfigPartial : dapview.RenderConfig, {}