Add cell_style overlay / raw options

resolves: #40

## Details

Previously tables were always overlayed with text to keep the rendered
look the same between mode changes.

A couple of feature requests have come up to allow the underlying table
highlights / conceals to still be visible.

The cell_style 'overlay', which is the default value should result in
no change to the rendering logic.

The other option of 'raw' will overlay only the pipe icons rather than
entire rows, allowing concealing and highlighting to still be visible.

Other changes made around this are largely refactors:

- Split unit tests into separate files, each file itself tests the
  rendering for a single file. Add a test utility module.
- Split rendering into `render` and `render_node` methods to allow
  early returns when useful.
- Move various methods in `handler/markdown.lua` into new `ts.lua`
  module to contain helpers for interacting with treesitter.

Author: MeanderingProgrammer

README.md

@@ -176,6 +176,10 @@ require('render-markdown').setup({
     --  normal: renders the rows of tables
     --  none: disables rendering, use this if you prefer having cell highlights
     table_style = 'full',
+    -- Determines how table cells are rendered
+    --  overlay: writes over the top of cells removing conealing and highlighting
+    --  raw: will leave the cells as they and only replace table related symbols
+    cell_style = 'overlay',
     -- Mapping from treesitter language to user defined handlers
     -- See 'Custom Handlers' section for more info
     custom_handlers = {},

doc/render-markdown.txt

@@ -1,4 +1,4 @@
-*render-markdown.txt*           For 0.10.0           Last change: 2024 June 13
+*render-markdown.txt*           For 0.10.0           Last change: 2024 June 17
 
 ==============================================================================
 Table of Contents                          *render-markdown-table-of-contents*
@@ -213,6 +213,10 @@ modified by the user.
         --  normal: renders the rows of tables
         --  none: disables rendering, use this if you prefer having cell highlights
         table_style = 'full',
+        -- Determines how table cells are rendered
+        --  overlay: writes over the top of cells removing conealing and highlighting
+        --  raw: will leave the cells as they and only replace table related symbols
+        cell_style = 'overlay',
         -- Mapping from treesitter language to user defined handlers
         -- See 'Custom Handlers' section for more info
         custom_handlers = {},

lua/render-markdown/handler/latex.lua

@@ -18,12 +18,20 @@ M.render = function(namespace, root, buf)
     local converter = state.config.latex_converter
     if vim.fn.executable(converter) ~= 1 then
         logger.debug('Executable not found: ' .. converter)
-        return
+    else
+        logger.debug_node('latex', root, buf)
+        M.render_node(namespace, buf, root, converter)
     end
+end
 
-    local value = vim.treesitter.get_node_text(root, buf)
-    local start_row, start_col, end_row, end_col = root:range()
-    logger.debug_node('latex', root, buf)
+---@param namespace integer
+---@param buf integer
+---@param node TSNode
+---@param converter string
+M.render_node = function(namespace, buf, node, converter)
+    local highlights = state.config.highlights
+    local value = vim.treesitter.get_node_text(node, buf)
+    local start_row, start_col, end_row, end_col = node:range()
 
     local expressions = cache.expressions[value]
     if expressions == nil then
@@ -34,7 +42,7 @@ M.render = function(namespace, root, buf)
     end
 
     local latex_lines = vim.tbl_map(function(expression)
-        return { { expression, state.config.highlights.latex } }
+        return { { expression, highlights.latex } }
     end, expressions)
     vim.api.nvim_buf_set_extmark(buf, namespace, start_row, start_col, {
         end_row = end_row,

lua/render-markdown/handler/markdown.lua

@@ -8,34 +8,42 @@ local M = {}
 ---@param root TSNode
 ---@param buf integer
 M.render = function(namespace, root, buf)
-    local highlights = state.config.highlights
     for id, node in state.inline_query:iter_captures(root, buf) do
         local capture = state.inline_query.captures[id]
-        local value = vim.treesitter.get_node_text(node, buf)
-        local start_row, start_col, end_row, end_col = node:range()
         logger.debug_node(capture, node, buf)
+        M.render_node(namespace, buf, capture, node)
+    end
+end
+
+---@param namespace integer
+---@param buf integer
+---@param capture string
+---@param node TSNode
+M.render_node = function(namespace, buf, capture, node)
+    local highlights = state.config.highlights
+    local value = vim.treesitter.get_node_text(node, buf)
+    local start_row, start_col, end_row, end_col = node:range()
 
-        if capture == 'code' then
+    if capture == 'code' then
+        vim.api.nvim_buf_set_extmark(buf, namespace, start_row, start_col, {
+            end_row = end_row,
+            end_col = end_col,
+            hl_group = highlights.code,
+        })
+    elseif capture == 'callout' then
+        local key = callout.get_key_exact(value)
+        if key ~= nil then
+            local callout_text = { state.config.callout[key], highlights.callout[key] }
             vim.api.nvim_buf_set_extmark(buf, namespace, start_row, start_col, {
                 end_row = end_row,
                 end_col = end_col,
-                hl_group = highlights.code,
+                virt_text = { callout_text },
+                virt_text_pos = 'overlay',
             })
-        elseif capture == 'callout' then
-            local key = callout.get_key_exact(value)
-            if key ~= nil then
-                local callout_text = { state.config.callout[key], highlights.callout[key] }
-                vim.api.nvim_buf_set_extmark(buf, namespace, start_row, start_col, {
-                    end_row = end_row,
-                    end_col = end_col,
-                    virt_text = { callout_text },
-                    virt_text_pos = 'overlay',
-                })
-            end
-        else
-            -- Should only get here if user provides custom capture, currently unhandled
-            logger.error('Unhandled inline capture: ' .. capture)
         end
+    else
+        -- Should only get here if user provides custom capture, currently unhandled
+        logger.error('Unhandled inline capture: ' .. capture)
     end
 end
 

lua/render-markdown/handler/markdown_inline.lua

@@ -63,6 +63,7 @@ local M = {}
 ---@field public callout? render.md.UserCallout
 ---@field public win_options? table<string, render.md.WindowOption>
 ---@field public table_style? 'full'|'normal'|'none'
+---@field public cell_style? 'overlay'|'raw'
 ---@field public custom_handlers? table<string, render.md.Handler>
 ---@field public highlights? render.md.UserHighlights
 
@@ -167,6 +168,10 @@ M.default_config = {
     --  normal: renders the rows of tables
     --  none: disables rendering, use this if you prefer having cell highlights
     table_style = 'full',
+    -- Determines how table cells are rendered
+    --  overlay: writes over the top of cells removing conealing and highlighting
+    --  raw: will leave the cells as they and only replace table related symbols
+    cell_style = 'overlay',
     -- Mapping from treesitter language to user defined handlers
     -- See 'Custom Handlers' section for more info
     custom_handlers = {},

lua/render-markdown/init.lua

@@ -0,0 +1,85 @@
+local M = {}
+
+---@param node TSNode
+---@param targets string[]
+---@return boolean
+M.is_sibling = function(node, targets)
+    local sibling = node:next_sibling()
+    if sibling == nil then
+        return false
+    end
+    return vim.tbl_contains(targets, sibling:type())
+end
+
+--- Walk through all parent nodes and count the number of list nodes
+---@param node TSNode
+---@return integer
+M.get_list_level = function(node)
+    local level = 0
+    local parent = node:parent()
+    while parent ~= nil do
+        local parent_type = parent:type()
+        if vim.tbl_contains({ 'section', 'document' }, parent_type) then
+            -- reaching a section or document means we are clearly at the top of the list
+            break
+        elseif parent_type == 'list' then
+            -- found a list increase the level and continue
+            level = level + 1
+        end
+        parent = parent:parent()
+    end
+    return level
+end
+
+--- Walk through parent nodes until target, return first found
+---@param node TSNode
+---@param target string
+---@return TSNode?
+M.get_parent = function(node, target)
+    local parent = node:parent()
+    while parent ~= nil do
+        local parent_type = parent:type()
+        if vim.tbl_contains({ 'section', 'document' }, parent_type) then
+            -- reaching a section or document means we are clearly outside our target
+            break
+        elseif parent_type == target then
+            return parent
+        end
+        parent = parent:parent()
+    end
+    return nil
+end
+
+---@param node TSNode
+---@param target string
+---@return TSNode?
+M.get_child = function(node, target)
+    for child in node:iter_children() do
+        if child:type() == target then
+            return child
+        end
+    end
+    return nil
+end
+
+---@param buf integer
+---@param row integer
+---@param s string
+---@return integer
+M.concealed = function(buf, row, s)
+    local result = 0
+    local col = 0
+    for _, index in ipairs(vim.fn.str2list(s)) do
+        local ch = vim.fn.nr2char(index)
+        local captures = vim.treesitter.get_captures_at_pos(buf, row, col)
+        for _, capture in ipairs(captures) do
+            if capture.metadata.conceal ~= nil then
+                result = result + vim.fn.strdisplaywidth(ch)
+            end
+        end
+        col = col + #ch
+    end
+    return result
+end
+
+return M

lua/render-markdown/ts.lua

@@ -50,5 +50,6 @@
 ---@field public callout render.md.Callout
 ---@field public win_options table<string, render.md.WindowOption>
 ---@field public table_style 'full'|'normal'|'none'
+---@field public cell_style 'overlay'|'raw'
 ---@field public custom_handlers table<string, render.md.Handler>
 ---@field public highlights render.md.Highlights

lua/render-markdown/types.lua

@@ -0,0 +1,81 @@
+local async_tests = require('plenary.async.tests')
+local util = require('tests.util')
+
+async_tests.describe('box_dash_quote.md', function()
+    async_tests.it('default', function()
+        util.setup('demo/box_dash_quote.md')
+
+        local expected = {}
+
+        -- Heading
+        vim.list_extend(expected, {
+            {
+                row = { 0, 1 },
+                col = { 0, 0 },
+                hl_eol = true,
+                hl_group = 'DiffAdd',
+                virt_text = { { '󰲡 ', { 'markdownH1', 'DiffAdd' } } },
+                virt_text_pos = 'overlay',
+            },
+        })
+
+        -- Checkboxes
+        vim.list_extend(expected, {
+            -- Unchecked, conceal list marker
+            {
+                row = { 2, 2 },
+                col = { 0, 2 },
+                conceal = '',
+            },
+            -- Unchecked, checkbox
+            {
+                row = { 2, 2 },
+                col = { 2, 5 },
+                virt_text = { { ' 󰄱 ', '@markup.list.unchecked' } },
+                virt_text_pos = 'overlay',
+            },
+            -- Checked, conceal list marker
+            {
+                row = { 3, 3 },
+                col = { 0, 2 },
+                conceal = '',
+            },
+            -- Checked, checkbox
+            {
+                row = { 3, 3 },
+                col = { 2, 5 },
+                virt_text = { { ' 󰱒 ', '@markup.heading' } },
+                virt_text_pos = 'overlay',
+            },
+        })
+
+        -- Line break
+        vim.list_extend(expected, {
+            {
+                row = { 5 },
+                col = { 0 },
+                virt_text = { { string.rep('—', vim.opt.columns:get()), 'LineNr' } },
+                virt_text_pos = 'overlay',
+            },
+        })
+
+        -- Quote lines
+        vim.list_extend(expected, {
+            {
+                row = { 7, 7 },
+                col = { 0, 4 },
+                virt_text = { { '  ┃ ', '@markup.quote' } },
+                virt_text_pos = 'overlay',
+            },
+            {
+                row = { 8, 8 },
+                col = { 0, 4 },
+                virt_text = { { '  ┃ ', '@markup.quote' } },
+                virt_text_pos = 'overlay',
+            },
+        })
+
+        local actual = util.get_actual_marks()
+        util.marks_are_equal(expected, actual)
+    end)
+end)