feat: improve autolink handling

## Details

Problem mentioned here: #244

For autolinks (emails & bare URLs) just like with wiki links we conceal
all of the text then inline a modified version with our icon using a
single extmark. This works but for longer strings can make things look
choppy when removing the mark under the cursor row.

To improve this for autolinks we'll instead split the one mark into 4
separate smaller ones:

- Conceal the starting '<'
- Conceal the ending '>'
- Inline the icon at the start
- Apply highlight over the link text

Doing the same thing for wiki links would be more complicated to support
aliases so will leave those as is for now.

Author: MeanderingProgrammer

lua/render-markdown/health.lua

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

lua/render-markdown/render/base.lua

@@ -61,17 +61,19 @@ function Base:checkbox_scope(paragraph, highlight)
 end
 
 ---@protected
+---@param icon string
+---@param highlight string
 ---@param destination string
----@return render.md.LinkComponent?
-function Base:link_component(destination)
-    local link = self.config.link
-    local link_components = Iter.table.filter(link.custom, function(link_component)
-        return destination:find(link_component.pattern) ~= nil
+---@return string, string
+function Base:from_destination(icon, highlight, destination)
+    local components = Iter.table.filter(self.config.link.custom, function(component)
+        return destination:find(component.pattern) ~= nil
     end)
-    table.sort(link_components, function(a, b)
+    table.sort(components, function(a, b)
         return Str.width(a.pattern) < Str.width(b.pattern)
     end)
-    return link_components[#link_components]
+    local component = components[#components] or {}
+    return component.icon or icon, component.highlight or highlight
 end
 
 ---@protected

lua/render-markdown/render/link.lua

@@ -1,78 +1,63 @@
 local Base = require('render-markdown.render.base')
 
 ---@class render.md.data.Link
----@field text string
+---@field icon string
 ---@field highlight string
----@field conceal boolean
+---@field autolink boolean
 
 ---@class render.md.render.Link: render.md.Renderer
----@field private link render.md.Link
 ---@field private data render.md.data.Link
 local Render = setmetatable({}, Base)
 Render.__index = Render
 
 ---@return boolean
 function Render:setup()
-    self.link = self.config.link
-    if not self.link.enabled then
+    local link = self.config.link
+    if not link.enabled then
         return false
     end
 
+    local icon, highlight, autolink = link.hyperlink, link.highlight, false
     if self.node.type == 'email_autolink' then
-        local email = self.node.text:sub(2, -2)
-        self.data = {
-            text = self.link.email .. email,
-            highlight = self.link.highlight,
-            conceal = true,
-        }
-    elseif self.node.type == 'full_reference_link' then
-        self.data = {
-            text = self.link.hyperlink,
-            highlight = self.link.highlight,
-            conceal = false,
-        }
+        icon = link.email
+        autolink = true
     elseif self.node.type == 'image' then
-        self.data = {
-            text = self.link.image,
-            highlight = self.link.highlight,
-            conceal = false,
-        }
+        icon = link.image
     elseif self.node.type == 'inline_link' then
         local destination = self.node:child('link_destination')
-        local component = destination ~= nil and self:link_component(destination.text) or nil
-        local text, highlight = self.link.hyperlink, nil
-        if component ~= nil then
-            text, highlight = component.icon, component.highlight
+        if destination ~= nil then
+            icon, highlight = self:from_destination(icon, highlight, destination.text)
         end
-        self.data = {
-            text = text,
-            highlight = highlight or self.link.highlight,
-            conceal = false,
-        }
     elseif self.node.type == 'uri_autolink' then
         local destination = self.node.text:sub(2, -2)
-        local component = self:link_component(destination)
-        local text, highlight = self.link.hyperlink, nil
-        if component ~= nil then
-            text, highlight = component.icon, component.highlight
-        end
-        self.data = {
-            text = text .. destination,
-            highlight = highlight or self.link.highlight,
-            conceal = true,
-        }
-    else
-        return false
+        icon, highlight = self:from_destination(icon, highlight, destination)
+        autolink = true
     end
+    self.data = { icon = icon, highlight = highlight, autolink = autolink }
 
     return true
 end
 
 function Render:render()
     self.marks:add_over('link', self.node, {
-        virt_text = { { self.data.text, self.data.highlight } },
+        virt_text = { { self.data.icon, self.data.highlight } },
         virt_text_pos = 'inline',
-        conceal = self.data.conceal and '' or nil,
+    })
+    if self.data.autolink then
+        self:hide_bracket(self.node.start_col)
+        self.marks:add_over('link', self.node, {
+            hl_group = self.data.highlight,
+        })
+        self:hide_bracket(self.node.end_col - 1)
+    end
+end
+
+---@private
+---@param col integer
+function Render:hide_bracket(col)
+    self.marks:add(true, self.node.start_row, col, {
+        end_col = col + 1,
+        conceal = '',
     })
 end
 

lua/render-markdown/render/shortcut.lua

@@ -99,13 +99,9 @@ function Render:wiki_link()
     end
 
     local parts = Str.split(self.node.text:sub(2, -2), '|')
-    local component = self:link_component(parts[1])
-    local icon, highlight = self.link.wiki.icon, nil
-    if component ~= nil then
-        icon, highlight = component.icon, component.highlight
-    end
+    local icon, highlight = self:from_destination(self.link.wiki.icon, self.link.wiki.highlight, parts[1])
     self.marks:add_over('link', self.node, {
-        virt_text = { { icon .. parts[#parts], highlight or self.link.wiki.highlight } },
+        virt_text = { { icon .. parts[#parts], highlight } },
         virt_text_pos = 'inline',
         conceal = '',
     }, { 0, -1, 0, 1 })

tests/ad_hoc_spec.lua

@@ -32,21 +32,35 @@ end
 ---@param row integer
 ---@param start_col integer
 ---@param end_col integer
----@param link_text string
+---@param text string
 ---@param highlight 'Link'|'WikiLink'
----@param conceal string?
+---@param conceal? string
 ---@return render.md.MarkInfo
-local function link(row, start_col, end_col, link_text, highlight, conceal)
+local function link(row, start_col, end_col, text, highlight, conceal)
     ---@type render.md.MarkInfo
     return {
         row = { row, row },
         col = { start_col, end_col },
-        virt_text = { { link_text, util.hl(highlight) } },
+        virt_text = { { text, util.hl(highlight) } },
         virt_text_pos = 'inline',
         conceal = conceal,
     }
 end
 
+---@param row integer
+---@param start_col integer
+---@param end_col integer
+---@param icon string
+---@return render.md.MarkInfo[]
+local function auto_link(row, start_col, end_col, icon)
+    return {
+        util.conceal(row, start_col, start_col + 1),
+        link(row, start_col, end_col, icon, 'Link', nil),
+        util.highlight(row, start_col, end_col, 'Link'),
+        util.conceal(row, end_col - 1, end_col),
+    }
+end
+
 describe('ad_hoc.md', function()
     it('custom', function()
         util.setup('tests/data/ad_hoc.md')
@@ -71,12 +85,12 @@ describe('ad_hoc.md', function()
 
         vim.list_extend(expected, {
             util.bullet(row:increment(), 0, 1),
-            link(row:get(), 2, 20, '󰀓 test@example.com', 'Link', ''),
+            auto_link(row:get(), 2, 20, '󰀓 '),
         })
 
         vim.list_extend(expected, {
             util.bullet(row:increment(), 0, 1),
-            link(row:get(), 2, 26, '󰊤 http://www.github.com/', 'Link', ''),
+            auto_link(row:get(), 2, 26, '󰊤 '),
         })
 
         vim.list_extend(expected, {

tests/custom_handler_spec.lua

@@ -26,7 +26,7 @@ describe('custom_handler.md', function()
         local expected, row = {}, util.row()
         vim.list_extend(expected, {
             util.heading(row:get(), 1), -- Heading
-            util.inline_code(row:increment(2), 0, 8), -- Inline code
+            util.highlight(row:increment(2), 0, 8, 'CodeInline'), -- Inline code
             {}, -- No backslash escapes
         })
 
@@ -72,7 +72,7 @@ describe('custom_handler.md', function()
         local expected, row = {}, util.row()
         vim.list_extend(expected, {
             util.heading(row:get(), 1), -- Heading
-            util.inline_code(row:increment(2), 0, 8), -- Inline code
+            util.highlight(row:increment(2), 0, 8, 'CodeInline'), -- Inline code
             { util.conceal(row:increment(2), 0, 1), util.conceal(row:get(), 7, 8) }, -- Backslash escapes
         })
 

tests/list_table_spec.lua

@@ -14,7 +14,7 @@ describe('list_table.md', function()
             util.bullet(row:increment(2), 0, 1),
             util.link(row:get(), 20, 47, 'web'),
             util.bullet(row:increment(), 0, 1),
-            util.inline_code(row:get(), 20, 28),
+            util.highlight(row:get(), 20, 28, 'CodeInline'),
             util.bullet(row:increment(), 2, 2, 2),
             util.bullet(row:increment(), 4, 2),
             util.bullet(row:increment(), 6, 3),
@@ -31,7 +31,7 @@ describe('list_table.md', function()
         vim.list_extend(expected, {
             util.table_border(row:increment(2), true, { 8, 15, 7, 6 }),
             util.table_pipe(row:get(), 0, true),
-            util.inline_code(row:get(), 2, 8),
+            util.highlight(row:get(), 2, 8, 'CodeInline'),
             util.table_padding(row:get(), 9, 2),
             util.table_pipe(row:get(), 9, true),
             util.table_padding(row:get(), 11, 3),
@@ -43,7 +43,7 @@ describe('list_table.md', function()
         table.insert(expected, util.table_delimiter(row:increment(), { { 1, 7 }, { 1, 13, 1 }, { 6, 1 }, 6 }))
         vim.list_extend(expected, {
             util.table_pipe(row:increment(), 0, false),
-            util.inline_code(row:get(), 2, 8),
+            util.highlight(row:get(), 2, 8, 'CodeInline'),
             util.table_padding(row:get(), 9, 2),
             util.table_pipe(row:get(), 9, false),
             util.table_padding(row:get(), 11, 4),

tests/table_spec.lua

@@ -14,12 +14,12 @@ describe('table.md', function()
             util.table_pipe(row:get(), 0, true),
             util.table_pipe(row:get(), 12, true),
             util.table_padding(row:get(), 14, 13),
-            util.inline_code(row:get(), 14, 25),
+            util.highlight(row:get(), 14, 25, 'CodeInline'),
             util.conceal(row:get(), 26, 37),
             util.table_pipe(row:get(), 37, true),
             util.table_delimiter(row:increment(), { 11, { 23, 1 } }),
             util.table_pipe(row:increment(), 0, false),
-            util.inline_code(row:get(), 2, 12),
+            util.highlight(row:get(), 2, 12, 'CodeInline'),
             util.table_padding(row:get(), 13, 2),
             util.table_pipe(row:get(), 13, false),
             util.table_padding(row:get(), 15, 16),
@@ -78,12 +78,12 @@ describe('table.md', function()
             util.table_border(row:increment(2), true, { 11, 11 }),
             util.table_pipe(row:get(), 0, true),
             util.table_pipe(row:get(), 12, true),
-            util.inline_code(row:get(), 14, 25),
+            util.highlight(row:get(), 14, 25, 'CodeInline'),
             util.conceal(row:get(), 26, 37),
             util.table_pipe(row:get(), 37, true),
             util.table_delimiter(row:increment(), { 11, { 10, 1 } }, 13),
             util.table_pipe(row:increment(), 0, false),
-            util.inline_code(row:get(), 2, 12),
+            util.highlight(row:get(), 2, 12, 'CodeInline'),
             util.table_padding(row:get(), 13, 2),
             util.table_pipe(row:get(), 13, false),
             util.table_padding(row:get(), 15, 3),
@@ -141,11 +141,11 @@ describe('table.md', function()
             util.heading(row:get(), 1),
             util.table_pipe(row:increment(2), 0, true),
             util.table_pipe(row:get(), 12, true),
-            util.inline_code(row:get(), 14, 25),
+            util.highlight(row:get(), 14, 25, 'CodeInline'),
             util.table_pipe(row:get(), 37, true),
             util.table_delimiter(row:increment(), { 11, { 23, 1 } }),
             util.table_pipe(row:increment(), 0, false),
-            util.inline_code(row:get(), 2, 12),
+            util.highlight(row:get(), 2, 12, 'CodeInline'),
             util.table_pipe(row:get(), 13, false),
             util.link(row:get(), 15, 38, 'web'),
             util.table_pipe(row:get(), 39, false),
@@ -211,10 +211,10 @@ describe('table.md', function()
             util.heading(row:get(), 1),
             util.table_border(row:increment(2), true, { 11, 24 }),
             table_row(row:get(), 38, '│ Heading 1 │ `Heading 2`            │', true),
-            util.inline_code(row:get(), 14, 25),
+            util.highlight(row:get(), 14, 25, 'CodeInline'),
             util.table_delimiter(row:increment(), { 11, { 23, 1 } }),
             table_row(row:increment(), 40, '│ `Item 行` │ [link](https://行.com) │', false),
-            util.inline_code(row:get(), 2, 12),
+            util.highlight(row:get(), 2, 12, 'CodeInline'),
             util.link(row:get(), 15, 38, 'web'),
             table_row(row:increment(), 39, '│ <1> │ ==Itém 2==             │', false),
             util.inline_highlight(row:get(), 14, 25),

tests/util.lua

@@ -142,8 +142,8 @@ function M.heading(row, level)
     local background_mark = {
         row = { row, row + 1 },
         col = { 0, 0 },
-        hl_group = background,
         hl_eol = true,
+        hl_group = background,
     }
     return { sign_mark, icon_mark, background_mark }
 end
@@ -181,14 +181,15 @@ end
 ---@param row integer
 ---@param start_col integer
 ---@param end_col integer
+---@param highlight string
 ---@return render.md.MarkInfo
-function M.inline_code(row, start_col, end_col)
+function M.highlight(row, start_col, end_col, highlight)
     ---@type render.md.MarkInfo
     return {
         row = { row, row },
         col = { start_col, end_col },
         hl_eol = false,
-        hl_group = M.hl('CodeInline'),
+        hl_group = M.hl(highlight),
     }
 end
 
@@ -197,14 +198,11 @@ end
 ---@param end_col integer
 ---@return render.md.MarkInfo[]
 function M.inline_highlight(row, start_col, end_col)
-    ---@type render.md.MarkInfo
-    local mark = {
-        row = { row, row },
-        col = { start_col, end_col },
-        hl_eol = false,
-        hl_group = M.hl('InlineHighlight'),
+    return {
+        M.conceal(row, start_col, start_col + 2),
+        M.highlight(row, start_col, end_col, 'InlineHighlight'),
+        M.conceal(row, end_col - 2, end_col),
     }
-    return { M.conceal(row, start_col, start_col + 2), mark, M.conceal(row, end_col - 2, end_col) }
 end
 
 ---@param row integer