feat: allow bullet icons to be a list of lists

## Details

Request: #217

This allows each icon for a bullet to itself be a list of strings. This
list is indexed into using the sibling level of the list item. Sibling
level just means which item number is this in the current list. So you
can do something like roman numerals for level 1 and the alphabet for
level 2. The list is accessed via a clamp so if we exceed the end we
keep using the last value rather than cycling back to the front.

Unrelated change, add a screenshot next to the gifs, see how that looks,
might remove it.

Author: MeanderingProgrammer

.gitignore

@@ -1,2 +1,3 @@
 *.gif
+*.png
 /temp/

README.md

@@ -4,11 +4,13 @@ Plugin to improve viewing Markdown files in Neovim
 
 <!-- panvimdoc-ignore-start -->
 
-|           |         |
-| --------- | ------- |
-| ![Heading](https://github.com/user-attachments/assets/6184ea2d-1769-4c37-bdc4-e6b0d1ca5c00) | ![Table](https://github.com/user-attachments/assets/328473e7-450a-4f52-bc0e-02ccc85e6268) |
-| ![Quote](https://github.com/user-attachments/assets/e7da67bc-7a3f-49f0-b8f6-3e61cf59197b)   | ![LaTeX](https://github.com/user-attachments/assets/58da917b-5ca5-4705-9cad-978e7bb8574a) |
-| ![Callout](https://github.com/user-attachments/assets/73253fa4-ff4f-4562-a721-30c0a218c280) | |
+| Screenshot | Video     |
+| ---------- | --------- |
+| ![Heading](https://github.com/user-attachments/assets/36f0fbb6-99bc-4cb2-8f69-fbea3d10abf1) | ![Heading](https://github.com/user-attachments/assets/e57a53ea-f0bf-48db-90c1-0c2365ab3c54) |
+| ![Table](https://github.com/user-attachments/assets/cbb81758-820d-467c-bc44-07003cb532bb)   | ![Table](https://github.com/user-attachments/assets/5cd2b69d-ef17-4c6e-9510-59ed10e385d5)   |
+| ![Quote](https://github.com/user-attachments/assets/822ae62c-bc0f-40a7-b8bb-fb3a885a95f9)   | ![Quote](https://github.com/user-attachments/assets/aa002ac7-b30f-4079-bba9-505160a4ad78)   |
+| ![Callout](https://github.com/user-attachments/assets/397ddd7b-bb82-47d0-ad9d-bdbe2f9858d7) | ![Callout](https://github.com/user-attachments/assets/250aaeda-6141-4f4c-b72c-103875ca6eb8) |
+| ![LaTeX](https://github.com/user-attachments/assets/7b859c0a-1bf6-4398-88b5-7bcde12f2390)   | ![LaTeX](https://github.com/user-attachments/assets/9ef14030-f688-47fd-95ff-befab1253322)   |
 
 <!-- panvimdoc-ignore-end -->
 

benches/readme_spec.lua

@@ -4,7 +4,7 @@ local util = require('benches.util')
 
 describe('README.md', function()
     it('default', function()
-        local base_marks = 66
+        local base_marks = 73
         util.less_than(util.setup('README.md'), 50)
         util.num_marks(base_marks)
 

demo/format.tape

@@ -17,16 +17,19 @@ Sleep 2s
 
 WRITE
 
-Type "i" Sleep 1s
-Escape Sleep 1s
+Down
+Type "i" Sleep 0.5s
+Screenshot default.png Sleep 0.5s
+Escape Sleep 0.5s
+Screenshot rendered.png Sleep 0.5s
 
 MOVE
 
 Type "i" Sleep 1s
 Escape Sleep 1s
 
 # Close without editing
-Type ":q!"
 Hide
+Type ":q!"
 Enter
 Sleep 100ms

demo/run.py

@@ -2,6 +2,8 @@
 from argparse import ArgumentParser
 from pathlib import Path
 
+from PIL import Image
+
 INFO: dict[str, tuple[int, str]] = dict(
     heading_code=(550, "## Heading 2"),
     list_table=(550, ""),
@@ -12,31 +14,58 @@
 
 
 def main(name: str) -> None:
-    in_file = Path(f"demo/{name}.md")
-    assert in_file.exists()
+    file = Path(f"demo/{name}.md")
+    assert file.exists()
+
+    create_gif(name, file)
+    create_screenshot(name)
+
 
-    out_file = Path(f"demo/{name}.gif")
-    if out_file.exists():
-        out_file.unlink()
+def create_gif(name: str, file: Path) -> None:
+    gif = Path(f"demo/{name}.gif")
+    if gif.exists():
+        gif.unlink()
 
     height, content = INFO[name]
 
     tape = Path("demo/demo.tape")
-    tape.write_text(tape_content(in_file, out_file, height, content))
+    tape.write_text(tape_content(file, gif, height, content))
     result = subprocess.run(["vhs", tape])
     assert result.returncode == 0
     tape.unlink()
 
 
-def tape_content(in_file: Path, out_file: Path, height: int, to_write: str) -> str:
-    content = Path("demo/format.tape").read_text()
-    content = content.replace("INPUT", str(in_file))
-    content = content.replace("OUTPUT", str(out_file))
-    content = content.replace("WIDTH", str(550))
-    content = content.replace("HEIGHT", str(height))
-    content = content.replace("WRITE", get_write(to_write))
-    content = content.replace("MOVE", get_move(in_file))
-    return content
+def create_screenshot(name: str) -> None:
+    screenshot = Path(f"demo/{name}.png")
+    if screenshot.exists():
+        screenshot.unlink()
+
+    default, rendered = Path("default.png"), Path("rendered.png")
+    assert default.exists() and rendered.exists()
+
+    left, right = Image.open(default), Image.open(rendered)
+
+    mode, width, height = left.mode, left.width, left.height
+    assert mode == right.mode and width == right.width and height == right.height
+
+    combined = Image.new(mode, (2 * width, height))
+    combined.paste(left, (0, 0))
+    combined.paste(right, (width, 0))
+    combined.save(screenshot)
+
+    default.unlink()
+    rendered.unlink()
+
+
+def tape_content(file: Path, gif: Path, height: int, content: str) -> str:
+    result = Path("demo/format.tape").read_text()
+    result = result.replace("INPUT", str(file))
+    result = result.replace("OUTPUT", str(gif))
+    result = result.replace("WIDTH", str(550))
+    result = result.replace("HEIGHT", str(height))
+    result = result.replace("WRITE", get_write(content))
+    result = result.replace("MOVE", get_move(file))
+    return result
 
 
 def get_write(content: str) -> str:
@@ -49,10 +78,10 @@ def get_write(content: str) -> str:
     return "\n".join(write)
 
 
-def get_move(in_file: Path) -> str:
+def get_move(file: Path) -> str:
     move: list[str] = []
-    # Get lines so we know how to scroll down, account for starting on first line
-    lines: list[str] = Path(in_file).read_text().splitlines()[1:]
+    # Get lines so we know how to scroll down, account for starting on second line
+    lines: list[str] = file.read_text().splitlines()[2:]
     for line in lines:
         skip = ("    ", "def", "if")
         duration = 0.1 if line == "" or line.startswith(skip) else 0.75

doc/render-markdown.txt

@@ -1,4 +1,4 @@
-*render-markdown.txt*          For 0.10.0         Last change: 2024 October 24
+*render-markdown.txt*          For 0.10.0         Last change: 2024 October 25
 
 ==============================================================================
 Table of Contents                          *render-markdown-table-of-contents*

lua/render-markdown/debug/validator.lua

@@ -79,7 +79,7 @@ function Spec:list(keys, list_type, input_types)
         elseif type(v) == 'table' then
             for i, item in ipairs(v) do
                 if type(item) ~= list_type then
-                    return false, string.format('Index %d is %s', i, type(item))
+                    return false, string.format('[%d] is %s', i, type(item))
                 end
             end
             return true
@@ -89,6 +89,34 @@ function Spec:list(keys, list_type, input_types)
     end, list_type .. ' list' .. suffix)
 end
 
+---@param keys string|string[]
+---@param list_type type
+---@param input_types? type|type[]
+---@return render.md.debug.ValidatorSpec
+function Spec:list_or_list_of_list(keys, list_type, input_types)
+    local types, suffix = self:handle_types(input_types)
+    return self:add(keys, function(v)
+        if vim.tbl_contains(types, type(v)) then
+            return true
+        elseif type(v) == 'table' then
+            for i, item in ipairs(v) do
+                if type(item) == 'table' then
+                    for j, nested in ipairs(item) do
+                        if type(nested) ~= list_type then
+                            return false, string.format('[%d][%d] is %s', i, j, type(nested))
+                        end
+                    end
+                elseif type(item) ~= list_type then
+                    return false, string.format('[%d] is %s', i, type(item))
+                end
+            end
+            return true
+        else
+            return false
+        end
+    end, list_type .. ' list or list of list' .. suffix)
+end
+
 ---@param keys string|string[]
 ---@param values string[]
 ---@param input_types? type|type[]
@@ -103,7 +131,7 @@ function Spec:one_or_list_of(keys, values, input_types)
         elseif type(v) == 'table' then
             for i, item in ipairs(v) do
                 if not vim.tbl_contains(values, item) then
-                    return false, string.format('Index %d is %s', i, item)
+                    return false, string.format('[%d] is %s', i, item)
                 end
             end
             return true

lua/render-markdown/health.lua

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

lua/render-markdown/init.lua

@@ -110,7 +110,7 @@ local M = {}
 
 ---@class (exact) render.md.UserBullet
 ---@field public enabled? boolean
----@field public icons? string[]
+---@field public icons? (string|string[])[]
 ---@field public left_pad? integer
 ---@field public right_pad? integer
 ---@field public highlight? string

lua/render-markdown/lib/node.lua

@@ -103,6 +103,17 @@ function Node:sibling(target)
     return nil
 end
 
+---@param target string
+---@return integer
+function Node:sibling_count(target)
+    local count, sibling = 1, self.node:prev_sibling()
+    while sibling ~= nil and sibling:type() == target do
+        count = count + 1
+        sibling = sibling:prev_sibling()
+    end
+    return count
+end
+
 ---@param target_type string
 ---@param target_row? integer
 ---@return render.md.Node?

lua/render-markdown/render/list_marker.lua

@@ -3,7 +3,7 @@ local List = require('render-markdown.lib.list')
 local Str = require('render-markdown.lib.str')
 
 ---@class render.md.data.ListMarker
----@field leading_spaces integer
+---@field spaces integer
 ---@field checkbox? render.md.CustomCheckbox
 
 ---@class render.md.render.ListMarker: render.md.Renderer
@@ -20,7 +20,7 @@ function Render:setup()
         -- 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
-        leading_spaces = Str.spaces('start', self.node.text),
+        spaces = Str.spaces('start', self.node.text),
         checkbox = self.context:get_checkbox(self.node),
     }
 
@@ -62,7 +62,7 @@ end
 
 ---@private
 function Render:hide_marker()
-    self.marks:add('check_icon', self.node.start_row, self.node.start_col + self.data.leading_spaces, {
+    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,
         conceal = '',
@@ -81,14 +81,27 @@ end
 ---@param level integer
 function Render:icon(level)
     local icon = List.cycle(self.bullet.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'))
+    end
     if icon == nil then
         return
     end
+    local text = Str.pad(self.data.spaces) .. icon
+    local position, conceal = 'overlay', nil
+    if Str.width(text) > Str.width(self.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,
-        virt_text = { { Str.pad(self.data.leading_spaces) .. icon, self.bullet.highlight } },
-        virt_text_pos = 'overlay',
+        virt_text = { { text, self.bullet.highlight } },
+        virt_text_pos = position,
+        conceal = conceal,
     })
 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('icons', 'string')
+            :list_or_list_of_list('icons', 'string')
             :check()
 
         get_spec('checkbox')

lua/render-markdown/types.lua

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

tests/state_spec.lua

@@ -86,7 +86,7 @@ describe('state', function()
             prefix
                 .. '.render_modes: expected string list or type { "boolean" }, got '
                 .. tostring(int_render_modes)
-                .. '. Info: Index 1 is number',
+                .. '. Info: [1] is number',
         }, validate({ render_modes = int_render_modes }))
 
         eq(