feat: Add support for wiki links

## Details

Another version of a shortcut link, when enclosed in double square
brackets. Support for using alias instead of direct link.

Feature comes from obsidian: https://help.obsidian.md/Linking+notes+and+files/Internal+links

Author: MeanderingProgrammer

CHANGELOG.md

@@ -21,6 +21,7 @@
 
 ### Features
 
+- Performance only parse & render visible range [c7a2055](https://github.com/MeanderingProgrammer/markdown.nvim/commit/c7a20552b83c2abad92ac5e52feb7fe3b929f0a7)
 - Support full buftype options [9a8a2e5](https://github.com/MeanderingProgrammer/markdown.nvim/commit/9a8a2e5bd204931646f1559235c7c4a7680ecbcd)
 - Inline heading position [#107](https://github.com/MeanderingProgrammer/markdown.nvim/issues/107)
   [345596b](https://github.com/MeanderingProgrammer/markdown.nvim/commit/345596bb6ef2b0c0a145c59906c2e84dbddfbbd4)

README.md

@@ -167,7 +167,7 @@ require('render-markdown').setup({
     inline_query = [[
         (code_span) @code
 
-        (shortcut_link) @callout
+        (shortcut_link) @shortcut
 
         [(inline_link) (full_reference_link) (image)] @link
     ]],

doc/render-markdown.txt

@@ -1,4 +1,4 @@
-*render-markdown.txt*          For 0.10.0          Last change: 2024 August 01
+*render-markdown.txt*          For 0.10.0          Last change: 2024 August 02
 
 ==============================================================================
 Table of Contents                          *render-markdown-table-of-contents*
@@ -200,7 +200,7 @@ Full Default Configuration ~
         inline_query = [[
             (code_span) @code
 
-            (shortcut_link) @callout
+            (shortcut_link) @shortcut
 
             [(inline_link) (full_reference_link) (image)] @link
         ]],

lua/render-markdown/handler/markdown_inline.lua

@@ -21,8 +21,8 @@ function M.parse(root, buf)
         logger.debug_node_info(capture, info)
         if capture == 'code' then
             list.add_mark(marks, M.code(config, info))
-        elseif capture == 'callout' then
-            list.add_mark(marks, M.callout(config, buf, info))
+        elseif capture == 'shortcut' then
+            list.add_mark(marks, M.shortcut(config, buf, info))
         elseif capture == 'link' then
             list.add_mark(marks, M.link(config, buf, info))
         else
@@ -62,11 +62,32 @@ end
 ---@param buf integer
 ---@param info render.md.NodeInfo
 ---@return render.md.Mark?
-function M.callout(config, buf, info)
+function M.shortcut(config, buf, info)
+    local callout = component.callout(config, info.text, 'exact')
+    if callout ~= nil then
+        return M.callout(config, buf, info, callout)
+    end
+    local checkbox = component.checkbox(config, info.text, 'exact')
+    if checkbox ~= nil then
+        return M.checkbox(config, info, checkbox)
+    end
+    local line = vim.api.nvim_buf_get_lines(buf, info.start_row, info.start_row + 1, true)[1]
+    if line:find('[' .. info.text .. ']', 1, true) ~= nil then
+        return M.wiki_link(config, info)
+    end
+    return nil
+end
+
+---@private
+---@param config render.md.BufferConfig
+---@param buf integer
+---@param info render.md.NodeInfo
+---@param callout render.md.CustomComponent
+---@return render.md.Mark?
+function M.callout(config, buf, info, callout)
     ---Support for overriding title: https://help.obsidian.md/Editing+and+formatting/Callouts#Change+the+title
-    ---@param callout render.md.CustomComponent
     ---@return string, string?
-    local function custom_title(callout)
+    local function custom_title()
         local content = ts.parent(buf, info, 'inline')
         if content ~= nil then
             local line = str.split(content.text, '\n')[1]
@@ -79,51 +100,81 @@ function M.callout(config, buf, info)
         return callout.rendered, nil
     end
 
-    local callout = component.callout(config, info.text, 'exact')
-    if callout ~= nil then
-        if not config.quote.enabled then
-            return nil
-        end
-        local text, conceal = custom_title(callout)
-        ---@type render.md.Mark
-        return {
-            conceal = true,
-            start_row = info.start_row,
-            start_col = info.start_col,
-            opts = {
-                end_row = info.end_row,
-                end_col = info.end_col,
-                virt_text = { { text, callout.highlight } },
-                virt_text_pos = 'overlay',
-                conceal = conceal,
-            },
-        }
-    else
-        if not config.checkbox.enabled then
-            return nil
-        end
-        -- Requires inline extmarks
-        if not util.has_10 then
-            return nil
-        end
-        local checkbox = component.checkbox(config, info.text, 'exact')
-        if checkbox == nil then
-            return nil
-        end
-        ---@type render.md.Mark
-        return {
-            conceal = true,
-            start_row = info.start_row,
-            start_col = info.start_col,
-            opts = {
-                end_row = info.end_row,
-                end_col = info.end_col,
-                virt_text = { { str.pad_to(info.text, checkbox.rendered), checkbox.highlight } },
-                virt_text_pos = 'inline',
-                conceal = '',
-            },
-        }
+    if not config.quote.enabled then
+        return nil
     end
+    local text, conceal = custom_title()
+    ---@type render.md.Mark
+    return {
+        conceal = true,
+        start_row = info.start_row,
+        start_col = info.start_col,
+        opts = {
+            end_row = info.end_row,
+            end_col = info.end_col,
+            virt_text = { { text, callout.highlight } },
+            virt_text_pos = 'overlay',
+            conceal = conceal,
+        },
+    }
+end
+
+---@private
+---@param config render.md.BufferConfig
+---@param info render.md.NodeInfo
+---@param checkbox render.md.CustomComponent
+---@return render.md.Mark?
+function M.checkbox(config, info, checkbox)
+    if not config.checkbox.enabled then
+        return nil
+    end
+    -- Requires inline extmarks
+    if not util.has_10 then
+        return nil
+    end
+    ---@type render.md.Mark
+    return {
+        conceal = true,
+        start_row = info.start_row,
+        start_col = info.start_col,
+        opts = {
+            end_row = info.end_row,
+            end_col = info.end_col,
+            virt_text = { { str.pad_to(info.text, checkbox.rendered), checkbox.highlight } },
+            virt_text_pos = 'inline',
+            conceal = '',
+        },
+    }
+end
+
+---@private
+---@param config render.md.BufferConfig
+---@param info render.md.NodeInfo
+---@return render.md.Mark?
+function M.wiki_link(config, info)
+    local link = config.link
+    if not link.enabled then
+        return nil
+    end
+    -- Requires inline extmarks
+    if not util.has_10 then
+        return nil
+    end
+    local text = info.text:sub(2, -2)
+    local elements = str.split(text, '|')
+    ---@type render.md.Mark
+    return {
+        conceal = true,
+        start_row = info.start_row,
+        start_col = info.start_col - 1,
+        opts = {
+            end_row = info.end_row,
+            end_col = info.end_col + 1,
+            virt_text = { { link.hyperlink .. elements[#elements], link.highlight } },
+            virt_text_pos = 'inline',
+            conceal = '',
+        },
+    }
 end
 
 ---@private
@@ -158,7 +209,7 @@ function M.link(config, buf, info)
         opts = {
             end_row = info.end_row,
             end_col = info.end_col,
-            virt_text = { { icon, config.link.highlight } },
+            virt_text = { { icon, link.highlight } },
             virt_text_pos = 'inline',
         },
     }

lua/render-markdown/init.lua

@@ -184,7 +184,7 @@ M.default_config = {
     inline_query = [[
         (code_span) @code
 
-        (shortcut_link) @callout
+        (shortcut_link) @shortcut
 
         [(inline_link) (full_reference_link) (image)] @link
     ]],

lua/render-markdown/manager.lua

@@ -28,7 +28,7 @@ function M.setup()
             for _, win in ipairs(vim.v.event.windows) do
                 local buf = util.win_to_buf(win)
                 if vim.tbl_contains(buffers, buf) then
-                    ui.debcoune_update(buf)
+                    ui.debounce_update(buf)
                 end
             end
         end,
@@ -41,7 +41,7 @@ function M.set_all(enabled)
     M.attach(vim.api.nvim_get_current_buf())
     state.enabled = enabled
     for _, buf in ipairs(buffers) do
-        ui.debcoune_update(buf)
+        ui.debounce_update(buf)
     end
 end
 
@@ -73,7 +73,7 @@ function M.attach(buf)
         group = M.group,
         buffer = buf,
         callback = function()
-            ui.debcoune_update(buf)
+            ui.debounce_update(buf)
         end,
     })
 end

lua/render-markdown/ui.lua

@@ -34,7 +34,7 @@ function M.clear(buf)
 end
 
 ---@param buf integer
-function M.debcoune_update(buf)
+function M.debounce_update(buf)
     local buf_state = cache[buf] or buffer_state.new(buf)
     cache[buf] = buf_state
     buf_state:debounce(state.get_config(buf).debounce, M.update)

tests/ad_hoc_spec.lua

@@ -0,0 +1,35 @@
+---@module 'luassert'
+
+local util = require('tests.util')
+
+---@param row integer
+---@param start_col integer
+---@param end_col integer
+---@param text string
+---@return render.md.MarkInfo
+local function wiki_link(row, start_col, end_col, text)
+    ---@type render.md.MarkInfo
+    return {
+        row = { row, row },
+        col = { start_col, end_col },
+        virt_text = { { '󰌹 ' .. text, util.hl('Link') } },
+        virt_text_pos = 'inline',
+        conceal = '',
+    }
+end
+
+describe('ad_hoc.md', function()
+    it('default', function()
+        util.setup('tests/data/ad_hoc.md')
+
+        local expected = {}
+        vim.list_extend(expected, util.heading(0, 1))
+        vim.list_extend(expected, {
+            wiki_link(4, 0, 13, 'Basic One'),
+            wiki_link(6, 0, 23, 'With Alias'),
+        })
+
+        local actual = util.get_actual_marks()
+        util.marks_are_equal(expected, actual)
+    end)
+end)

tests/data/ad_hoc.md

@@ -0,0 +1,7 @@
+# Heading
+
+[Normal Shortcut]
+
+[[Basic One]] Then normal text
+
+[[Nickname|With Alias]] Something important