chore(refactor): move debug_marks module out of core into debug folder

Author: MeanderingProgrammer

CHANGELOG.md

@@ -5,6 +5,8 @@
 ### Features
 
 - logging improvements [2b86631](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/2b86631c153e24682a1a2d05e37a0f4f94e9b827)
+- table min width [f84eeae](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/f84eeaebac278e26bd2906fd47747631716a5edb)
+- new debug API for development [6f87257](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/6f8725746ecadae0ae5ab3e7a1a445dad6b2e231)
 
 ### Bug Fixes
 

lua/render-markdown/api.lua

@@ -35,7 +35,7 @@ end
 function M.debug()
     local buf = vim.api.nvim_get_current_buf()
     local row, marks = require('render-markdown.core.ui').get_row_marks(buf)
-    require('render-markdown.core.debug_marks').debug(row, marks)
+    require('render-markdown.debug.marks').debug(row, marks)
 end
 
 return M

lua/render-markdown/core/node_info.lua

@@ -27,17 +27,15 @@ function NodeInfo.new(buf, node)
     return self
 end
 
----@param infos render.md.NodeInfo[]
----@return render.md.NodeInfo[]
-function NodeInfo.sort_inplace(infos)
-    table.sort(infos, function(a, b)
-        if a.start_row ~= b.start_row then
-            return a.start_row < b.start_row
-        else
-            return a.start_col < b.start_col
-        end
-    end)
-    return infos
+---@param a render.md.NodeInfo
+---@param b render.md.NodeInfo
+---@return boolean
+function NodeInfo.__lt(a, b)
+    if a.start_row ~= b.start_row then
+        return a.start_row < b.start_row
+    else
+        return a.start_col < b.start_col
+    end
 end
 
 ---@return boolean

lua/render-markdown/core/debug_marks.lua renamed to lua/render-markdown/debug/marks.lua

@@ -1,23 +1,23 @@
----@class render.md.DebugMark
+---@class render.md.debug.Mark
 ---@field conceal boolean
 ---@field opts vim.api.keyset.set_extmark
 ---@field row { [1]: integer, [2]: integer }
 ---@field col { [1]: integer, [2]: integer }
-local DebugMark = {}
-DebugMark.__index = DebugMark
+local Mark = {}
+Mark.__index = Mark
 
 ---@param mark render.md.Mark
----@return render.md.DebugMark
-function DebugMark.new(mark)
-    local self = setmetatable({}, DebugMark)
+---@return render.md.debug.Mark
+function Mark.new(mark)
+    local self = setmetatable({}, Mark)
     self.conceal, self.opts = mark.conceal, mark.opts
     self.row = { mark.start_row, mark.opts.end_row or mark.start_row }
     self.col = { mark.start_col, mark.opts.end_col or mark.start_col }
     return self
 end
 
 ---@return integer[]
-function DebugMark:priorities()
+function Mark:priorities()
     local row_offset = 0
     if self.opts.virt_lines ~= nil then
         row_offset = self.opts.virt_lines_above and -0.5 or 0.5
@@ -28,7 +28,7 @@ function DebugMark:priorities()
 end
 
 ---@return string
-function DebugMark:__tostring()
+function Mark:__tostring()
     ---@param text string
     ---@return string
     local function serialize_text(text)
@@ -119,10 +119,10 @@ function DebugMark:__tostring()
     return table.concat(lines, '\n')
 end
 
----@param a render.md.DebugMark
----@param b render.md.DebugMark
+---@param a render.md.debug.Mark
+---@param b render.md.debug.Mark
 ---@return boolean
-function DebugMark.__lt(a, b)
+function Mark.__lt(a, b)
     local as, bs = a:priorities(), b:priorities()
     for i = 1, math.max(#as, #bs) do
         if as[i] ~= bs[i] then
@@ -132,17 +132,17 @@ function DebugMark.__lt(a, b)
     return false
 end
 
----@class render.md.DebugMarks
+---@class render.md.debug.Marks
 local M = {}
 
 ---@param row integer
 ---@param marks render.md.Mark[]
 function M.debug(row, marks)
-    print('Decorations on row: ' .. row)
+    print(string.format('Decorations on row: %d', row))
     if #marks == 0 then
         print('No decorations found')
     end
-    local debug_marks = vim.tbl_map(DebugMark.new, marks)
+    local debug_marks = vim.tbl_map(Mark.new, marks)
     table.sort(debug_marks)
     for _, mark in ipairs(debug_marks) do
         print(mark)

lua/render-markdown/health.lua

@@ -4,7 +4,7 @@ local state = require('render-markdown.state')
 local M = {}
 
 ---@private
-M.version = '7.0.4'
+M.version = '7.0.5'
 
 function M.check()
     M.start('version')

lua/render-markdown/render/table.lua

@@ -70,7 +70,8 @@ function Render:setup()
     end
 
     local rows = {}
-    for _, table_row in ipairs(NodeInfo.sort_inplace(table_rows)) do
+    table.sort(table_rows)
+    for _, table_row in ipairs(table_rows) do
         local row = self:parse_row(table_row, #delim.columns)
         if row ~= nil then
             table.insert(rows, row)
@@ -169,7 +170,9 @@ function Render.parse_row_data(row, cell_type)
     if #pipes == 0 or #cells == 0 or #pipes ~= #cells + 1 then
         return nil, nil
     end
-    return NodeInfo.sort_inplace(pipes), NodeInfo.sort_inplace(cells)
+    table.sort(pipes)
+    table.sort(cells)
+    return pipes, cells
 end
 
 function Render:render()

tests/util.lua

@@ -28,8 +28,8 @@ function Row:increment(n)
 end
 
 ---@class render.md.MarkInfo
----@field row integer[]
----@field col integer[]
+---@field row { [1]: integer, [2]?: integer }
+---@field col { [1]: integer, [2]?: integer }
 ---@field hl_eol? boolean
 ---@field hl_group? string
 ---@field conceal? string
@@ -65,61 +65,37 @@ function MarkInfo.new(row, col, details)
     return self
 end
 
----@param a render.md.MarkInfo
----@param b render.md.MarkInfo
----@return boolean
-function MarkInfo.__lt(a, b)
-    ---@param getter fun(mark: render.md.MarkInfo): number[]
-    ---@return boolean?
-    local function compare_ints(getter)
-        local as, bs = getter(a), getter(b)
-        for i = 1, math.max(#as, #bs) do
-            local av, bv = as[math.min(i, #as)], bs[math.min(i, #bs)]
-            if av ~= bv then
-                return av < bv
-            end
-        end
-        return nil
-    end
+---@return integer[]
+function MarkInfo:priorities()
+    local result = {}
 
-    local row_comp = compare_ints(function(mark)
-        if mark.virt_lines == nil then
-            return mark.row
-        end
-        local offset = mark.virt_lines_above and -0.5 or 0.5
-        return vim.iter(mark.row)
-            :map(function(row)
-                return row + offset
-            end)
-            :totable()
-    end)
-    if row_comp ~= nil then
-        return row_comp
+    local row_offset = 0
+    if self.virt_lines ~= nil then
+        row_offset = self.virt_lines_above and -0.5 or 0.5
     end
+    vim.list_extend(result, { self.row[1] + row_offset, (self.row[2] or self.row[1]) + row_offset })
 
-    local col_comp = compare_ints(function(mark)
-        if mark.virt_text_win_col == nil then
-            return mark.col
-        else
-            return { mark.virt_text_win_col }
-        end
-    end)
-    if col_comp ~= nil then
-        return col_comp
-    end
+    local col = self.virt_text_win_col or 0
+    vim.list_extend(result, { math.max(self.col[1], col), math.max((self.col[2] or self.col[1]), col) })
 
-    -- Higher priority for inline text
-    local a_inline, b_inline = a.virt_text_pos == 'inline', b.virt_text_pos == 'inline'
-    if a_inline ~= b_inline then
-        return a_inline
-    end
+    vim.list_extend(result, {
+        self.virt_text_pos == 'inline' and 0 or 1, -- Inline text comes first
+        self.sign_text == nil and 0 or 1, -- Signs come later
+    })
 
-    -- Lower priority for signs
-    local a_sign, b_sign = a.sign_text ~= nil, b.sign_text ~= nil
-    if a_sign ~= b_sign then
-        return not a_sign
-    end
+    return result
+end
 
+---@param a render.md.MarkInfo
+---@param b render.md.MarkInfo
+---@return boolean
+function MarkInfo.__lt(a, b)
+    local as, bs = a:priorities(), b:priorities()
+    for i = 1, math.max(#as, #bs) do
+        if as[i] ~= bs[i] then
+            return as[i] < bs[i]
+        end
+    end
     return false
 end