feat: make custom link order deterministic

## Details

Request: #146

Currently we pick the first matching custom link when selecting an icon
for a destination. However because our table is keyed on strings we
iterate through it using pairs and the order of pairs is not
deterministic.

To fix this collect all matching patterns into a list. Then pick the
match with the longest string pattern length. The idea being that longer
patterns are more specific and likely are what the user prefers to use.
This allows doing fallbacks, like www.example.com for a specific website
then www. for all other websites.

Author: MeanderingProgrammer

doc/render-markdown.txt

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

lua/render-markdown/handler/markdown_inline.lua

@@ -196,12 +196,21 @@ end
 ---@return string, string
 function Handler:dest_virt_text(destination)
     local link = self.config.link
-    for _, link_component in pairs(link.custom) do
-        if destination:find(link_component.pattern) then
-            return link_component.icon, link_component.highlight
-        end
+
+    ---@type render.md.LinkComponent[]
+    local link_components = vim.tbl_filter(function(link_component)
+        return destination:find(link_component.pattern) ~= nil
+    end, link.custom)
+    table.sort(link_components, function(a, b)
+        return str.width(a.pattern) < str.width(b.pattern)
+    end)
+
+    if #link_components > 0 then
+        local link_component = link_components[#link_components]
+        return link_component.icon, link_component.highlight
+    else
+        return link.hyperlink, link.highlight
     end
-    return link.hyperlink, link.highlight
 end
 
 ---@class render.md.handler.MarkdownInline: render.md.Handler

lua/render-markdown/health.lua

@@ -5,7 +5,7 @@ local M = {}
 
 ---@private
 ---@type string
-M.version = '6.2.5'
+M.version = '6.2.6'
 
 function M.check()
     vim.health.start('render-markdown.nvim [version]')

lua/render-markdown/node_info.lua

@@ -36,11 +36,11 @@ end
 
 ---@param infos render.md.NodeInfo[]
 function NodeInfo.sort_inplace(infos)
-    table.sort(infos, function(info1, info2)
-        if info1.start_row ~= info2.start_row then
-            return info1.start_row < info2.start_row
+    table.sort(infos, function(a, b)
+        if a.start_row ~= b.start_row then
+            return a.start_row < b.start_row
         else
-            return info1.start_col < info2.start_col
+            return a.start_col < b.start_col
         end
     end)
 end

tests/ad_hoc_spec.lua

@@ -3,32 +3,42 @@
 local util = require('tests.util')
 
 ---@param row integer
----@param col integer
+---@param length integer
 ---@param link_text string
----@return render.md.MarkInfo
-local function conceal_link(row, col, link_text)
+---@param conceal string?
+---@return render.md.MarkInfo[]
+local function bullet_link(row, length, link_text, conceal)
     ---@type render.md.MarkInfo
-    return {
+    local link = {
         row = { row, row },
-        col = { 0, col },
+        col = { 2, 2 + length },
         virt_text = { { link_text, util.hl('Link') } },
         virt_text_pos = 'inline',
-        conceal = '',
+        conceal = conceal,
     }
+    return { util.bullet(row, 0, 1), link }
 end
 
 describe('ad_hoc.md', function()
-    it('default', function()
-        util.setup('tests/data/ad_hoc.md')
+    it('custom', function()
+        util.setup('tests/data/ad_hoc.md', {
+            link = {
+                custom = {
+                    youtube = { pattern = 'www%.youtube%.com/', icon = ' ', highlight = util.hl('Link') },
+                },
+            },
+        })
 
         local expected, row = {}, util.row()
 
         vim.list_extend(expected, util.heading(row:get(), 1))
 
         vim.list_extend(expected, {
-            conceal_link(row:increment(4), 13, '󰌹 Basic One'),
-            conceal_link(row:increment(2), 23, '󰌹 With Alias'),
-            conceal_link(row:increment(2), 18, '󰀓 [email protected]'),
+            util.bullet(row:increment(2), 0, 1),
+            bullet_link(row:increment(), 13, '󰌹 Basic One', ''),
+            bullet_link(row:increment(), 23, '󰌹 With Alias', ''),
+            bullet_link(row:increment(), 18, '󰀓 [email protected]', ''),
+            bullet_link(row:increment(), 59, ' ', nil),
         })
 
         local actual = util.get_actual_marks()

tests/data/ad_hoc.md

@@ -1,9 +1,7 @@
 # Heading
 
-[Normal Shortcut]
-
-[[Basic One]] Then normal text
-
-[[Nickname|With Alias]] Something important
-
-<[email protected]> Email
+- [Normal Shortcut]
+- [[Basic One]] Then normal text
+- [[Nickname|With Alias]] Something important
+- <[email protected]> Email
+- [Youtube Link](https://www.youtube.com/watch?v=dQw4w9WgXcQ)