fix: ignore callouts outside of quotes and checkboxes outside of lists

## Details

Previously `shortcut_links` would be rendered immediately if the
contents matched any configured callouts or checkboxes. This isn't
exactly harmful, but does mean, for instance, that a checkbox pattern at
the start of a block quote will have its icon rendered and a list with a
callout will have its icon rendered, which goes against the definition
of these concepts.

To fix this we now render both callouts and checkboxes through the main
`markdown` handler rather than as part of the inline logic. Callouts
while rendering block quotes, and checkboxes while rendering list items.
This is possible now that we store the nodes along with their
configurations inside the context.

Handling callouts is straightforward, we copy paste the logic that was
in the `shortcut` render for callouts into the `quote` render module and
apply the logic to the values stored inside the context if they exist.

Handling checkboxes is more complicated since we were already rendering
checkboxes in the `markdown` handler and handling part of the rendering
in the `bullet` render. Basically the logic ended up being split between
`shortcut`, `bullet`, & `checkbox` with shared logic stored in `base` to
produce consistent results, yuk.

To improve this state and solve the problem a new `list` render
implementation was added which gets used in place of where `bullet` is
currently. The implementation of it runs the checkbox render, if that
returns false (meaning no checkbox is present), then it runs the bullet
render. This means the checkbox render no longer runs on checkbox nodes
directly but instead on the parent list item, so the checkbox query is
removed from the `markdown` handler.

The `bullet` part of the rendering remains almost completely unchanged,
the only difference is all the checkbox handling like hiding marks is
removed and configuration can now happen more in the `setup` method.

The `checkbox` render is updated to handle running on a list item, which
means finding the node associated with the checkbox (if it exists). From
there hide the mark of the list, render the marker (which allows this
logic to be removed from base), and highlight the scope.

In addition to fixing this problem the logic is now all located in a
single place which should make adding features easier.

The fallback pattern of list could end up being useful for rendering
other things, but currently this is the only instance of diverging logic
when rendering the same exact thing, so leaving it as a one off for now.

Other changes:

- use generic `config` name throughout when getting a specific config
  from `context`, rather than something specific like `latex`
- remove `self.config` from `Base` render fields, instead config must be
  pulled via `self.context.config`, usually once in each implementation
- since the `config` name is no longer being used rename all instances
  of `self.info` to `self.config`, which no stores the specific
  configuration of what is being rendered

Author: MeanderingProgrammer

lua/render-markdown/handler/latex.lua

@@ -16,12 +16,12 @@ M.cache = {}
 ---@return render.md.Mark[]
 function M.parse(ctx)
     local context = Context.get(ctx.buf)
-    local latex = context.config.latex
-    if context:skip(latex) then
+    local config = context.config.latex
+    if context:skip(config) then
         return {}
     end
-    if vim.fn.executable(latex.converter) ~= 1 then
-        log.add('debug', 'executable not found', latex.converter)
+    if vim.fn.executable(config.converter) ~= 1 then
+        log.add('debug', 'executable not found', config.converter)
         return {}
     end
 
@@ -30,30 +30,30 @@ function M.parse(ctx)
 
     local raw_expression = M.cache[node.text]
     if not raw_expression then
-        raw_expression = vim.fn.system(latex.converter, node.text)
+        raw_expression = vim.fn.system(config.converter, node.text)
         if vim.v.shell_error == 1 then
-            log.add('error', latex.converter, raw_expression)
+            log.add('error', config.converter, raw_expression)
             raw_expression = 'error'
         end
         M.cache[node.text] = raw_expression
     end
 
     local expressions = {} ---@type string[]
-    for _ = 1, latex.top_pad do
+    for _ = 1, config.top_pad do
         expressions[#expressions + 1] = ''
     end
     for _, expression in ipairs(Str.split(raw_expression, '\n', true)) do
         expressions[#expressions + 1] = Str.pad(node.start_col) .. expression
     end
-    for _ = 1, latex.bottom_pad do
+    for _ = 1, config.bottom_pad do
         expressions[#expressions + 1] = ''
     end
 
     local lines = Iter.list.map(expressions, function(expression)
-        return { { expression, latex.highlight } }
+        return { { expression, config.highlight } }
     end)
 
-    local above = latex.position == 'above'
+    local above = config.position == 'above'
     local row = above and node.start_row or node.end_row
 
     local marks = Marks.new(context, true)

lua/render-markdown/handler/markdown.lua

@@ -16,11 +16,6 @@ function Handler.new(buf)
     self.query = ts.parse(
         'markdown',
         [[
-            [
-                (task_list_marker_unchecked)
-                (task_list_marker_checked)
-            ] @checkbox
-
             (fenced_code_block) @code
 
             [
@@ -48,12 +43,11 @@ function Handler.new(buf)
         ]]
     )
     self.renders = {
-        checkbox = require('render-markdown.render.markdown.checkbox'),
         code = require('render-markdown.render.markdown.code'),
         dash = require('render-markdown.render.markdown.dash'),
         document = require('render-markdown.render.markdown.document'),
         heading = require('render-markdown.render.markdown.heading'),
-        list = require('render-markdown.render.markdown.bullet'),
+        list = require('render-markdown.render.markdown.list'),
         paragraph = require('render-markdown.render.markdown.paragraph'),
         quote = require('render-markdown.render.markdown.quote'),
         section = require('render-markdown.render.markdown.section'),

lua/render-markdown/health.lua

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

lua/render-markdown/lib/node.lua

@@ -175,6 +175,12 @@ function Node:child(target, row)
     return nil
 end
 
+---@return render.md.Node?
+function Node:scope()
+    local node = self:child('paragraph')
+    return node and node:child('inline')
+end
+
 ---@param callback fun(node: render.md.Node)
 function Node:for_each_child(callback)
     for node in self.node:iter_children() do

lua/render-markdown/render/base.lua

@@ -1,10 +1,8 @@
 local Indent = require('render-markdown.lib.indent')
-local Str = require('render-markdown.lib.str')
 local colors = require('render-markdown.core.colors')
 
 ---@class render.md.Render
 ---@field protected context render.md.request.Context
----@field protected config render.md.main.Config
 ---@field protected marks render.md.Marks
 ---@field protected node render.md.Node
 ---@field protected setup fun(self: render.md.Render): boolean
@@ -19,7 +17,6 @@ Base.__index = Base
 function Base:execute(context, marks, node)
     local instance = setmetatable({}, self)
     instance.context = context
-    instance.config = context.config
     instance.marks = marks
     instance.node = node
     if instance:setup() then
@@ -30,6 +27,12 @@ function Base:execute(context, marks, node)
     end
 end
 
+---@protected
+---@return render.md.Line
+function Base:line()
+    return self.context.config:line()
+end
+
 ---@protected
 ---@return render.md.Indent
 function Base:indent()
@@ -41,7 +44,7 @@ end
 ---@param text? string
 ---@param highlight? string
 function Base:sign(enabled, text, highlight)
-    local config = self.config.sign
+    local config = self.context.config.sign
     if not config.enabled or not enabled or not text then
         return
     end
@@ -55,60 +58,4 @@ function Base:sign(enabled, text, highlight)
     })
 end
 
----@protected
----@param icon string
----@param highlight string
----@return boolean
-function Base:check_icon(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 = line:pad(right_pad):get(),
-            virt_text_pos = 'inline',
-            conceal = '',
-        }, { 0, 0, 0, 1 })
-    else
-        local fits = math.min(space, right_pad)
-        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:pad(fits):get(),
-            virt_text_pos = 'overlay',
-        })
-        if space > 0 then
-            -- hide extra space after the icon
-            self.marks:add('check_icon', row, end_col - space, {
-                end_col = end_col,
-                conceal = '',
-            })
-        end
-        if right_pad > 0 then
-            -- add padding
-            self.marks:add('check_icon', row, end_col, {
-                virt_text = self.config:line():pad(right_pad):get(),
-                virt_text_pos = 'inline',
-            })
-        end
-        return true
-    end
-end
-
----@protected
----@param element render.md.mark.Element
----@param node render.md.Node?
----@param highlight? string
-function Base:scope(element, node, highlight)
-    if not node or not highlight then
-        return
-    end
-    self.marks:over(element, node:child('inline'), { hl_group = highlight })
-end
-
 return Base

lua/render-markdown/render/html/comment.lua

@@ -1,15 +1,15 @@
 local Base = require('render-markdown.render.base')
 
 ---@class render.md.render.html.Comment: render.md.Render
----@field private info render.md.html.comment.Config
+---@field private config render.md.html.comment.Config
 local Render = setmetatable({}, Base)
 Render.__index = Render
 
 ---@protected
 ---@return boolean
 function Render:setup()
-    self.info = self.config.html.comment
-    if not self.info.conceal then
+    self.config = self.context.config.html.comment
+    if not self.config.conceal then
         return false
     end
     return true
@@ -18,9 +18,9 @@ end
 ---@protected
 function Render:run()
     self.marks:over(true, self.node, { conceal = '' })
-    if self.info.text then
+    if self.config.text then
         self.marks:start(true, self.node, {
-            virt_text = { { self.info.text, self.info.highlight } },
+            virt_text = { { self.config.text, self.config.highlight } },
             virt_text_pos = 'inline',
         })
     end

lua/render-markdown/render/html/tag.lua

@@ -1,7 +1,7 @@
 local Base = require('render-markdown.render.base')
 
 ---@class render.md.render.html.Tag: render.md.Render
----@field private info render.md.html.Tag
+---@field private config render.md.html.Tag
 local Render = setmetatable({}, Base)
 Render.__index = Render
 
@@ -16,16 +16,16 @@ function Render:setup()
     if not name then
         return false
     end
-    self.info = self.config.html.tag[name.text]
-    return self.info ~= nil
+    self.config = self.context.config.html.tag[name.text]
+    return self.config ~= nil
 end
 
 ---@protected
 function Render:run()
     self.marks:over(true, self.node:child('start_tag'), { conceal = '' })
     self.marks:over(true, self.node:child('end_tag'), { conceal = '' })
     self.marks:start(false, self.node, {
-        virt_text = { { self.info.icon, self.info.highlight } },
+        virt_text = { { self.config.icon, self.config.highlight } },
         virt_text_pos = 'inline',
     })
 end

lua/render-markdown/render/inline/code.lua

@@ -2,26 +2,26 @@ local Base = require('render-markdown.render.base')
 local colors = require('render-markdown.core.colors')
 
 ---@class render.md.render.inline.Code: render.md.Render
----@field private info render.md.code.Config
+---@field private config render.md.code.Config
 local Render = setmetatable({}, Base)
 Render.__index = Render
 
 ---@protected
 ---@return boolean
 function Render:setup()
-    self.info = self.config.code
-    if self.context:skip(self.info) then
+    self.config = self.context.config.code
+    if self.context:skip(self.config) then
         return false
     end
-    if not vim.tbl_contains({ 'normal', 'full' }, self.info.style) then
+    if not vim.tbl_contains({ 'normal', 'full' }, self.config.style) then
         return false
     end
     return true
 end
 
 ---@protected
 function Render:run()
-    local highlight = self.info.highlight_inline
+    local highlight = self.config.highlight_inline
     self.marks:over('code_background', self.node, { hl_group = highlight })
     self:padding(highlight, true)
     self:padding(highlight, false)
@@ -31,14 +31,14 @@ end
 ---@param highlight string
 ---@param left boolean
 function Render:padding(highlight, left)
-    local line = self.config:line()
+    local line = self:line()
     local icon_highlight = colors.bg_as_fg(highlight)
     if left then
-        line:text(self.info.inline_left, icon_highlight)
-        line:pad(self.info.inline_pad, highlight)
+        line:text(self.config.inline_left, icon_highlight)
+        line:pad(self.config.inline_pad, highlight)
     else
-        line:pad(self.info.inline_pad, highlight)
-        line:text(self.info.inline_right, icon_highlight)
+        line:pad(self.config.inline_pad, highlight)
+        line:text(self.config.inline_right, icon_highlight)
     end
     if not line:empty() then
         local row = left and self.node.start_row or self.node.end_row

lua/render-markdown/render/inline/highlight.lua

@@ -1,15 +1,15 @@
 local Base = require('render-markdown.render.base')
 
 ---@class render.md.render.inline.Highlight: render.md.Render
----@field private info render.md.inline.highlight.Config
+---@field private config render.md.inline.highlight.Config
 local Render = setmetatable({}, Base)
 Render.__index = Render
 
 ---@protected
 ---@return boolean
 function Render:setup()
-    self.info = self.config.inline_highlight
-    if self.context:skip(self.info) then
+    self.config = self.context.config.inline_highlight
+    if self.context:skip(self.config) then
         return false
     end
     return true
@@ -18,15 +18,15 @@ end
 ---@protected
 function Render:run()
     for _, range in ipairs(self.node:find('==[^=]+==')) do
-        -- Hide first 2 equal signs
+        -- hide first 2 equal signs
         self:hide_equals(range[1], range[2])
-        -- Highlight contents
+        -- highlight contents
         self.marks:add(false, range[1], range[2], {
             end_row = range[3],
             end_col = range[4],
-            hl_group = self.info.highlight,
+            hl_group = self.config.highlight,
         })
-        -- Hide last 2 equal signs
+        -- hide last 2 equal signs
         self:hide_equals(range[3], range[4] - 2)
     end
 end

lua/render-markdown/render/inline/link.lua

@@ -12,29 +12,29 @@ Render.__index = Render
 ---@protected
 ---@return boolean
 function Render:setup()
-    local link = self.config.link
-    if self.context:skip(link) then
+    local config = self.context.config.link
+    if self.context:skip(config) then
         return false
     end
     if self.node:descendant('shortcut_link') then
         return false
     end
     ---@type render.md.mark.Text
-    local icon = { link.hyperlink, link.highlight }
+    local icon = { config.hyperlink, config.highlight }
     local autolink = false
     if self.node.type == 'email_autolink' then
-        icon[1] = link.email
+        icon[1] = config.email
         autolink = true
     elseif self.node.type == 'image' then
-        icon[1] = link.image
+        icon[1] = config.image
     elseif self.node.type == 'inline_link' then
         local destination = self.node:child('link_destination')
         if destination then
-            self.config:link_text(destination.text, icon)
+            self.context.config:link_text(destination.text, icon)
         end
     elseif self.node.type == 'uri_autolink' then
         local destination = self.node.text:sub(2, -2)
-        self.config:link_text(destination, icon)
+        self.context.config:link_text(destination, icon)
         autolink = true
     end
     self.data = { icon = icon, autolink = autolink }