feat: left_pad list bullet point property

Adds `bullet -> left_pad` property which adds left padding to bullet
points.

Update how we do neovim version check to be inside of handler add
methods. That way the logic more clearly reads like do not add inline
marks if version is not at least 0.10.0. Is also a generally more safe
approach as I do not need to remember to add it everytime I use inline
marks.

Author: MeanderingProgrammer

README.md

@@ -303,6 +303,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 left of bullet point
+        left_pad = 0,
         -- Padding to add to the right of bullet point
         right_pad = 0,
         -- Highlight for the bullet icon
@@ -603,6 +605,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 left of bullet point
+        left_pad = 0,
         -- Padding to add to the right of bullet point
         right_pad = 0,
         -- Highlight for the bullet icon

doc/render-markdown.txt

@@ -335,6 +335,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 left of bullet point
+            left_pad = 0,
             -- Padding to add to the right of bullet point
             right_pad = 0,
             -- Highlight for the bullet icon
@@ -637,6 +639,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 left of bullet point
+            left_pad = 0,
             -- Padding to add to the right of bullet point
             right_pad = 0,
             -- Highlight for the bullet icon

lua/render-markdown/handler/markdown.lua

@@ -70,7 +70,12 @@ end
 ---@param start_row integer
 ---@param start_col integer
 ---@param opts vim.api.keyset.set_extmark
+---@return boolean
 function Handler:add(conceal, start_row, start_col, opts)
+    -- Inline extmarks require neovim >= 0.10.0
+    if opts.virt_text_pos == 'inline' and not util.has_10 then
+        return false
+    end
     ---@type render.md.Mark
     local mark = {
         conceal = conceal,
@@ -80,6 +85,7 @@ function Handler:add(conceal, start_row, start_col, opts)
     }
     logger.debug('mark', mark)
     table.insert(self.marks, mark)
+    return true
 end
 
 ---@private
@@ -114,16 +120,13 @@ function Handler:heading(info)
     -- and concealed text is subtracted since that space is not usable
     local padding = level + 1 - ts.concealed(self.buf, info) - str.width(icon)
     if heading.position == 'inline' or padding < 0 then
-        -- Requires inline extmarks to place when there is not enough space available
-        if util.has_10 then
-            self:add(true, info.start_row, info.start_col, {
-                end_row = info.end_row,
-                end_col = info.end_col,
-                virt_text = { { icon, { foreground, background } } },
-                virt_text_pos = 'inline',
-                conceal = '',
-            })
-        end
+        self:add(true, info.start_row, info.start_col, {
+            end_row = info.end_row,
+            end_col = info.end_col,
+            virt_text = { { icon, { foreground, background } } },
+            virt_text_pos = 'inline',
+            conceal = '',
+        })
     else
         self:add(true, info.start_row, info.start_col, {
             end_row = info.end_row,
@@ -202,31 +205,28 @@ function Handler:language(code_block, add_background)
     if add_background then
         table.insert(highlight, code.highlight)
     end
-    -- Requires inline extmarks
-    if code.position == 'left' and util.has_10 then
+    if code.position == 'left' then
         local icon_text = icon .. ' '
         if ts.hidden(self.buf, info) then
             -- Code blocks will pick up varying amounts of leading white space depending on the
             -- context they are in. This gets lumped into the delimiter node and as a result,
             -- after concealing, the extmark will be left shifted. Logic below accounts for this.
             icon_text = str.pad(code_block.leading_spaces, icon_text .. info.text)
         end
-        self:add(true, info.start_row, info.start_col, {
+        return self:add(true, info.start_row, info.start_col, {
             virt_text = { { icon_text, highlight } },
             virt_text_pos = 'inline',
         })
-        return true
     elseif code.position == 'right' then
         local icon_text = icon .. ' ' .. info.text
         local win_col = code_block.longest_line
         if code.width == 'block' then
             win_col = win_col - str.width(icon_text)
         end
-        self:add(true, info.start_row, 0, {
+        return self:add(true, info.start_row, 0, {
             virt_text = { { icon_text, highlight } },
             virt_text_win_col = win_col,
         })
-        return true
     else
         return false
     end
@@ -285,8 +285,7 @@ end
 ---@param add_background boolean
 function Handler:code_left_pad(code_block, add_background)
     local code = self.config.code
-    -- Requires inline extmarks
-    if not util.has_10 or code.left_pad <= 0 then
+    if code.left_pad <= 0 then
         return
     end
     local padding = str.pad(code.left_pad)
@@ -354,8 +353,14 @@ function Handler:list_marker(info)
             virt_text = { { str.pad(leading_spaces, icon), bullet.highlight } },
             virt_text_pos = 'overlay',
         })
-        -- Requires inline extmarks
-        if util.has_10 and bullet.right_pad > 0 then
+        if bullet.left_pad > 0 then
+            self:add(false, info.start_row, 0, {
+                priority = 0,
+                virt_text = { { str.pad(bullet.left_pad), 'Normal' } },
+                virt_text_pos = 'inline',
+            })
+        end
+        if bullet.right_pad > 0 then
             self:add(true, info.start_row, info.end_col - 1, {
                 virt_text = { { str.pad(bullet.right_pad), 'Normal' } },
                 virt_text_pos = 'inline',
@@ -495,8 +500,7 @@ function Handler:table_row(row, highlight)
                     virt_text_pos = 'overlay',
                 })
             elseif cell.type == 'pipe_table_cell' then
-                -- Requires inline extmarks
-                if pipe_table.cell == 'padded' and util.has_10 then
+                if pipe_table.cell == 'padded' then
                     local offset = self:table_visual_offset(cell)
                     if offset > 0 then
                         self:add(true, cell.start_row, cell.end_col - 1, {

lua/render-markdown/handler/markdown_inline.lua

@@ -46,7 +46,12 @@ end
 ---@param start_row integer
 ---@param start_col integer
 ---@param opts vim.api.keyset.set_extmark
+---@return boolean
 function Handler:add(start_row, start_col, opts)
+    -- Inline extmarks require neovim >= 0.10.0
+    if opts.virt_text_pos == 'inline' and not util.has_10 then
+        return false
+    end
     ---@type render.md.Mark
     local mark = {
         conceal = true,
@@ -56,16 +61,14 @@ function Handler:add(start_row, start_col, opts)
     }
     logger.debug('mark', mark)
     table.insert(self.marks, mark)
+    return true
 end
 
 ---@private
 ---@param info render.md.NodeInfo
 function Handler:code(info)
     local code = self.config.code
-    if not code.enabled then
-        return
-    end
-    if not vim.tbl_contains({ 'normal', 'full' }, code.style) then
+    if not code.enabled or not vim.tbl_contains({ 'normal', 'full' }, code.style) then
         return
     end
     self:add(info.start_row, info.start_col, {
@@ -130,8 +133,7 @@ end
 ---@param info render.md.NodeInfo
 ---@param checkbox render.md.CustomComponent
 function Handler:checkbox(info, checkbox)
-    -- Requires inline extmarks
-    if not self.config.checkbox.enabled or not util.has_10 then
+    if not self.config.checkbox.enabled then
         return
     end
     self:add(info.start_row, info.start_col, {
@@ -146,8 +148,7 @@ end
 ---@private
 ---@param info render.md.NodeInfo
 function Handler:wiki_link(info)
-    -- Requires inline extmarks
-    if not self.config.link.enabled or not util.has_10 then
+    if not self.config.link.enabled then
         return
     end
     local text = info.text:sub(2, -2)
@@ -165,18 +166,19 @@ end
 ---@private
 ---@param info render.md.NodeInfo
 function Handler:link(info)
-    -- Requires inline extmarks
-    if not self.config.link.enabled or not util.has_10 then
+    if not self.config.link.enabled then
         return
     end
     local icon, highlight = self:link_virt_text(info)
-    context.get(self.buf):add_link(info, icon)
-    self:add(info.start_row, info.start_col, {
+    local added = self:add(info.start_row, info.start_col, {
         end_row = info.end_row,
         end_col = info.end_col,
         virt_text = { { icon, highlight } },
         virt_text_pos = 'inline',
     })
+    if added then
+        context.get(self.buf):add_link(info, icon)
+    end
 end
 
 ---@private

lua/render-markdown/health.lua

@@ -5,7 +5,7 @@ local M = {}
 
 ---@private
 ---@type string
-M.version = '6.0.1'
+M.version = '6.0.2'
 
 function M.check()
     vim.health.start('render-markdown.nvim [version]')

lua/render-markdown/init.lua

@@ -72,6 +72,7 @@ local M = {}
 ---@class (exact) render.md.UserBullet
 ---@field public enabled? boolean
 ---@field public icons? string[]
+---@field public left_pad? integer
 ---@field public right_pad? integer
 ---@field public highlight? string
 
@@ -326,6 +327,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 left of bullet point
+        left_pad = 0,
         -- Padding to add to the right of bullet point
         right_pad = 0,
         -- Highlight for the bullet icon

lua/render-markdown/state.lua

@@ -208,6 +208,7 @@ function M.validate()
             append_errors(path .. '.bullet', bullet, {
                 enabled = { bullet.enabled, 'boolean', nilable },
                 icons = string_array(bullet.icons, nilable),
+                left_pad = { bullet.left_pad, 'number', nilable },
                 right_pad = { bullet.right_pad, 'number', nilable },
                 highlight = { bullet.highlight, 'string', nilable },
             })

lua/render-markdown/types.lua

@@ -61,6 +61,7 @@
 ---@class (exact) render.md.Bullet
 ---@field public enabled boolean
 ---@field public icons string[]
+---@field public left_pad integer
 ---@field public right_pad integer
 ---@field public highlight string