feature: Add inline icons to images & links

MeanderingProgrammer · MeanderingProgrammer · commit 501e5e014932 · 2024-07-09T11:32:03.000-07:00
## Details Request: #55 Adds `link` configuration with icons for images and hyperlinks and associated highlight group. Allow feature to be disabled. Requires neovim >= 0.10.0 for inline extmarks.
diff --git a/README.md b/README.md
@@ -29,6 +29,7 @@ Plugin to improve viewing Markdown files in Neovim
   - [Callouts](https://github.com/orgs/community/discussions/16925)
     - Github & Obsidian out of the box, supports user defined as well
   - Custom checkbox states, function similar to `callouts`
+  - Adds icon before images / links, requires neovim >= `0.10.0`
   - `LaTeX` blocks: renders formulas if `latex` parser and `pylatexenc` are installed
 - Disable rendering when file is larger than provided value
 - Support custom handlers which are ran identically to builtin handlers
@@ -149,6 +150,10 @@ require('render-markdown').setup({
         (code_span) @code
 
         (shortcut_link) @callout
+
+        (inline_link) @link
+
+        (image) @image
     ]],
     -- The level of logs to write to file: vim.fn.stdpath('state') .. '/render-markdown.log'
     -- Only intended to be used for plugin development / debugging
@@ -287,6 +292,16 @@ require('render-markdown').setup({
         example = { raw = '[!EXAMPLE]', rendered = '󰉹 Example', highlight = 'DiagnosticHint' },
         quote = { raw = '[!QUOTE]', rendered = '󱆨 Quote', highlight = '@markup.quote' },
     },
+    link = {
+        -- Turn on / off inline link icon behavior
+        enabled = true,
+        -- Inlined with 'image' elements
+        image = '󰥶 ',
+        -- Inlined with 'inline_link' elements
+        hyperlink = '󰌹 ',
+        -- Applies to the inlined icon
+        highlight = '@markup.link.label.markdown_inline',
+    },
     -- Window options to use that change between rendered and raw view
     win_options = {
         -- See :h 'conceallevel'
@@ -422,7 +437,7 @@ require('render-markdown').setup({
 })
 ```
 
-## Standard Quotes
+## Block Quotes
 
 ```lua
 require('render-markdown').setup({
@@ -496,6 +511,23 @@ require('render-markdown').setup({
 })
 ```
 
+## Links
+
+```lua
+require('render-markdown').setup({
+    link = {
+        -- Turn on / off inline link icon behavior
+        enabled = true,
+        -- Inlined with 'image' elements
+        image = '󰥶 ',
+        -- Inlined with 'inline_link' elements
+        hyperlink = '󰌹 ',
+        -- Applies to the inlined icon
+        highlight = '@markup.link.label.markdown_inline',
+    },
+})
+```
+
 # Additional Info
 
 - [Limitations](doc/limitations.md): Known limitations of this plugin
diff --git a/demo/heading_code.gif b/demo/heading_code.gif
diff --git a/demo/heading_code.md b/demo/heading_code.md
@@ -8,6 +8,8 @@
 
 ###### Heading 6
 
+![Image](example.png)
+
 ```python {filename="demo.py"}
 def main() -> None:
     sum = 0
diff --git a/demo/list_table.gif b/demo/list_table.gif
diff --git a/doc/render-markdown.txt b/doc/render-markdown.txt
@@ -16,9 +16,10 @@ Table of Contents                          *render-markdown-table-of-contents*
   - Dashed Line                            |render-markdown-setup-dashed-line|
   - List Bullets                          |render-markdown-setup-list-bullets|
   - Checkboxes                              |render-markdown-setup-checkboxes|
-  - Standard Quotes                    |render-markdown-setup-standard-quotes|
+  - Block Quotes                          |render-markdown-setup-block-quotes|
   - Tables                                      |render-markdown-setup-tables|
   - Callouts                                  |render-markdown-setup-callouts|
+  - Links                                        |render-markdown-setup-links|
 7. Additional Info                           |render-markdown-additional-info|
 
 ==============================================================================
@@ -56,6 +57,7 @@ Plugin to improve viewing Markdown files in Neovim
     - Callouts <https://github.com/orgs/community/discussions/16925>
         - Github & Obsidian out of the box, supports user defined as well
     - Custom checkbox states, function similar to `callouts`
+    - Adds icon before images / links, requires neovim >= `0.10.0`
     - `LaTeX` blocks: renders formulas if `latex` parser and `pylatexenc` are installed
 - Disable rendering when file is larger than provided value
 - Support custom handlers which are ran identically to builtin handlers
@@ -185,6 +187,10 @@ Full Default Configuration ~
             (code_span) @code
     
             (shortcut_link) @callout
+    
+            (inline_link) @link
+    
+            (image) @image
         ]],
         -- The level of logs to write to file: vim.fn.stdpath('state') .. '/render-markdown.log'
         -- Only intended to be used for plugin development / debugging
@@ -323,6 +329,16 @@ Full Default Configuration ~
             example = { raw = '[!EXAMPLE]', rendered = '󰉹 Example', highlight = 'DiagnosticHint' },
             quote = { raw = '[!QUOTE]', rendered = '󱆨 Quote', highlight = '@markup.quote' },
         },
+        link = {
+            -- Turn on / off inline link icon behavior
+            enabled = true,
+            -- Inlined with 'image' elements
+            image = '󰥶 ',
+            -- Inlined with 'inline_link' elements
+            hyperlink = '󰌹 ',
+            -- Applies to the inlined icon
+            highlight = '@markup.link.label.markdown_inline',
+        },
         -- Window options to use that change between rendered and raw view
         win_options = {
             -- See :h 'conceallevel'
@@ -462,7 +478,7 @@ CHECKBOXES                                  *render-markdown-setup-checkboxes*
 <
 
 
-STANDARD QUOTES                        *render-markdown-setup-standard-quotes*
+BLOCK QUOTES                              *render-markdown-setup-block-quotes*
 
 >lua
     require('render-markdown').setup({
@@ -539,6 +555,24 @@ CALLOUTS                                      *render-markdown-setup-callouts*
 <
 
 
+LINKS                                            *render-markdown-setup-links*
+
+>lua
+    require('render-markdown').setup({
+        link = {
+            -- Turn on / off inline link icon behavior
+            enabled = true,
+            -- Inlined with 'image' elements
+            image = '󰥶 ',
+            -- Inlined with 'inline_link' elements
+            hyperlink = '󰌹 ',
+            -- Applies to the inlined icon
+            highlight = '@markup.link.label.markdown_inline',
+        },
+    })
+<
+
+
 ==============================================================================
 7. Additional Info                           *render-markdown-additional-info*
 
diff --git a/lua/render-markdown/handler/markdown_inline.lua b/lua/render-markdown/handler/markdown_inline.lua
@@ -61,6 +61,25 @@ M.render_node = function(namespace, buf, capture, node)
                 conceal = '',
             })
         end
+    elseif vim.tbl_contains({ 'link', 'image' }, capture) then
+        local link = state.config.link
+        if not link.enabled then
+            return
+        end
+        -- Requires inline extmarks
+        if not util.has_10 then
+            return
+        end
+        local icon = link.hyperlink
+        if capture == 'image' then
+            icon = link.image
+        end
+        vim.api.nvim_buf_set_extmark(buf, namespace, start_row, start_col, {
+            end_row = end_row,
+            end_col = end_col,
+            virt_text = { { icon, link.highlight } },
+            virt_text_pos = 'inline',
+        })
     else
         -- Should only get here if user provides custom capture, currently unhandled
         logger.error('Unhandled inline capture: ' .. capture)
diff --git a/lua/render-markdown/health.lua b/lua/render-markdown/health.lua
@@ -127,6 +127,7 @@ function M.check_config(config)
         checkbox = { config.checkbox, 'table' },
         quote = { config.quote, 'table' },
         callout = { config.callout, 'table' },
+        link = { config.link, 'table' },
         win_options = { config.win_options, 'table' },
         custom_handlers = { config.custom_handlers, 'table' },
     })
@@ -220,6 +221,14 @@ function M.check_config(config)
         })
     end
 
+    local link = config.link
+    append_errors('link', {
+        enabled = { link.enabled, 'boolean' },
+        image = { link.image, 'string' },
+        hyperlink = { link.hyperlink, 'string' },
+        highlight = { link.highlight, 'string' },
+    })
+
     for name, win_option in pairs(config.win_options) do
         append_errors('win_options.' .. name, {
             default = { win_option.default, { 'number', 'string' } },
diff --git a/lua/render-markdown/init.lua b/lua/render-markdown/init.lua
@@ -11,6 +11,12 @@ local M = {}
 ---@field public default any
 ---@field public rendered any
 
+---@class render.md.UserLink
+---@field public enabled? boolean
+---@field public image? string
+---@field public hyperlink? string
+---@field public highlight? string
+
 ---@class render.md.UserPipeTable
 ---@field public style? 'full'|'normal'|'none'
 ---@field public cell? 'overlay'|'raw'
@@ -69,6 +75,7 @@ local M = {}
 ---@field public quote? render.md.UserBasicComponent
 ---@field public pipe_table? render.md.UserPipeTable
 ---@field public callout? table<string, render.md.UserCustomComponent>
+---@field public link? render.md.UserLink
 ---@field public win_options? table<string, render.md.WindowOption>
 ---@field public custom_handlers? table<string, render.md.Handler>
 
@@ -123,6 +130,10 @@ M.default_config = {
         (code_span) @code
 
         (shortcut_link) @callout
+
+        (inline_link) @link
+
+        (image) @image
     ]],
     -- The level of logs to write to file: vim.fn.stdpath('state') .. '/render-markdown.log'
     -- Only intended to be used for plugin development / debugging
@@ -261,6 +272,16 @@ M.default_config = {
         example = { raw = '[!EXAMPLE]', rendered = '󰉹 Example', highlight = 'DiagnosticHint' },
         quote = { raw = '[!QUOTE]', rendered = '󱆨 Quote', highlight = '@markup.quote' },
     },
+    link = {
+        -- Turn on / off inline link icon behavior
+        enabled = true,
+        -- Inlined with 'image' elements
+        image = '󰥶 ',
+        -- Inlined with 'inline_link' elements
+        hyperlink = '󰌹 ',
+        -- Applies to the inlined icon
+        highlight = '@markup.link.label.markdown_inline',
+    },
     -- Window options to use that change between rendered and raw view
     win_options = {
         -- See :h 'conceallevel'
diff --git a/lua/render-markdown/types.lua b/lua/render-markdown/types.lua
@@ -1,3 +1,9 @@
+---@class render.md.Link
+---@field public enabled boolean
+---@field public image string
+---@field public hyperlink string
+---@field public highlight string
+
 ---@class render.md.PipeTable
 ---@field public style 'full'|'normal'|'none'
 ---@field public cell 'overlay'|'raw'
@@ -56,5 +62,6 @@
 ---@field public quote render.md.BasicComponent
 ---@field public pipe_table render.md.PipeTable
 ---@field public callout table<string, render.md.CustomComponent>
+---@field public link render.md.Link
 ---@field public win_options table<string, render.md.WindowOption>
 ---@field public custom_handlers table<string, render.md.Handler>
diff --git a/scripts/update.py b/scripts/update.py
@@ -70,7 +70,7 @@ def update_readme(init_file: Path, readme_file: Path) -> None:
     text = readme_file.read_text().replace(old_config, new_config)
 
     parameters: list[str] = ["heading", "code", "dash", "bullet"]
-    parameters.extend(["checkbox", "quote", "pipe_table", "callout"])
+    parameters.extend(["checkbox", "quote", "pipe_table", "callout", "link"])
     for parameter in parameters:
         old_param = get_code_block(readme_file, f"\n    {parameter} = ", 2)
         new_param = wrap_setup(get_config_for(new_config, f"{parameter} = "))
diff --git a/tests/heading_code_spec.lua b/tests/heading_code_spec.lua
@@ -81,22 +81,32 @@ async_tests.describe('heading_code.md', function()
             },
         })
 
+        -- Image link
+        vim.list_extend(expected, {
+            {
+                row = { 10, 10 },
+                col = { 0, 21 },
+                virt_text = { { '󰥶 ', '@markup.link.label.markdown_inline' } },
+                virt_text_pos = 'inline',
+            },
+        })
+
         -- Code block
         vim.list_extend(expected, {
             {
-                row = { 10, 21 },
+                row = { 12, 23 },
                 col = { 0, 0 },
                 hl_eol = true,
                 hl_group = 'ColorColumn',
             },
             {
-                row = { 10, 10 },
+                row = { 12, 12 },
                 col = { 3, 9 },
                 sign_text = '󰌠 ',
                 sign_hl_group = 'MiniIconsYellow',
             },
             {
-                row = { 10 },
+                row = { 12 },
                 col = { 3 },
                 virt_text = { { '󰌠 python', { 'MiniIconsYellow', 'ColorColumn' } } },
                 virt_text_pos = 'inline',
diff --git a/tests/list_table_spec.lua b/tests/list_table_spec.lua
@@ -34,6 +34,13 @@ async_tests.describe('list_table.md', function()
                 virt_text = { { '●', 'Normal' } },
                 virt_text_pos = 'overlay',
             },
+            -- List Item 1, link
+            {
+                row = { 2, 2 },
+                col = { 20, 47 },
+                virt_text = { { '󰌹 ', '@markup.link.label.markdown_inline' } },
+                virt_text_pos = 'inline',
+            },
             -- List Item 2, bullet point
             {
                 row = { 3, 3 },
diff --git a/tests/table_spec.lua b/tests/table_spec.lua
@@ -66,6 +66,13 @@ async_tests.describe('table.md', function()
                 hl_eol = false,
                 hl_group = 'ColorColumn',
             },
+            -- Row link
+            {
+                row = { 4, 4 },
+                col = { 16, 47 },
+                virt_text = { { '󰌹 ', '@markup.link.label.markdown_inline' } },
+                virt_text_pos = 'inline',
+            },
         })
 
         -- Table no inline heading
@@ -230,6 +237,13 @@ async_tests.describe('table.md', function()
                 virt_text = { { '│', 'Normal' } },
                 virt_text_pos = 'overlay',
             },
+            -- Row link
+            {
+                row = { 4, 4 },
+                col = { 16, 47 },
+                virt_text = { { '󰌹 ', '@markup.link.label.markdown_inline' } },
+                virt_text_pos = 'inline',
+            },
             -- Row pipe 3
             {
                 row = { 4, 4 },
