chore(testing): add equals highlight to custom handler test

Author: MeanderingProgrammer

doc/custom-handlers.md

@@ -19,8 +19,8 @@ Each handler must conform to the following interface:
 ---@field public opts vim.api.keyset.set_extmark
 
 ---@class (exact) render.md.Handler
----@field public parse fun(root: TSNode, buf: integer): render.md.Mark[]
 ---@field public extends? boolean
+---@field public parse fun(root: TSNode, buf: integer): render.md.Mark[]
 ```
 
 The `parse` function parameters are:

doc/render-markdown.txt

@@ -1,4 +1,4 @@
-*render-markdown.txt*         For 0.10.0        Last change: 2024 September 19
+*render-markdown.txt*         For 0.10.0        Last change: 2024 September 20
 
 ==============================================================================
 Table of Contents                          *render-markdown-table-of-contents*

lua/render-markdown/init.lua

@@ -8,8 +8,8 @@ local M = {}
 ---@field public opts vim.api.keyset.set_extmark
 
 ---@class (exact) render.md.Handler
----@field public parse fun(root: TSNode, buf: integer): render.md.Mark[]
 ---@field public extends? boolean
+---@field public parse fun(root: TSNode, buf: integer): render.md.Mark[]
 
 ---@class (exact) render.md.UserLatex
 ---@field public enabled? boolean

tests/custom_handler_spec.lua

@@ -5,39 +5,92 @@ local util = require('tests.util')
 ---@param root TSNode
 ---@param buf integer
 ---@return render.md.Mark[]
-local function parse_conceal_escape(root, buf)
-    local marks = {}
-    local query = vim.treesitter.query.parse('markdown_inline', '(backslash_escape) @escape')
+local function conceal_escape(root, buf)
+    local marks, query = {}, vim.treesitter.query.parse('markdown_inline', '(backslash_escape) @escape')
     for _, node in query:iter_captures(root, buf) do
         local start_row, start_col, end_row, _ = node:range()
-        ---@type render.md.Mark
-        local mark = {
+        table.insert(marks, {
             conceal = true,
             start_row = start_row,
             start_col = start_col,
-            opts = {
-                end_row = end_row,
-                end_col = start_col + 1,
-                conceal = '',
-            },
-        }
-        table.insert(marks, mark)
+            opts = { end_row = end_row, end_col = start_col + 1, conceal = '' },
+        })
+    end
+    return marks
+end
+
+---@param root TSNode
+---@param buf integer
+---@return render.md.Mark[]
+local function highlight_equal(root, buf)
+    local marks = {}
+
+    ---@param row integer
+    ---@param start_col integer
+    ---@param end_col integer
+    ---@param conceal? string
+    ---@param hl_group? string
+    local function append(row, start_col, end_col, conceal, hl_group)
+        table.insert(marks, {
+            conceal = true,
+            start_row = row,
+            start_col = start_col,
+            opts = { end_row = row, end_col = end_col, conceal = conceal, hl_group = hl_group },
+        })
+    end
+
+    local start_row = root:range()
+    local text = vim.treesitter.get_node_text(root, buf)
+    for i, line in ipairs(vim.split(text, '\n', { plain = true })) do
+        local row = start_row + i - 1
+        ---@type integer|nil
+        local position = 1
+        while position ~= nil do
+            local start_col, end_col = line:find('(=)=[^=]+=(=)', position)
+            if start_col ~= nil and end_col ~= nil then
+                -- Translate 1 based index to 0 based index, update position
+                start_col, position = start_col - 1, end_col + 1
+                -- Hide first 2 equal signs
+                append(row, start_col, start_col + 2, '', nil)
+                -- Highlight contents
+                append(row, start_col, end_col, nil, 'DiffDelete')
+                -- Hide last 2 equal signs
+                append(row, end_col - 2, end_col, '', nil)
+            else
+                position = nil
+            end
+        end
     end
     return marks
 end
 
 ---@param row integer
----@param col integer
+---@param start_col integer
+---@param end_col integer
 ---@return render.md.MarkInfo
-local function backslash(row, col)
+local function conceal(row, start_col, end_col)
     ---@type render.md.MarkInfo
     return {
         row = { row, row },
-        col = { col, col + 1 },
+        col = { start_col, end_col },
         conceal = '',
     }
 end
 
+---@param row integer
+---@param start_col integer
+---@param end_col integer
+---@return render.md.MarkInfo
+local function highlight(row, start_col, end_col)
+    ---@type render.md.MarkInfo
+    return {
+        row = { row, row },
+        col = { start_col, end_col },
+        hl_eol = false,
+        hl_group = 'DiffDelete',
+    }
+end
+
 describe('custom_handler.md', function()
     it('default', function()
         util.setup('tests/data/custom_handler.md')
@@ -53,41 +106,56 @@ describe('custom_handler.md', function()
         util.marks_are_equal(expected, actual)
     end)
 
-    it('custom parse override', function()
+    it('custom conceal override', function()
         util.setup('tests/data/custom_handler.md', {
             custom_handlers = {
-                markdown_inline = {
-                    parse = parse_conceal_escape,
-                },
+                markdown_inline = { parse = conceal_escape },
             },
         })
 
         local expected, row = {}, util.row()
         vim.list_extend(expected, {
             util.heading(row:get(), 1), -- Heading
             {}, -- No inline code
-            { backslash(row:increment(4), 0), backslash(row:get(), 7) }, -- Backslash escapes
+            { conceal(row:increment(4), 0, 1), conceal(row:get(), 7, 8) }, -- Backslash escapes
+        })
+
+        local actual = util.get_actual_marks()
+        util.marks_are_equal(expected, actual)
+    end)
+
+    it('custom conceal extend', function()
+        util.setup('tests/data/custom_handler.md', {
+            custom_handlers = {
+                markdown_inline = { extends = true, parse = conceal_escape },
+            },
+        })
+
+        local expected, row = {}, util.row()
+        vim.list_extend(expected, {
+            util.heading(row:get(), 1), -- Heading
+            util.inline_code(row:increment(2), 0, 8), -- Inline code
+            { conceal(row:increment(2), 0, 1), conceal(row:get(), 7, 8) }, -- Backslash escapes
         })
 
         local actual = util.get_actual_marks()
         util.marks_are_equal(expected, actual)
     end)
 
-    it('custom parse extend', function()
+    it('custom highlight extend', function()
         util.setup('tests/data/custom_handler.md', {
             custom_handlers = {
-                markdown_inline = {
-                    parse = parse_conceal_escape,
-                    extends = true,
-                },
+                markdown = { extends = true, parse = highlight_equal },
+                markdown_inline = { extends = true, parse = conceal_escape },
             },
         })
 
         local expected, row = {}, util.row()
         vim.list_extend(expected, {
             util.heading(row:get(), 1), -- Heading
             util.inline_code(row:increment(2), 0, 8), -- Inline code
-            { backslash(row:increment(2), 0), backslash(row:get(), 7) }, -- Backslash escapes
+            { conceal(row:increment(2), 0, 1), conceal(row:get(), 7, 8) }, -- Backslash escapes
+            { conceal(row:increment(2), 5, 7), highlight(row:get(), 5, 25), conceal(row:get(), 23, 25) }, -- Highlight equals
         })
 
         local actual = util.get_actual_marks()

tests/data/custom_handler.md

@@ -3,3 +3,5 @@
 `Inline` code
 
 \$1.50 \$3.55
+
+Some ==highlighted text== line