chore: add more indent mode unit tests

MeanderingProgrammer · MeanderingProgrammer · commit 4d754be0734a · 2025-02-25T02:09:19.000-08:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,8 @@
   [6d446de](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/6d446de33937633bc2104f45c943f4fae632b822)
 - `autocommand` events and wiki link `body` customization [#228](https://github.com/MeanderingProgrammer/render-markdown.nvim/discussions/228)
   [#345](https://github.com/MeanderingProgrammer/render-markdown.nvim/pull/345) [0df6719](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/0df6719abc3b547bc5b7111a750d8d7e035a7234)
+- indent mode icon support [#343](https://github.com/MeanderingProgrammer/render-markdown.nvim/issues/343)
+  [21623a9](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/21623a9ded5a5f3d1fbd8626a69c174fbeb0543e)
 - use default `render_modes = true` (all) for LSP docs [#326](https://github.com/MeanderingProgrammer/render-markdown.nvim/issues/326)
   [17a7746](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/17a77463f945c4b9e4f371c752efd90e3e1bf604)
 - update troubleshooting doc [f6c9e18](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/f6c9e1841cf644a258eb037dae587e3cf407d696)
diff --git a/doc/render-markdown.txt b/doc/render-markdown.txt
@@ -1,4 +1,4 @@
-*render-markdown.txt*         For 0.10.0         Last change: 2025 February 24
+*render-markdown.txt*         For 0.10.0         Last change: 2025 February 25
 
 ==============================================================================
 Table of Contents                          *render-markdown-table-of-contents*
diff --git a/tests/indent_spec.lua b/tests/indent_spec.lua
@@ -2,20 +2,6 @@
 
 local util = require('tests.util')
 
----@param row integer
----@param level? integer
----@return render.md.MarkInfo
-local function indent(row, level)
-    ---@type render.md.MarkInfo
-    return {
-        row = { row },
-        col = { 0 },
-        virt_text = { { string.rep('  ', level or 1), 'Normal' } },
-        virt_text_pos = 'inline',
-        priority = 0,
-    }
-end
-
 ---@param row integer
 ---@param level integer
 ---@param position 'above'|'below'
@@ -45,28 +31,68 @@ local function border(row, level, position)
     }
 end
 
+---@param lengths integer[]
+---@return render.md.Line
+local function indent_line(lengths)
+    local result = {}
+    for _, length in ipairs(lengths) do
+        if length == 1 then
+            table.insert(result, { '▎', util.hl('Indent') })
+        else
+            table.insert(result, { string.rep(' ', length), 'Normal' })
+        end
+    end
+    return result
+end
+
+---@param row integer
+---@param lengths integer[]
+---@return render.md.MarkInfo
+local function indent(row, lengths)
+    ---@type render.md.MarkInfo
+    return {
+        row = { row },
+        col = { 0 },
+        virt_text = indent_line(lengths),
+        virt_text_pos = 'inline',
+        priority = 0,
+    }
+end
+
+---@param mark render.md.MarkInfo
+---@param lengths integer[]
+---@return render.md.MarkInfo
+local function indent_mark(mark, lengths)
+    local line = indent_line(lengths)
+    vim.list_extend(line, mark.virt_lines[1])
+    mark.virt_lines = { line }
+    return mark
+end
+
 describe('indent.md', function()
-    it('custom', function()
+    it('with heading border', function()
         util.setup('tests/data/indent.md', {
             heading = { border = true },
             indent = { enabled = true },
         })
 
         local expected, row = {}, util.row()
 
+        local l2, l3 = { 2 }, { 4 }
+
         vim.list_extend(expected, {
             border(row:get(), 2, 'above'),
-            indent(row:get()),
+            indent(row:get(), l2),
             util.heading(row:get(), 2),
-            indent(row:increment()),
+            indent(row:increment(), l2),
         })
         vim.list_extend(expected, {
-            util.table_border(row:increment(), true, { 5, 5 }, 2),
-            indent(row:get()),
+            indent_mark(util.table_border(row:increment(), true, { 5, 5 }), l2),
+            indent(row:get(), l2),
             util.table_pipe(row:get(), 0, true),
             util.table_pipe(row:get(), 6, true),
             util.table_pipe(row:get(), 12, true),
-            indent(row:increment()),
+            indent(row:increment(), l2),
             util.table_delimiter(row:get(), { 5, 5 }),
         })
 
@@ -77,14 +103,16 @@ describe('indent.md', function()
         })
 
         vim.list_extend(expected, {
-            indent(row:increment(2), 2),
+            indent(row:increment(2), l3),
             border(row:get(), 3, 'above'),
-            indent(row:increment(), 2),
+            indent(row:increment(), l3),
             util.heading(row:get(), 3),
-            indent(row:increment(), 2),
+            indent(row:increment(), l3),
             border(row:get(), 3, 'below'),
         })
-        table.insert(expected, indent(row:increment(), 2))
+        vim.list_extend(expected, {
+            indent(row:increment(), l3),
+        })
 
         util.assert_view(expected, {
             '󰫎   1    󰲣 Heading 2',
@@ -102,4 +130,69 @@ describe('indent.md', function()
             '   12     Bar',
         })
     end)
+
+    it('with per_level, skip_level & icon', function()
+        util.setup('tests/data/indent.md', {
+            indent = { enabled = true, per_level = 4, skip_level = 0, icon = '▎' },
+        })
+
+        local expected, row = {}, util.row()
+
+        local l1, l2 = { 1, 3 }, { 1, 3, 1, 3 }
+
+        vim.list_extend(expected, {
+            indent(row:get(), l2),
+            util.heading(row:get(), 2),
+            indent(row:increment(), l2),
+        })
+        vim.list_extend(expected, {
+            indent_mark(util.table_border(row:increment(), true, { 5, 5 }), l2),
+            indent(row:get(), l2),
+            util.table_pipe(row:get(), 0, true),
+            util.table_pipe(row:get(), 6, true),
+            util.table_pipe(row:get(), 12, true),
+            indent(row:increment(), l2),
+            util.table_delimiter(row:get(), { 5, 5 }),
+        })
+
+        vim.list_extend(expected, {
+            indent(row:increment(), l1),
+            indent(row:increment(), l1),
+            util.heading(row:get(), 1),
+            indent(row:increment(), l1),
+        })
+        vim.list_extend(expected, {
+            indent(row:increment(), l1),
+        })
+
+        vim.list_extend(expected, {
+            indent(row:increment(), l1),
+            indent(row:get(), l2),
+            indent(row:increment(), l1),
+            indent(row:get(), l2),
+            util.heading(row:get(), 3),
+            indent(row:increment(), l1),
+            indent(row:get(), l2),
+        })
+        vim.list_extend(expected, {
+            indent(row:increment(), l1),
+            indent(row:get(), l2),
+        })
+
+        util.assert_view(expected, {
+            '󰫎   1 ▎   ▎    󰲣 Heading 2',
+            '    2 ▎   ▎',
+            '      ▎   ▎   ┌─────┬─────┐',
+            '    3 ▎   ▎   │ Foo │ Bar │',
+            '    4 ▎   ▎   ├─────┼─────┤',
+            '    5 ▎',
+            '󰫎   6 ▎   󰲡 Heading 1',
+            '    7 ▎',
+            '    8 ▎   Foo',
+            '    9 ▎   ▎   ▎',
+            '󰫎  10 ▎   ▎   ▎     󰲥 Heading 3',
+            '   11 ▎   ▎   ▎',
+            '   12 ▎   ▎   ▎   Bar',
+        })
+    end)
 end)
diff --git a/tests/util.lua b/tests/util.lua
@@ -76,15 +76,24 @@ function MarkDetails:priorities()
     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 })
+    table.insert(result, self.row[1] + row_offset)
+    table.insert(result, (self.row[2] or self.row[1]) + row_offset)
 
     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) })
-
-    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
-    })
+    table.insert(result, math.max(self.col[1], col))
+    table.insert(result, math.max((self.col[2] or self.col[1]), col))
+
+    -- Inline text comes first
+    table.insert(result, self.virt_text_pos == 'inline' and 0 or 1)
+    -- Signs come later
+    table.insert(result, self.sign_text == nil and 0 or 1)
+
+    -- Fewer text entries comes first
+    local text = #(self.virt_text or {})
+    for _, line in ipairs(self.virt_lines or {}) do
+        text = text + #line
+    end
+    table.insert(result, text)
 
     return result
 end
@@ -375,16 +384,12 @@ end
 ---@param row integer
 ---@param above boolean
 ---@param lengths integer[]
----@param indent? integer
 ---@return render.md.MarkInfo
-function M.table_border(row, above, lengths, indent)
-    local line = {}
-    if indent ~= nil then
-        table.insert(line, { string.rep(' ', indent), 'Normal' })
-    end
+function M.table_border(row, above, lengths)
     local parts = vim.tbl_map(function(length)
         return string.rep('─', length)
     end, lengths)
+    local line = {}
     if above then
         table.insert(line, { '┌' .. table.concat(parts, '┬') .. '┐', M.hl('TableHead') })
     else

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-render-markdown.txt For 0.10.0 Last change: 2025 February 24`
	`1`	`+render-markdown.txt For 0.10.0 Last change: 2025 February 25`
`2`	`2`
`3`	`3`	`==============================================================================`
`4`	`4`	`Table of Contents render-markdown-table-of-contents`