chore(refactor): add line builder module

## Details

Moves logic out of base renderer into top level config:
- `append` -> new line builder module created from top level config
- `line_icon` -> top level config in `link_icon` method

Author: MeanderingProgrammer

lua/render-markdown/config.lua

@@ -1,4 +1,6 @@
 local Env = require('render-markdown.lib.env')
+local Iter = require('render-markdown.lib.iter')
+local Line = require('render-markdown.lib.line')
 local Range = require('render-markdown.core.range')
 
 ---@class render.md.main.Full
@@ -132,6 +134,11 @@ function Config.validate(spec)
     spec:nested('win_options', require('render-markdown.config.win_options').validate)
 end
 
+---@return render.md.Line
+function Config:line()
+    return Line.new(self)
+end
+
 ---@param mode string
 ---@return boolean
 function Config:render(mode)
@@ -150,6 +157,26 @@ function Config:get_checkbox(node)
     return self.full.checkbox[node.text:lower()]
 end
 
+---@param destination string
+---@param icon render.md.mark.Text
+function Config:link_text(destination, icon)
+    local options = Iter.table.filter(self.link.custom, function(custom)
+        if custom.kind == 'suffix' then
+            return vim.endswith(destination, custom.pattern)
+        else
+            return destination:find(custom.pattern) ~= nil
+        end
+    end)
+    Iter.list.sort(options, function(custom)
+        return custom.priority or #custom.pattern
+    end)
+    local result = options[#options]
+    if result then
+        icon[1] = result.icon
+        icon[2] = result.highlight or icon[2]
+    end
+end
+
 ---@param mode string
 ---@param row? integer
 ---@return render.md.Range?

lua/render-markdown/health.lua

@@ -5,7 +5,7 @@ local state = require('render-markdown.state')
 local M = {}
 
 ---@private
-M.version = '8.3.21'
+M.version = '8.3.22'
 
 function M.check()
     M.start('version')

lua/render-markdown/lib/line.lua

@@ -0,0 +1,60 @@
+---@class render.md.Line
+---@field private highlight string
+---@field private line render.md.mark.Line
+local Line = {}
+Line.__index = Line
+
+---@param config render.md.main.Config
+---@return render.md.Line
+function Line.new(config)
+    local self = setmetatable({}, Line)
+    self.highlight = config.padding.highlight
+    self.line = {}
+    return self
+end
+
+---@return render.md.mark.Line
+function Line:get()
+    return self.line
+end
+
+---@return boolean
+function Line:empty()
+    return #self.line == 0
+end
+
+---@param other render.md.Line
+---@return render.md.Line
+function Line:extend(other)
+    vim.list_extend(self.line, other.line)
+    return self
+end
+
+---@param s string
+---@param highlight? string|string[]
+---@return render.md.Line
+function Line:text(s, highlight)
+    if #s > 0 then
+        self:add(s, highlight)
+    end
+    return self
+end
+
+---@param n integer
+---@param highlight? string|string[]
+---@return render.md.Line
+function Line:pad(n, highlight)
+    if n > 0 then
+        self:add((' '):rep(n), highlight)
+    end
+    return self
+end
+
+---@private
+---@param text string
+---@param highlight? string|string[]
+function Line:add(text, highlight)
+    self.line[#self.line + 1] = { text, highlight or self.highlight }
+end
+
+return Line

lua/render-markdown/lib/marks.lua

@@ -26,19 +26,19 @@ local log = require('render-markdown.core.log')
 ---@class render.md.Marks
 ---@field private context render.md.Context
 ---@field private ignore render.md.conceal.Ignore
----@field private inline boolean
+---@field private update boolean
 ---@field private marks render.md.Mark[]
 local Marks = {}
 Marks.__index = Marks
 
 ---@param context render.md.Context
----@param inline boolean
+---@param update boolean
 ---@return render.md.Marks
-function Marks.new(context, inline)
+function Marks.new(context, update)
     local self = setmetatable({}, Marks)
     self.context = context
     self.ignore = context.config.anti_conceal.ignore
-    self.inline = inline
+    self.update = update
     self.marks = {}
     return self
 end
@@ -93,7 +93,9 @@ function Marks:add(element, start_row, start_col, opts)
         return false
     end
     log.add('debug', 'mark', mark)
-    self:update(mark)
+    if self.update then
+        self:run_update(mark)
+    end
     self.marks[#self.marks + 1] = mark
     return true
 end
@@ -131,10 +133,7 @@ end
 
 ---@private
 ---@param mark render.md.Mark
-function Marks:update(mark)
-    if not self.inline then
-        return
-    end
+function Marks:run_update(mark)
     local row, start_col = mark.start_row, mark.start_col
     if mark.opts.conceal then
         local end_col = assert(mark.opts.end_col, 'conceal requires end_col')

lua/render-markdown/render/base.lua

@@ -1,4 +1,3 @@
-local Iter = require('render-markdown.lib.iter')
 local Str = require('render-markdown.lib.str')
 local colors = require('render-markdown.colors')
 
@@ -31,7 +30,7 @@ end
 ---@param highlight? string
 function Base:sign(enabled, text, highlight)
     local sign = self.config.sign
-    if not enabled or not sign.enabled or not text then
+    if not sign.enabled or not enabled or not text then
         return
     end
     local sign_highlight = sign.highlight
@@ -49,27 +48,26 @@ end
 ---@param highlight string
 ---@return boolean
 function Base:check_icon(icon, highlight)
-    local line = self:append({}, icon, highlight)
+    local line = self.config:line():text(icon, highlight)
     local space = self.context:width(self.node) + 1 - Str.width(icon)
     local right_pad = self.config.checkbox.right_pad
     if space < 0 then
         -- not enough space to fit the icon in-place
         return self.marks:over('check_icon', self.node, {
-            virt_text = self:append(line, right_pad),
+            virt_text = line:pad(right_pad):get(),
             virt_text_pos = 'inline',
             conceal = '',
         }, { 0, 0, 0, 1 })
     else
         local fits = math.min(space, right_pad)
-        self:append(line, fits)
         space = space - fits
         right_pad = right_pad - fits
         local row = self.node.start_row
         local start_col = self.node.start_col
         local end_col = self.node.end_col + 1
         self.marks:add('check_icon', row, start_col, {
             end_col = end_col - space,
-            virt_text = line,
+            virt_text = line:pad(fits):get(),
             virt_text_pos = 'overlay',
         })
         if space > 0 then
@@ -82,7 +80,7 @@ function Base:check_icon(icon, highlight)
         if right_pad > 0 then
             -- add padding
             self.marks:add('check_icon', row, end_col, {
-                virt_text = self:append({}, right_pad),
+                virt_text = self.config:line():pad(right_pad):get(),
                 virt_text_pos = 'inline',
             })
         end
@@ -101,47 +99,26 @@ function Base:scope(element, node, highlight)
     self.marks:over(element, node:child('inline'), { hl_group = highlight })
 end
 
----@protected
----@param destination string
----@param icon render.md.mark.Text
-function Base:link_icon(destination, icon)
-    local options = Iter.table.filter(self.config.link.custom, function(custom)
-        if custom.kind == 'suffix' then
-            return vim.endswith(destination, custom.pattern)
-        else
-            return destination:find(custom.pattern) ~= nil
-        end
-    end)
-    Iter.list.sort(options, function(custom)
-        return custom.priority or Str.width(custom.pattern)
-    end)
-    local result = options[#options]
-    if result then
-        icon[1] = result.icon
-        icon[2] = result.highlight or icon[2]
-    end
-end
-
 ---@protected
 ---@param virtual boolean
 ---@param level? integer
----@return render.md.mark.Line
+---@return render.md.Line
 function Base:indent_line(virtual, level)
     if virtual then
         level = self:indent_level(level)
     else
         assert(level, 'level must be known for real lines')
     end
-    local line = {}
+    local line = self.config:line()
     if level > 0 then
         local indent = self.config.indent
         local icon_width = Str.width(indent.icon)
         if icon_width == 0 then
-            self:append(line, indent.per_level * level)
+            line:pad(indent.per_level * level)
         else
             for _ = 1, level do
-                self:append(line, indent.icon, indent.highlight)
-                self:append(line, indent.per_level - icon_width)
+                line:text(indent.icon, indent.highlight)
+                line:pad(indent.per_level - icon_width)
             end
         end
     end
@@ -177,23 +154,4 @@ function Base:indent_level(level)
     return math.max(level - indent.skip_level, 0)
 end
 
----@protected
----@param line render.md.mark.Line
----@param value string|integer
----@param highlight? string|string[]
----@return render.md.mark.Line
-function Base:append(line, value, highlight)
-    highlight = highlight or self.config.padding.highlight
-    if type(value) == 'string' then
-        if #value > 0 then
-            line[#line + 1] = { value, highlight }
-        end
-    else
-        if value > 0 then
-            line[#line + 1] = { Str.pad(value), highlight }
-        end
-    end
-    return line
-end
-
 return Base

lua/render-markdown/render/bullet.lua

@@ -146,8 +146,8 @@ function Render:padding(root, left_pad, right_pad)
         return
     end
     local start_row, end_row = self.node.start_row, self:end_row(root)
-    local left_line = self:append({}, left_pad)
-    local right_line = self:append({}, right_pad)
+    local left_line = self.config:line():pad(left_pad):get()
+    local right_line = self.config:line():pad(right_pad):get()
     for row = start_row, end_row - 1 do
         local left = root and root.start_col or self.node.start_col
         local right = row == start_row and self.data.marker.end_col - 1 or left

lua/render-markdown/render/code.lua

@@ -207,22 +207,23 @@ end
 ---@param end_row integer
 ---@param highlight string
 function Render:background(start_row, end_row, highlight)
-    local col, win_col, padding = self.node.start_col, 0, {}
+    local padding = self.config:line()
+    local win_col = 0
     if self.info.width == 'block' then
+        padding:pad(vim.o.columns * 2)
         win_col = self.data.margin + self.data.width + self.data.indent
-        self:append(padding, vim.o.columns * 2)
     end
     for row = start_row, end_row do
-        self.marks:add('code_background', row, col, {
+        self.marks:add('code_background', row, self.node.start_col, {
             end_row = row + 1,
             hl_group = highlight,
             hl_eol = true,
         })
-        if win_col > 0 and #padding > 0 then
-            -- Overwrite anything beyond width with padding highlight
-            self.marks:add('code_background', row, col, {
+        if not padding:empty() and win_col > 0 then
+            -- overwrite anything beyond width with padding
+            self.marks:add('code_background', row, self.node.start_col, {
                 priority = 0,
-                virt_text = padding,
+                virt_text = padding:get(),
                 virt_text_win_col = win_col,
             })
         end
@@ -250,18 +251,18 @@ function Render:padding(background)
     local highlight = background and self.info.highlight or nil
 
     for row = start_row, end_row do
-        local line = {}
+        local line = self.config:line()
         if vim.tbl_contains(empty, row) then
-            self:append(line, col)
+            line:pad(col)
         end
-        self:append(line, self.data.margin)
+        line:pad(self.data.margin)
         if row > start_row and row < end_row then
-            self:append(line, self.data.padding, highlight)
+            line:pad(self.data.padding, highlight)
         end
-        if #line > 0 then
+        if not line:empty() then
             self.marks:add(false, row, col, {
                 priority = priority,
-                virt_text = line,
+                virt_text = line:get(),
                 virt_text_pos = 'inline',
             })
         end

lua/render-markdown/render/code_inline.lua

@@ -29,20 +29,21 @@ end
 ---@param highlight string
 ---@param left boolean
 function Render:padding(highlight, left)
-    local line, icon_highlight = {}, colors.bg_as_fg(highlight)
+    local line = self.config:line()
+    local icon_highlight = colors.bg_as_fg(highlight)
     if left then
-        self:append(line, self.info.inline_left, icon_highlight)
-        self:append(line, self.info.inline_pad, highlight)
+        line:text(self.info.inline_left, icon_highlight)
+        line:pad(self.info.inline_pad, highlight)
     else
-        self:append(line, self.info.inline_pad, highlight)
-        self:append(line, self.info.inline_right, icon_highlight)
+        line:pad(self.info.inline_pad, highlight)
+        line:text(self.info.inline_right, icon_highlight)
     end
-    if #line > 0 then
+    if not line:empty() then
         local row = left and self.node.start_row or self.node.end_row
         local col = left and self.node.start_col or self.node.end_col
         self.marks:add(true, row, col, {
             priority = 0,
-            virt_text = line,
+            virt_text = line:get(),
             virt_text_pos = 'inline',
         })
     end