fix: link icons following long checkboxes

## Details

Issue: #564

When checkboxes are wide (either from padding or from a lot of custom
text), a combination of overlay and inline virtual text is used to
render them. The problem is that the inline text (which appears at the
end) can use the same column value as inline link icons if a link is the
first thing after the checkbox, resulting in the inline text "swapping"
positions.

The fix is to use a really high priority value for inline link icons as
those should always appear next to the link they are for. By fixing the
link icon to the right location the inline checkbox text naturally ends
up in the correct location as well. This change is also applied to wiki
links, though is not strictly necessary in that context.

Unrelated change, use custom style when parsing queries, less noise.

Author: MeanderingProgrammer

lua/render-markdown/handler/html.lua

@@ -8,13 +8,11 @@ local M = {}
 ---@param ctx render.md.handler.Context
 ---@return render.md.Mark[]
 function M.parse(ctx)
-    local query = ts.parse(
-        'html',
-        [[
-            (comment) @comment
-            (element) @tag
-        ]]
-    )
+    -- stylua: ignore
+    local query = ts.parse('html', [[
+        (comment) @comment
+        (element) @tag
+    ]])
     ---@type table<string, render.md.Render>
     local renders = {
         comment = require('render-markdown.render.html.comment'),

lua/render-markdown/handler/markdown.lua

@@ -8,35 +8,33 @@ local M = {}
 ---@param ctx render.md.handler.Context
 ---@return render.md.Mark[]
 function M.parse(ctx)
-    local query = ts.parse(
-        'markdown',
-        [[
-            (fenced_code_block) @code
+    -- stylua: ignore
+    local query = ts.parse('markdown', [[
+        (fenced_code_block) @code
 
-            [
-                (thematic_break)
-                (minus_metadata)
-                (plus_metadata)
-            ] @dash
+        [
+            (thematic_break)
+            (minus_metadata)
+            (plus_metadata)
+        ] @dash
 
-            (document) @document
+        (document) @document
 
-            [
-                (atx_heading)
-                (setext_heading)
-            ] @heading
+        [
+            (atx_heading)
+            (setext_heading)
+        ] @heading
 
-            (list_item) @list
+        (list_item) @list
 
-            (section (paragraph) @paragraph)
+        (section (paragraph) @paragraph)
 
-            (block_quote) @quote
+        (block_quote) @quote
 
-            (section) @section
+        (section) @section
 
-            (pipe_table) @table
-        ]]
-    )
+        (pipe_table) @table
+    ]])
     ---@type table<string, render.md.Render>
     local renders = {
         code = require('render-markdown.render.markdown.code'),

lua/render-markdown/handler/markdown_inline.lua

@@ -8,25 +8,23 @@ local M = {}
 ---@param ctx render.md.handler.Context
 ---@return render.md.Mark[]
 function M.parse(ctx)
-    local query = ts.parse(
-        'markdown_inline',
-        [[
-            (code_span) @code
+    -- stylua: ignore
+    local query = ts.parse('markdown_inline', [[
+        (code_span) @code
 
-            ((inline) @highlight
-                (#lua-match? @highlight "==[^=]+=="))
+        ((inline) @highlight
+            (#lua-match? @highlight "==[^=]+=="))
 
-            [
-                (email_autolink)
-                (full_reference_link)
-                (image)
-                (inline_link)
-                (uri_autolink)
-            ] @link
+        [
+            (email_autolink)
+            (full_reference_link)
+            (image)
+            (inline_link)
+            (uri_autolink)
+        ] @link
 
-            (shortcut_link) @shortcut
-        ]]
-    )
+        (shortcut_link) @shortcut
+    ]])
     ---@type table<string, render.md.Render>
     local renders = {
         code = require('render-markdown.render.inline.code'),

lua/render-markdown/handler/yaml.lua

@@ -8,15 +8,13 @@ local M = {}
 ---@param ctx render.md.handler.Context
 ---@return render.md.Mark[]
 function M.parse(ctx)
-    local query = ts.parse(
-        'yaml',
-        [[
-            (block_sequence_item) @bullet
+    -- stylua: ignore
+    local query = ts.parse('yaml', [[
+        (block_sequence_item) @bullet
 
-            ((double_quote_scalar) @link
-                (#lua-match? @link "^\"%[%[.+%]%]\"$"))
-        ]]
-    )
+        ((double_quote_scalar) @link
+            (#lua-match? @link "^\"%[%[.+%]%]\"$"))
+    ]])
     ---@type table<string, render.md.Render>
     local renders = {
         bullet = require('render-markdown.render.yaml.bullet'),

lua/render-markdown/health.lua

@@ -6,7 +6,7 @@ local state = require('render-markdown.state')
 local M = {}
 
 ---@private
-M.version = '8.10.5'
+M.version = '8.10.6'
 
 function M.check()
     M.start('versions')

lua/render-markdown/render/common/wiki.lua

@@ -51,6 +51,7 @@ function Render:run()
     if not body then
         -- add icon
         self.marks:add(self.config, 'link', row, start_col, {
+            priority = 9000,
             hl_mode = 'combine',
             virt_text = { icon },
             virt_text_pos = 'inline',

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

@@ -49,6 +49,7 @@ end
 ---@protected
 function Render:run()
     self.marks:start(self.config, 'link', self.node, {
+        priority = 9000,
         hl_mode = 'combine',
         virt_text = { self.data.icon },
         virt_text_pos = 'inline',

lua/render-markdown/render/markdown/quote.lua

@@ -81,13 +81,11 @@ end
 
 ---@private
 function Render:markers()
-    local query = ts.parse(
-        'markdown',
-        [[
-            (block_quote_marker) @marker
-            (block_continuation) @continuation
-        ]]
-    )
+    -- stylua: ignore
+    local query = ts.parse('markdown', [[
+        (block_quote_marker) @marker
+        (block_continuation) @continuation
+    ]])
     self.context.view:nodes(self.node:get(), query, function(capture, node)
         if capture == 'marker' then
             -- marker nodes are a single '>' at the start of a block quote

tests/util.lua

@@ -133,6 +133,7 @@ function M.link(kind)
     local highlight = kind == 'wiki' and 'RmWikiLink' or 'RmLink'
     ---@type vim.api.keyset.set_extmark
     return {
+        priority = 9000,
         hl_mode = 'combine',
         virt_text = { { icons[kind], highlight } },
         virt_text_pos = 'inline',