feat: support adding icons to ordered lists

## Details

Adjusts query to be for list_item rather than specific markers.

Modifies render logic to work with list_item rather than the marker.

Adds new config parameter `bullet.ordered_icons` which are the icons
used for ordered list items. Ordered lists are defined by the node type
of `list_marker_dot` or `list_marker_parenthesis`. By default it is
empty which essentially means do not add an icon for ordered lists.

Unordered lists continue to function as before.

It probably makes sense to rename the `bullet` top level config to
something more appropriate like `list`, but I don't want to add the
breaking change, at least for the time being.

Author: MeanderingProgrammer

README.md

@@ -358,6 +358,10 @@ require('render-markdown').setup({
         -- The 'level' is used to index into the list using a cycle
         -- If the item is a 'checkbox' a conceal is used to hide the bullet instead
         icons = { '●', '○', '◆', '◇' },
+        -- Replaces 'n.'|'n)' of 'list_item'
+        -- How deeply nested the list is determines the 'level'
+        -- The 'level' is used to index into the list using a cycle
+        ordered_icons = {},
         -- Padding to add to the left of bullet point
         left_pad = 0,
         -- Padding to add to the right of bullet point
@@ -810,6 +814,10 @@ require('render-markdown').setup({
         -- The 'level' is used to index into the list using a cycle
         -- If the item is a 'checkbox' a conceal is used to hide the bullet instead
         icons = { '●', '○', '◆', '◇' },
+        -- Replaces 'n.'|'n)' of 'list_item'
+        -- How deeply nested the list is determines the 'level'
+        -- The 'level' is used to index into the list using a cycle
+        ordered_icons = {},
         -- Padding to add to the left of bullet point
         left_pad = 0,
         -- Padding to add to the right of bullet point

doc/render-markdown.txt

@@ -405,6 +405,10 @@ Default Configuration ~
             -- The 'level' is used to index into the list using a cycle
             -- If the item is a 'checkbox' a conceal is used to hide the bullet instead
             icons = { '●', '○', '◆', '◇' },
+            -- Replaces 'n.'|'n)' of 'list_item'
+            -- How deeply nested the list is determines the 'level'
+            -- The 'level' is used to index into the list using a cycle
+            ordered_icons = {},
             -- Padding to add to the left of bullet point
             left_pad = 0,
             -- Padding to add to the right of bullet point
@@ -847,6 +851,10 @@ Bullet Point Configuration ~
             -- The 'level' is used to index into the list using a cycle
             -- If the item is a 'checkbox' a conceal is used to hide the bullet instead
             icons = { '●', '○', '◆', '◇' },
+            -- Replaces 'n.'|'n)' of 'list_item'
+            -- How deeply nested the list is determines the 'level'
+            -- The 'level' is used to index into the list using a cycle
+            ordered_icons = {},
             -- Padding to add to the left of bullet point
             left_pad = 0,
             -- Padding to add to the right of bullet point

lua/render-markdown/handler/markdown.lua

@@ -44,11 +44,7 @@ function Handler.new(buf)
                 (plus_metadata)
             ] @dash
 
-            [
-                (list_marker_plus)
-                (list_marker_minus)
-                (list_marker_star)
-            ] @list_marker
+            (list_item) @list_item
 
             [
                 (task_list_marker_unchecked)
@@ -65,7 +61,7 @@ function Handler.new(buf)
         code = require('render-markdown.render.code'),
         dash = require('render-markdown.render.dash'),
         heading = require('render-markdown.render.heading'),
-        list_marker = require('render-markdown.render.list_marker'),
+        list_item = require('render-markdown.render.list_item'),
         paragraph = require('render-markdown.render.paragraph'),
         quote = require('render-markdown.render.quote'),
         section = require('render-markdown.render.section'),

lua/render-markdown/health.lua

@@ -4,7 +4,7 @@ local state = require('render-markdown.state')
 local M = {}
 
 ---@private
-M.version = '7.4.8'
+M.version = '7.4.9'
 
 function M.check()
     M.start('version')

lua/render-markdown/init.lua

@@ -111,6 +111,7 @@ local M = {}
 ---@class (exact) render.md.UserBullet
 ---@field public enabled? boolean
 ---@field public icons? (string|string[])[]
+---@field public ordered_icons? (string|string[])[]
 ---@field public left_pad? integer
 ---@field public right_pad? integer
 ---@field public highlight? string
@@ -471,6 +472,10 @@ M.default_config = {
         -- The 'level' is used to index into the list using a cycle
         -- If the item is a 'checkbox' a conceal is used to hide the bullet instead
         icons = { '●', '○', '◆', '◇' },
+        -- Replaces 'n.'|'n)' of 'list_item'
+        -- How deeply nested the list is determines the 'level'
+        -- The 'level' is used to index into the list using a cycle
+        ordered_icons = {},
         -- Padding to add to the left of bullet point
         left_pad = 0,
         -- Padding to add to the right of bullet point

lua/render-markdown/lib/node.lua

@@ -69,8 +69,7 @@ function Node:level_in_section(target)
     local parent, level, root = self.node:parent(), 0, nil
     while parent ~= nil and parent:type() ~= 'section' do
         if parent:type() == target then
-            level = level + 1
-            root = parent
+            level, root = level + 1, parent
         end
         parent = parent:parent()
     end
@@ -114,6 +113,13 @@ function Node:sibling_count(target)
     return count
 end
 
+---@param index integer
+---@return render.md.Node?
+function Node:child_at(index)
+    local node = self.node:named_child(index)
+    return node ~= nil and Node.new(self.buf, node) or nil
+end
+
 ---@param target_type string
 ---@param target_row? integer
 ---@return render.md.Node?

lua/render-markdown/render/base.lua

@@ -45,13 +45,10 @@ function Base:sign(text, highlight)
 end
 
 ---@protected
+---@param paragraph render.md.Node?
 ---@param highlight? string
-function Base:checkbox_scope(highlight)
-    if highlight == nil then
-        return
-    end
-    local paragraph = self.node:sibling('paragraph')
-    if paragraph == nil then
+function Base:checkbox_scope(paragraph, highlight)
+    if paragraph == nil or highlight == nil then
         return
     end
     paragraph = paragraph:child('inline')

lua/render-markdown/render/checkbox.lua

@@ -30,7 +30,7 @@ end
 
 function Render:render()
     self:icon()
-    self:checkbox_scope(self.checkbox.scope_highlight)
+    self:checkbox_scope(self.node:sibling('paragraph'), self.checkbox.scope_highlight)
 end
 
 ---@private

lua/render-markdown/render/list_marker.lua renamed to lua/render-markdown/render/list_item.lua

@@ -3,6 +3,8 @@ local List = require('render-markdown.lib.list')
 local Str = require('render-markdown.lib.str')
 
 ---@class render.md.data.ListMarker
+---@field marker render.md.Node
+---@field ordered boolean
 ---@field spaces integer
 ---@field checkbox? render.md.CustomCheckbox
 
@@ -16,55 +18,63 @@ Render.__index = Render
 function Render:setup()
     self.bullet = self.config.bullet
 
+    local marker = self.node:child_at(0)
+    if marker == nil then
+        return false
+    end
+
     self.data = {
+        marker = marker,
+        ordered = vim.tbl_contains({ 'list_marker_dot', 'list_marker_parenthesis' }, marker.type),
         -- List markers from tree-sitter should have leading spaces removed, however there are edge
         -- cases in the parser: https://github.com/tree-sitter-grammars/tree-sitter-markdown/issues/127
         -- As a result we account for leading spaces here, can remove if this gets fixed upstream
-        spaces = Str.spaces('start', self.node.text),
+        spaces = Str.spaces('start', marker.text),
         checkbox = self.context:get_checkbox(self.node),
     }
 
     return true
 end
 
 function Render:render()
-    if self:sibling_checkbox() then
+    if self:has_checkbox() then
         -- Hide the list marker for checkboxes rather than replacing with a bullet point
         self:hide_marker()
         self:highlight_scope()
     else
         if not self.bullet.enabled then
             return
         end
-        local level, root_list = self.node:level_in_section('list')
+        local level, root = self.node:level_in_section('list')
         self:icon(level)
-        self:padding(root_list)
+        self:padding(root)
     end
 end
 
 ---@private
 ---@return boolean
-function Render:sibling_checkbox()
+function Render:has_checkbox()
     if not self.config.checkbox.enabled then
         return false
     end
     if self.data.checkbox ~= nil then
         return true
     end
-    if self.node:sibling('task_list_marker_unchecked') ~= nil then
+    if self.data.marker:sibling('task_list_marker_unchecked') ~= nil then
         return true
     end
-    if self.node:sibling('task_list_marker_checked') ~= nil then
+    if self.data.marker:sibling('task_list_marker_checked') ~= nil then
         return true
     end
     return false
 end
 
 ---@private
 function Render:hide_marker()
-    self.marks:add('check_icon', self.node.start_row, self.node.start_col + self.data.spaces, {
-        end_row = self.node.end_row,
-        end_col = self.node.end_col,
+    local node = self.data.marker
+    self.marks:add('check_icon', node.start_row, node.start_col + self.data.spaces, {
+        end_row = node.end_row,
+        end_col = node.end_col,
         conceal = '',
     })
 end
@@ -74,54 +84,48 @@ function Render:highlight_scope()
     if self.data.checkbox == nil then
         return
     end
-    self:checkbox_scope(self.data.checkbox.scope_highlight)
+    self:checkbox_scope(self.node:child('paragraph'), self.data.checkbox.scope_highlight)
 end
 
 ---@private
 ---@param level integer
 function Render:icon(level)
-    local icon = List.cycle(self.bullet.icons, level)
+    local icons = self.data.ordered and self.bullet.ordered_icons or self.bullet.icons
+    local icon = List.cycle(icons, level)
     if type(icon) == 'table' then
-        local item = self.node:parent('list_item')
-        if item == nil then
-            return
-        end
-        icon = List.clamp(icon, item:sibling_count('list_item'))
+        icon = List.clamp(icon, self.node:sibling_count('list_item'))
     end
     if icon == nil then
         return
     end
+    local node = self.data.marker
     local text = Str.pad(self.data.spaces) .. icon
     local position, conceal = 'overlay', nil
-    if Str.width(text) > Str.width(self.node.text) then
+    if Str.width(text) > Str.width(node.text) then
         position, conceal = 'inline', ''
     end
-    self.marks:add('bullet', self.node.start_row, self.node.start_col, {
-        end_row = self.node.end_row,
-        end_col = self.node.end_col,
+    self.marks:add('bullet', node.start_row, node.start_col, {
+        end_row = node.end_row,
+        end_col = node.end_col,
         virt_text = { { text, self.bullet.highlight } },
         virt_text_pos = position,
         conceal = conceal,
     })
 end
 
 ---@private
----@param root_list? render.md.Node
-function Render:padding(root_list)
+---@param root? render.md.Node
+function Render:padding(root)
     if self.bullet.left_pad <= 0 and self.bullet.right_pad <= 0 then
         return
     end
-    local list_item = self.node:parent('list_item')
-    if list_item == nil then
-        return
-    end
-    local left_col = root_list ~= nil and root_list.start_col or list_item.start_col
+    local left_col = root ~= nil and root.start_col or self.node.start_col
 
-    local next_list = list_item:child('list')
-    local end_row = next_list ~= nil and next_list.start_row or list_item.end_row
+    local next_list = self.node:child('list')
+    local end_row = next_list ~= nil and next_list.start_row or self.node.end_row
 
-    for row = list_item.start_row, end_row - 1 do
-        local right_col = row == list_item.start_row and self.node.end_col - 1 or left_col
+    for row = self.node.start_row, end_row - 1 do
+        local right_col = row == self.node.start_row and self.data.marker.end_col - 1 or left_col
         self:padding_mark(row, left_col, self.bullet.left_pad)
         self:padding_mark(row, right_col, self.bullet.right_pad)
     end

lua/render-markdown/state.lua

@@ -183,7 +183,7 @@ function M.validate()
             :type('enabled', 'boolean')
             :type({ 'left_pad', 'right_pad' }, 'number')
             :type('highlight', 'string')
-            :list_or_list_of_list('icons', 'string')
+            :list_or_list_of_list({ 'icons', 'ordered_icons' }, 'string')
             :check()
 
         get_spec('checkbox')