Do not render bullet points before checkboxes

# Details

Resolves: #18

When the next sibling of a list marker is a bullet point overlay
with spaces rather than spaces + bullet point.

We could also do a conceal here to have the text shift over rather
than adding spaces, however this has the downside of a conceal where
once the cursor enters the line the text jumps back over and the marker
becomes visible again. I prefer to avoid the text jumping behavior.

Author: MeanderingProgrammer

demo/demo.gif

@@ -50,14 +50,21 @@ M.render = function(namespace, root)
                 hl_eol = true,
             })
         elseif capture == 'list_marker' then
-            -- List markers from tree-sitter should have leading spaces removed, however there are known
-            -- edge cases in the parser: https://github.com/tree-sitter-grammars/tree-sitter-markdown/issues/127
-            -- As a result we handle leading spaces here, can remove if this gets fixed upstream
-            local _, leading_spaces = value:find('^%s*')
-            local level = M.calculate_list_level(node)
-            local bullet = list.cycle(state.config.bullets, level)
+            local list_marker_overlay = ''
+            if M.is_sibling_checkbox(node) then
+                -- Hide the list marker for checkboxes rather than replacing with a bullet point
+                list_marker_overlay = string.rep(' ', #value)
+            else
+                -- List markers from tree-sitter should have leading spaces removed, however there are known
+                -- edge cases in the parser: https://github.com/tree-sitter-grammars/tree-sitter-markdown/issues/127
+                -- As a result we handle leading spaces here, can remove if this gets fixed upstream
+                local _, leading_spaces = value:find('^%s*')
+                local level = M.calculate_list_level(node)
+                local bullet = list.cycle(state.config.bullets, level)
+                list_marker_overlay = string.rep(' ', leading_spaces or 0) .. bullet
+            end
 
-            local virt_text = { string.rep(' ', leading_spaces or 0) .. bullet, highlights.bullet }
+            local virt_text = { list_marker_overlay, highlights.bullet }
             vim.api.nvim_buf_set_extmark(0, namespace, start_row, start_col, {
                 end_row = end_row,
                 end_col = end_col,
@@ -144,6 +151,16 @@ M.render = function(namespace, root)
     end
 end
 
+---@param node TSNode
+---@return boolean
+M.is_sibling_checkbox = function(node)
+    local sibling = node:next_sibling()
+    if sibling == nil then
+        return false
+    end
+    return vim.startswith(sibling:type(), 'task_list_marker')
+end
+
 --- Walk through all parent nodes and count the number of nodes with type list
 --- to calculate the level of the given node
 ---@param node TSNode

lua/render-markdown/handler/markdown.lua

@@ -155,11 +155,11 @@ async_tests.describe('init', function()
 
         -- Checkboxes
         vim.list_extend(expected, {
-            -- Unchecked, bullet point, not created intentionally, remove if fixed
+            -- Unchecked, list marker
             {
                 row = { 35, 35 },
                 col = { 0, 2 },
-                virt_text = { { '●', 'Normal' } },
+                virt_text = { { '  ', 'Normal' } },
                 virt_text_pos = 'overlay',
             },
             -- Unchecked, checkbox
@@ -169,11 +169,11 @@ async_tests.describe('init', function()
                 virt_text = { { ' 󰄱 ', '@markup.list.unchecked' } },
                 virt_text_pos = 'overlay',
             },
-            -- Checked, bullet point, not created intentionally, remove if fixed
+            -- Checked, list marker
             {
                 row = { 36, 36 },
                 col = { 0, 2 },
-                virt_text = { { '●', 'Normal' } },
+                virt_text = { { '  ', 'Normal' } },
                 virt_text_pos = 'overlay',
             },
             -- Checked, checkbox