feat: Add bullet.right_pad option

Author: MeanderingProgrammer

README.md

@@ -267,6 +267,8 @@ require('render-markdown').setup({
         -- The 'level' is used to index into the array using a cycle
         -- If the item is a 'checkbox' a conceal is used to hide the bullet instead
         icons = { '●', '○', '◆', '◇' },
+        -- Padding to add to the right of bullet point
+        right_pad = 0,
         -- Highlight for the bullet icon
         highlight = 'RenderMarkdownBullet',
     },
@@ -519,6 +521,8 @@ require('render-markdown').setup({
         -- The 'level' is used to index into the array using a cycle
         -- If the item is a 'checkbox' a conceal is used to hide the bullet instead
         icons = { '●', '○', '◆', '◇' },
+        -- Padding to add to the right of bullet point
+        right_pad = 0,
         -- Highlight for the bullet icon
         highlight = 'RenderMarkdownBullet',
     },

doc/render-markdown.txt

@@ -307,6 +307,8 @@ Full Default Configuration ~
             -- The 'level' is used to index into the array using a cycle
             -- If the item is a 'checkbox' a conceal is used to hide the bullet instead
             icons = { '●', '○', '◆', '◇' },
+            -- Padding to add to the right of bullet point
+            right_pad = 0,
             -- Highlight for the bullet icon
             highlight = 'RenderMarkdownBullet',
         },
@@ -561,6 +563,8 @@ LIST BULLETS                              *render-markdown-setup-list-bullets*
             -- The 'level' is used to index into the array using a cycle
             -- If the item is a 'checkbox' a conceal is used to hide the bullet instead
             icons = { '●', '○', '◆', '◇' },
+            -- Padding to add to the right of bullet point
+            right_pad = 0,
             -- Highlight for the bullet icon
             highlight = 'RenderMarkdownBullet',
         },

lua/render-markdown/handler/markdown.lua

@@ -29,7 +29,7 @@ M.parse = function(root, buf)
         elseif capture == 'code' then
             vim.list_extend(marks, M.render_code(buf, info))
         elseif capture == 'list_marker' then
-            list.add(marks, M.render_list_marker(buf, info))
+            vim.list_extend(marks, M.render_list_marker(buf, info))
         elseif capture == 'checkbox_unchecked' then
             list.add(marks, M.render_checkbox(info, state.config.checkbox.unchecked))
         elseif capture == 'checkbox_checked' then
@@ -335,7 +335,7 @@ end
 ---@private
 ---@param buf integer
 ---@param info render.md.NodeInfo
----@return render.md.Mark?
+---@return render.md.Mark[]
 M.render_list_marker = function(buf, info)
     ---@return boolean
     local function sibling_checkbox()
@@ -357,7 +357,7 @@ M.render_list_marker = function(buf, info)
     if sibling_checkbox() then
         -- Hide the list marker for checkboxes rather than replacing with a bullet point
         ---@type render.md.Mark
-        return {
+        local checkbox_mark = {
             conceal = true,
             start_row = info.start_row,
             start_col = info.start_col,
@@ -367,22 +367,24 @@ M.render_list_marker = function(buf, info)
                 conceal = '',
             },
         }
+        return { checkbox_mark }
     else
         local bullet = state.config.bullet
         if not bullet.enabled then
-            return nil
+            return {}
         end
         local level = ts.level_in_section(info, 'list')
         local icon = list.cycle(bullet.icons, level)
         if icon == nil then
-            return nil
+            return {}
         end
+        local marks = {}
         -- 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 = str.leading_spaces(info.text)
         ---@type render.md.Mark
-        return {
+        local bullet_mark = {
             conceal = true,
             start_row = info.start_row,
             start_col = info.start_col,
@@ -393,6 +395,22 @@ M.render_list_marker = function(buf, info)
                 virt_text_pos = 'overlay',
             },
         }
+        list.add(marks, bullet_mark)
+        -- Requires inline extmarks
+        if util.has_10 and bullet.right_pad > 0 then
+            ---@type render.md.Mark
+            local padding_mark = {
+                conceal = true,
+                start_row = info.start_row,
+                start_col = info.end_col - 1,
+                opts = {
+                    virt_text = { { str.pad('', bullet.right_pad), 'Normal' } },
+                    virt_text_pos = 'inline',
+                },
+            }
+            list.add(marks, padding_mark)
+        end
+        return marks
     end
 end
 

lua/render-markdown/init.lua

@@ -62,6 +62,7 @@ local M = {}
 ---@class render.md.UserBullet
 ---@field public enabled? boolean
 ---@field public icons? string[]
+---@field public right_pad? integer
 ---@field public highlight? string
 
 ---@class render.md.UserDash
@@ -289,6 +290,8 @@ M.default_config = {
         -- The 'level' is used to index into the array using a cycle
         -- If the item is a 'checkbox' a conceal is used to hide the bullet instead
         icons = { '●', '○', '◆', '◇' },
+        -- Padding to add to the right of bullet point
+        right_pad = 0,
         -- Highlight for the bullet icon
         highlight = 'RenderMarkdownBullet',
     },

lua/render-markdown/state.lua

@@ -155,6 +155,7 @@ function state.validate()
     append_errors('render-markdown.bullet', bullet, {
         enabled = { bullet.enabled, 'boolean' },
         icons = string_array(bullet.icons),
+        right_pad = { bullet.right_pad, 'number' },
         highlight = { bullet.highlight, 'string' },
     })
 

lua/render-markdown/types.lua

@@ -47,6 +47,7 @@
 ---@class render.md.Bullet
 ---@field public enabled boolean
 ---@field public icons string[]
+---@field public right_pad integer
 ---@field public highlight string
 
 ---@class render.md.Dash