feat: add icon to emails

Author: MeanderingProgrammer

README.md

@@ -31,34 +31,31 @@ Plugin to improve viewing Markdown files in Neovim
 
 # Features
 
-- Functions entirely inside of Neovim with no external windows
-- Changes between `rendered` view in normal mode and `raw` view in all other modes
-- Supports anti-conceal behavior, removing any virtual text added by this plugin
-  on the line the cursor is on, this can be disabled
-- Changes window options between `rendered` and `raw` view based on configuration
-  - Effects `conceallevel` & `concealcursor` by default
-- Supports rendering `markdown` injected into any file type
-- Renders the following `markdown` components:
-  - Headings: highlight depending on level and replaces `#` with icon
-  - Horizontal breaks: replace with full-width lines
-  - Code blocks: highlight to better stand out
-    - Adds language icon [^1], requires icon provider (`mini.icons` or `nvim-web-devicons`)
-    - Left pad lines within block [^1]
-  - Inline code: highlight to better stand out
-  - List bullet points: replace with provided icon based on level
-  - Checkboxes: replace with provided icon based on whether they are checked
-  - Block quotes: replace leading `>` with provided icon
-  - Tables: replace border characters, handles misaligned tables but does NOT align
-    according to delimiter indicator
-  - [Callouts](https://github.com/orgs/community/discussions/16925): Github & Obsidian
-    out of the box, supports user defined as well
-  - Custom checkbox states [^1], function similar to `callouts`
-  - Adds icon before images / links [^1]
-  - `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
+- Contained: runs entirely inside Neovim with no external windows
+- Configurable: all components, padding, icons, and colors can be modified
+- File type agnostic: can render `markdown` injected into any file
+- Mode based rendering: changes between `rendered` and `raw` view based on mode
+- Anti-conceal: hides virtual text added by this plugin on cursor line
+- Window options: changes option values between `rendered` and `raw` view
+- Large files: only renders visisble range, can be entirely disabled based on size
+- Custom rendering: provides extension point where user can add anything
+- Renders the following `markdown` components out of the box:
+  - Headings: icon, color, border, padding [^1], width
+  - Code blocks: background, language icon [^1] [^2], border, padding [^1], width
+  - Code inline: background
+  - Horizontal breaks: icon, color, width
+  - List bullets: icon, color, padding [^1]
+  - Checkboxes: icon, color, user defined states [^1]
+  - Block quotes: icon, color, line breaks [^1]
+  - Callouts: icon, color, user defined values, Github & Obsidian defaults
+  - Tables: border, color, alignment indicator, auto align cells always to left [^1]
+  - Links [^1]: icon, color, user defined destinations
+  - `LaTeX` blocks [^3]: renders formulas
+  - Org indent mode [^1]: per level padding
 
 [^1]: Requires neovim >= `0.10.0`
+[^2]: Requires icon provider, `mini.icons` or `nvim-web-devicons`
+[^3]: Requires `latex` parser and `pylatexenc`
 
 # Requirements
 
@@ -199,7 +196,12 @@ require('render-markdown').setup({
 
         (shortcut_link) @shortcut
 
-        [(inline_link) (full_reference_link) (image)] @link
+        [
+            (image)
+            (email_autolink)
+            (inline_link)
+            (full_reference_link)
+        ] @link
     ]],
     -- The level of logs to write to file: vim.fn.stdpath('state') .. '/render-markdown.log'
     -- Only intended to be used for plugin development / debugging
@@ -470,6 +472,8 @@ require('render-markdown').setup({
         enabled = true,
         -- Inlined with 'image' elements
         image = '󰥶 ',
+        -- Inlined with 'email_autolink' elements
+        email = '󰀓 ',
         -- Fallback icon for 'inline_link' elements
         hyperlink = '󰌹 ',
         -- Applies to the fallback inlined icon
@@ -861,6 +865,8 @@ require('render-markdown').setup({
         enabled = true,
         -- Inlined with 'image' elements
         image = '󰥶 ',
+        -- Inlined with 'email_autolink' elements
+        email = '󰀓 ',
         -- Fallback icon for 'inline_link' elements
         hyperlink = '󰌹 ',
         -- Applies to the fallback inlined icon

doc/render-markdown.txt

@@ -1,4 +1,4 @@
-*render-markdown.txt*          For 0.10.0          Last change: 2024 August 22
+*render-markdown.txt*          For 0.10.0          Last change: 2024 August 23
 
 ==============================================================================
 Table of Contents                          *render-markdown-table-of-contents*
@@ -52,32 +52,27 @@ Plugin to improve viewing Markdown files in Neovim
 ==============================================================================
 2. Features                                         *render-markdown-features*
 
-- Functions entirely inside of Neovim with no external windows
-- Changes between `rendered` view in normal mode and `raw` view in all other modes
-- Supports anti-conceal behavior, removing any virtual text added by this plugin
-    on the line the cursor is on, this can be disabled
-- Changes window options between `rendered` and `raw` view based on configuration
-    - Effects `conceallevel` & `concealcursor` by default
-- Supports rendering `markdown` injected into any file type
-- Renders the following `markdown` components:
-    - Headings: highlight depending on level and replaces `#` with icon
-    - Horizontal breaks: replace with full-width lines
-    - Code blocks: highlight to better stand out
-        - Adds language icon , requires icon provider (`mini.icons` or `nvim-web-devicons`)
-        - Left pad lines within block 
-    - Inline code: highlight to better stand out
-    - List bullet points: replace with provided icon based on level
-    - Checkboxes: replace with provided icon based on whether they are checked
-    - Block quotes: replace leading `>` with provided icon
-    - Tables: replace border characters, handles misaligned tables but does NOT align
-        according to delimiter indicator
-    - 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 
-    - `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
+- Contained: runs entirely inside Neovim with no external windows
+- Configurable: all components, padding, icons, and colors can be modified
+- File type agnostic: can render `markdown` injected into any file
+- Mode based rendering: changes between `rendered` and `raw` view based on mode
+- Anti-conceal: hides virtual text added by this plugin on cursor line
+- Window options: changes option values between `rendered` and `raw` view
+- Large files: only renders visisble range, can be entirely disabled based on size
+- Custom rendering: provides extension point where user can add anything
+- Renders the following `markdown` components out of the box:
+    - Headings: icon, color, border, padding , width
+    - Code blocks: background, language icon  , border, padding , width
+    - Code inline: background
+    - Horizontal breaks: icon, color, width
+    - List bullets: icon, color, padding 
+    - Checkboxes: icon, color, user defined states 
+    - Block quotes: icon, color, line breaks 
+    - Callouts: icon, color, user defined values, Github & Obsidian defaults
+    - Tables: border, color, alignment indicator, auto align cells always to left 
+    - Links : icon, color, user defined destinations
+    - `LaTeX` blocks : renders formulas
+    - Org indent mode : per level padding
 
 
 ==============================================================================
@@ -230,7 +225,12 @@ Full Default Configuration ~
 
             (shortcut_link) @shortcut
 
-            [(inline_link) (full_reference_link) (image)] @link
+            [
+                (image)
+                (email_autolink)
+                (inline_link)
+                (full_reference_link)
+            ] @link
         ]],
         -- The level of logs to write to file: vim.fn.stdpath('state') .. '/render-markdown.log'
         -- Only intended to be used for plugin development / debugging
@@ -501,6 +501,8 @@ Full Default Configuration ~
             enabled = true,
             -- Inlined with 'image' elements
             image = '󰥶 ',
+            -- Inlined with 'email_autolink' elements
+            email = '󰀓 ',
             -- Fallback icon for 'inline_link' elements
             hyperlink = '󰌹 ',
             -- Applies to the fallback inlined icon
@@ -908,6 +910,8 @@ Wiki Page
             enabled = true,
             -- Inlined with 'image' elements
             image = '󰥶 ',
+            -- Inlined with 'email_autolink' elements
+            email = '󰀓 ',
             -- Fallback icon for 'inline_link' elements
             hyperlink = '󰌹 ',
             -- Applies to the fallback inlined icon

lua/render-markdown/handler/markdown_inline.lua

@@ -158,25 +158,28 @@ function Handler:link(info)
     if not self.config.link.enabled then
         return
     end
-    local icon, highlight = self:link_virt_text(info)
+    local link_text, highlight, conceal = self:link_virt_text(info)
     local added = self.marks:add(true, info.start_row, info.start_col, {
         end_row = info.end_row,
         end_col = info.end_col,
-        virt_text = { { icon, highlight } },
+        virt_text = { { link_text, highlight } },
         virt_text_pos = 'inline',
+        conceal = conceal,
     })
-    if added then
-        self.context:add_offset(info, str.width(icon))
+    if conceal == nil and added then
+        self.context:add_offset(info, str.width(link_text))
     end
 end
 
 ---@private
 ---@param info render.md.NodeInfo
----@return string, string
+---@return string, string, string?
 function Handler:link_virt_text(info)
     local link = self.config.link
     if info.type == 'image' then
         return link.image, link.highlight
+    elseif info.type == 'email_autolink' then
+        return link.email .. info.text:sub(2, -2), link.highlight, ''
     elseif info.type == 'inline_link' then
         local destination = info:child('link_destination')
         if destination ~= nil then

lua/render-markdown/health.lua

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

lua/render-markdown/init.lua

@@ -38,6 +38,7 @@ local M = {}
 ---@class (exact) render.md.UserLink
 ---@field public enabled? boolean
 ---@field public image? string
+---@field public email? string
 ---@field public hyperlink? string
 ---@field public highlight? string
 ---@field public custom? table<string, render.md.UserLinkComponent>
@@ -239,7 +240,12 @@ M.default_config = {
 
         (shortcut_link) @shortcut
 
-        [(inline_link) (full_reference_link) (image)] @link
+        [
+            (image)
+            (email_autolink)
+            (inline_link)
+            (full_reference_link)
+        ] @link
     ]],
     -- The level of logs to write to file: vim.fn.stdpath('state') .. '/render-markdown.log'
     -- Only intended to be used for plugin development / debugging
@@ -510,6 +516,8 @@ M.default_config = {
         enabled = true,
         -- Inlined with 'image' elements
         image = '󰥶 ',
+        -- Inlined with 'email_autolink' elements
+        email = '󰀓 ',
         -- Fallback icon for 'inline_link' elements
         hyperlink = '󰌹 ',
         -- Applies to the fallback inlined icon

lua/render-markdown/state.lua

@@ -353,6 +353,7 @@ function M.validate()
             append_errors(path .. '.link', link, {
                 enabled = { link.enabled, 'boolean', nilable },
                 image = { link.image, 'string', nilable },
+                email = { link.email, 'string', nilable },
                 hyperlink = { link.hyperlink, 'string', nilable },
                 highlight = { link.highlight, 'string', nilable },
                 custom = { link.custom, 'table', nilable },

lua/render-markdown/types.lua

@@ -27,6 +27,7 @@
 ---@class (exact) render.md.Link
 ---@field public enabled boolean
 ---@field public image string
+---@field public email string
 ---@field public hyperlink string
 ---@field public highlight string
 ---@field public custom table<string, render.md.LinkComponent>

tests/ad_hoc_spec.lua

@@ -3,16 +3,15 @@
 local util = require('tests.util')
 
 ---@param row integer
----@param start_col integer
----@param end_col integer
----@param text string
+---@param col integer
+---@param link_text string
 ---@return render.md.MarkInfo
-local function wiki_link(row, start_col, end_col, text)
+local function conceal_link(row, col, link_text)
     ---@type render.md.MarkInfo
     return {
         row = { row, row },
-        col = { start_col, end_col },
-        virt_text = { { '󰌹 ' .. text, util.hl('Link') } },
+        col = { 0, col },
+        virt_text = { { link_text, util.hl('Link') } },
         virt_text_pos = 'inline',
         conceal = '',
     }
@@ -27,8 +26,9 @@ describe('ad_hoc.md', function()
         vim.list_extend(expected, util.heading(row:get(), 1))
 
         vim.list_extend(expected, {
-            wiki_link(row:increment(4), 0, 13, 'Basic One'),
-            wiki_link(row:increment(2), 0, 23, 'With Alias'),
+            conceal_link(row:increment(4), 13, '󰌹 Basic One'),
+            conceal_link(row:increment(2), 23, '󰌹 With Alias'),
+            conceal_link(row:increment(2), 18, '󰀓 [email protected]'),
         })
 
         local actual = util.get_actual_marks()

tests/data/ad_hoc.md

@@ -5,3 +5,5 @@
 [[Basic One]] Then normal text
 
 [[Nickname|With Alias]] Something important
+
+<[email protected]> Email

tests/util.lua

@@ -223,12 +223,7 @@ end
 ---@param head boolean
 ---@return render.md.MarkInfo
 function M.table_pipe(row, col, head)
-    local highlight
-    if head then
-        highlight = 'TableHead'
-    else
-        highlight = 'TableRow'
-    end
+    local highlight = head and 'TableHead' or 'TableRow'
     ---@type render.md.MarkInfo
     return {
         row = { row, row },