feat: user configurable anti conceal per component

## Details

Request: #204

Previously the decoration elements that are hidden on the cursor line
was not something the user had direct control over.

The default behavior was to never hide virtual lines, spacing, signs or
code backgrounds. All other decorations on the line would always be
hidden if the user kept anti conceal enabled.

For the time being virtual lines and spacing remain permanently enabled.

However signs, code backgrounds and most other elements that by default
would be hidden are entirely within the users control.

This is all managed through the new `anti_conceal.ignore` property. This
table is a mapping from element name to a boolean. A value of `true` for
an element means it will not be concealed when the cursor enters the
line. A value of `false` behaves the same as no value being set and will
be hidden. A table is used rather than a list so that when users modify
values the defaults remain the same as they were unless explicitely changed.

Signs and code backgrounds set their values to `true` to remain ignored by
default as before, however now users have the ability to change this
behavior if they would like to hide signs and backgrounds.

Additionally most other decorations that remain concealable by default
like before can now be ignored if the user sets their value to true. A
complete list of possible values is provided in the default configuration
in the README.

Author: MeanderingProgrammer

Diff for: CHANGELOG.md

@@ -10,6 +10,8 @@
 - allow empty lists for all heading properties [0c6de74](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/0c6de743a8d3c61b87bc7db9ab97dcda12ca6818)
 - wiki link config & language highlight [#205](https://github.com/MeanderingProgrammer/render-markdown.nvim/issues/205)
   [965c222](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/965c222076b2d289ed498730845d533780f3c7c7)
+- code language name [#205](https://github.com/MeanderingProgrammer/render-markdown.nvim/issues/205)
+  [18c7ef7](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/18c7ef71fb4b8d83cb0160adc9127fc4d65ca42e)
 
 ### Bug Fixes
 

Diff for: README.md

@@ -169,6 +169,13 @@ require('render-markdown').setup({
     anti_conceal = {
         -- This enables hiding any added text on the line the cursor is on
         enabled = true,
+        -- Which elements to always show, ignoring anti conceal behavior. Possible values are:
+        --  head_icon, head_background, head_border, code_language, code_background, code_border
+        --  dash, bullet, check_icon, check_scope, quote, table_border, callout, link, sign
+        ignore = {
+            code_background = true,
+            sign = true,
+        },
         -- Number of lines above cursor to show
         above = 0,
         -- Number of lines below cursor to show

Diff for: doc/render-markdown.txt

@@ -1,4 +1,4 @@
-*render-markdown.txt*          For 0.10.0         Last change: 2024 October 12
+*render-markdown.txt*          For 0.10.0         Last change: 2024 October 13
 
 ==============================================================================
 Table of Contents                          *render-markdown-table-of-contents*
@@ -218,6 +218,13 @@ Default Configuration ~
         anti_conceal = {
             -- This enables hiding any added text on the line the cursor is on
             enabled = true,
+            -- Which elements to always show, ignoring anti conceal behavior. Possible values are:
+            --  head_icon, head_background, head_border, code_language, code_background, code_border
+            --  dash, bullet, check_icon, check_scope, quote, table_border, callout, link, sign
+            ignore = {
+                code_background = true,
+                sign = true,
+            },
             -- Number of lines above cursor to show
             above = 0,
             -- Number of lines below cursor to show

Diff for: lua/render-markdown/core/list.lua

@@ -2,13 +2,16 @@ local log = require('render-markdown.core.log')
 local util = require('render-markdown.core.util')
 
 ---@class render.md.Marks
+---@field private ignore table<render.md.Element, boolean>
 ---@field private marks render.md.Mark[]
 local Marks = {}
 Marks.__index = Marks
 
+---@param ignore table<render.md.Element, boolean>
 ---@return render.md.Marks
-function Marks.new()
+function Marks.new(ignore)
     local self = setmetatable({}, Marks)
+    self.ignore = ignore
     self.marks = {}
     return self
 end
@@ -18,15 +21,15 @@ function Marks:get()
     return self.marks
 end
 
----@param conceal boolean
+---@param element boolean|render.md.Element
 ---@param start_row integer
 ---@param start_col integer
 ---@param opts vim.api.keyset.set_extmark
 ---@return boolean
-function Marks:add(conceal, start_row, start_col, opts)
+function Marks:add(element, start_row, start_col, opts)
     ---@type render.md.Mark
     local mark = {
-        conceal = conceal,
+        conceal = self:conceal(element),
         start_row = start_row,
         start_col = start_col,
         opts = opts,
@@ -44,12 +47,24 @@ function Marks:add(conceal, start_row, start_col, opts)
     return true
 end
 
+---@private
+---@param element boolean|render.md.Element
+---@return boolean
+function Marks:conceal(element)
+    if type(element) == 'boolean' then
+        return element
+    else
+        return self.ignore[element] ~= true
+    end
+end
+
 ---@class render.md.ListHelper
 local M = {}
 
+---@param ignore? table<render.md.Element, boolean>
 ---@return render.md.Marks
-function M.new_marks()
-    return Marks.new()
+function M.new_marks(ignore)
+    return Marks.new(ignore or {})
 end
 
 ---@generic T

Diff for: lua/render-markdown/handler/markdown.lua

@@ -4,9 +4,9 @@ local state = require('render-markdown.state')
 local treesitter = require('render-markdown.core.treesitter')
 
 ---@class render.md.handler.buf.Markdown
----@field private marks render.md.Marks
 ---@field private config render.md.buffer.Config
 ---@field private context render.md.Context
+---@field private marks render.md.Marks
 ---@field private query vim.treesitter.Query
 ---@field private renderers table<string, render.md.Renderer>
 local Handler = {}
@@ -16,9 +16,9 @@ Handler.__index = Handler
 ---@return render.md.handler.buf.Markdown
 function Handler.new(buf)
     local self = setmetatable({}, Handler)
-    self.marks = list.new_marks()
     self.config = state.get(buf)
     self.context = Context.get(buf)
+    self.marks = list.new_marks(self.config.anti_conceal.ignore)
     self.query = treesitter.parse(
         'markdown',
         [[

Diff for: lua/render-markdown/handler/markdown_inline.lua

@@ -4,9 +4,9 @@ local state = require('render-markdown.state')
 local treesitter = require('render-markdown.core.treesitter')
 
 ---@class render.md.handler.buf.MarkdownInline
----@field private marks render.md.Marks
 ---@field private config render.md.buffer.Config
 ---@field private context render.md.Context
+---@field private marks render.md.Marks
 ---@field private query vim.treesitter.Query
 ---@field private renderers table<string, render.md.Renderer>
 local Handler = {}
@@ -16,9 +16,9 @@ Handler.__index = Handler
 ---@return render.md.handler.buf.MarkdownInline
 function Handler.new(buf)
     local self = setmetatable({}, Handler)
-    self.marks = list.new_marks()
     self.config = state.get(buf)
     self.context = Context.get(buf)
+    self.marks = list.new_marks(self.config.anti_conceal.ignore)
     self.query = treesitter.parse(
         'markdown_inline',
         [[

Diff for: lua/render-markdown/health.lua

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

Diff for: lua/render-markdown/init.lua

@@ -174,8 +174,26 @@ local M = {}
 ---@class (exact) render.md.UserPadding
 ---@field public highlight? string
 
+---@alias render.md.Element
+---| 'head_icon'
+---| 'head_background'
+---| 'head_border'
+---| 'code_language'
+---| 'code_background'
+---| 'code_border'
+---| 'dash'
+---| 'bullet'
+---| 'check_icon'
+---| 'check_scope'
+---| 'quote'
+---| 'table_border'
+---| 'callout'
+---| 'link'
+---| 'sign'
+
 ---@class (exact) render.md.UserAntiConceal
 ---@field public enabled? boolean
+---@field public ignore? table<render.md.Element, boolean>
 ---@field public above? integer
 ---@field public below? integer
 
@@ -262,6 +280,13 @@ M.default_config = {
     anti_conceal = {
         -- This enables hiding any added text on the line the cursor is on
         enabled = true,
+        -- Which elements to always show, ignoring anti conceal behavior. Possible values are:
+        --  head_icon, head_background, head_border, code_language, code_background, code_border
+        --  dash, bullet, check_icon, check_scope, quote, table_border, callout, link, sign
+        ignore = {
+            code_background = true,
+            sign = true,
+        },
         -- Number of lines above cursor to show
         above = 0,
         -- Number of lines below cursor to show

Diff for: lua/render-markdown/render/base.lua

@@ -38,7 +38,7 @@ function Base:sign(text, highlight)
     if highlight ~= nil then
         sign_highlight = colors.combine(highlight, sign_highlight)
     end
-    self.marks:add(false, self.info.start_row, self.info.start_col, {
+    self.marks:add('sign', self.info.start_row, self.info.start_col, {
         sign_text = text,
         sign_hl_group = sign_highlight,
     })

Diff for: lua/render-markdown/render/checkbox.lua

@@ -46,7 +46,7 @@ end
 function Render:icon()
     local icon = self.checkbox.icon
     local text = self.inline and icon or str.pad_to(self.info.text, icon) .. icon
-    self.marks:add(true, self.info.start_row, self.info.start_col, {
+    self.marks:add('check_icon', self.info.start_row, self.info.start_col, {
         end_row = self.info.end_row,
         end_col = self.info.end_col,
         virt_text = { { text, self.checkbox.highlight } },
@@ -65,7 +65,7 @@ function Render:highlight_scope()
     if paragraph == nil then
         return
     end
-    self.marks:add(true, paragraph.start_row, paragraph.start_col, {
+    self.marks:add('check_scope', paragraph.start_row, paragraph.start_col, {
         end_row = paragraph.end_row,
         end_col = paragraph.end_col,
         hl_group = highlight,

Diff for: lua/render-markdown/render/code.lua

@@ -125,7 +125,7 @@ function Render:language(add_background)
             local padding = str.spaces('start', self.info.text) + self.data.language_padding
             icon_text = str.pad(padding) .. icon_text .. info.text
         end
-        return self.marks:add(true, info.start_row, info.start_col, {
+        return self.marks:add('code_language', info.start_row, info.start_col, {
             virt_text = { { icon_text, highlight } },
             virt_text_pos = 'inline',
         })
@@ -137,7 +137,7 @@ function Render:language(add_background)
         if self.code.width == 'block' then
             win_col = win_col - str.width(icon_text) + self.data.indent
         end
-        return self.marks:add(true, info.start_row, 0, {
+        return self.marks:add('code_language', info.start_row, 0, {
             virt_text = { { icon_text, highlight } },
             virt_text_win_col = win_col,
         })
@@ -160,7 +160,7 @@ function Render:background(icon_added)
                 table.insert(virt_text, { str.pad(self.data.margin), self.config.padding.highlight })
             end
             table.insert(virt_text, { icon:rep(width - self.data.col), colors.bg_to_fg(self.code.highlight) })
-            self.marks:add(true, row, self.data.col, {
+            self.marks:add('code_border', row, self.data.col, {
                 virt_text = virt_text,
                 virt_text_pos = 'overlay',
             })
@@ -181,14 +181,14 @@ function Render:background(icon_added)
         table.insert(padding, { str.pad(vim.o.columns * 2), self.config.padding.highlight })
     end
     for row = self.data.start_row, self.data.end_row - 1 do
-        self.marks:add(false, row, self.data.col, {
+        self.marks:add('code_background', row, self.data.col, {
             end_row = row + 1,
             hl_group = self.code.highlight,
             hl_eol = true,
         })
         if win_col > 0 and #padding > 0 then
             -- Overwrite anything beyond width with padding highlight
-            self.marks:add(false, row, self.data.col, {
+            self.marks:add('code_background', row, self.data.col, {
                 priority = 0,
                 virt_text = padding,
                 virt_text_win_col = win_col,

Diff for: lua/render-markdown/render/code_inline.lua

@@ -24,7 +24,7 @@ function Render:setup()
 end
 
 function Render:render()
-    self.marks:add(true, self.info.start_row, self.info.start_col, {
+    self.marks:add('code_background', self.info.start_row, self.info.start_col, {
         end_row = self.info.end_row,
         end_col = self.info.end_col,
         hl_group = self.code.highlight_inline,

Diff for: lua/render-markdown/render/dash.lua

@@ -29,12 +29,12 @@ function Render:render()
     local virt_text = { self.dash.icon:rep(width), self.dash.highlight }
 
     local start_row, end_row = self.info.start_row, self.info.end_row - 1
-    self.marks:add(true, start_row, 0, {
+    self.marks:add('dash', start_row, 0, {
         virt_text = { virt_text },
         virt_text_pos = 'overlay',
     })
     if end_row > start_row then
-        self.marks:add(true, end_row, 0, {
+        self.marks:add('dash', end_row, 0, {
             virt_text = { virt_text },
             virt_text_pos = 'overlay',
         })

Diff for: lua/render-markdown/render/heading.lua

@@ -99,7 +99,7 @@ function Render:icon()
         local added = true
         for row = self.info.start_row, self.data.end_row - 1 do
             added = added
-                and self.marks:add(true, row, self.info.start_col, {
+                and self.marks:add('head_icon', row, self.info.start_col, {
                     end_row = row,
                     end_col = self.info.end_col,
                     virt_text = { { row == self.info.start_row and icon or str.pad(str.width(icon)), highlight } },
@@ -119,7 +119,7 @@ function Render:icon()
 
     local padding = width - str.width(icon)
     if self.heading.position == 'inline' or padding < 0 then
-        local added = self.marks:add(true, self.info.start_row, self.info.start_col, {
+        local added = self.marks:add('head_icon', self.info.start_row, self.info.start_col, {
             end_row = self.info.end_row,
             end_col = self.info.end_col,
             virt_text = { { icon, highlight } },
@@ -128,7 +128,7 @@ function Render:icon()
         })
         return added and str.width(icon) + 1 or width
     else
-        self.marks:add(true, self.info.start_row, self.info.start_col, {
+        self.marks:add('head_icon', self.info.start_row, self.info.start_col, {
             end_row = self.info.end_row,
             end_col = self.info.end_col,
             virt_text = { { str.pad(padding) .. icon, highlight } },
@@ -173,14 +173,14 @@ function Render:background(width)
         table.insert(padding, { str.pad(vim.o.columns * 2), self.config.padding.highlight })
     end
     for row = self.info.start_row, self.data.end_row - 1 do
-        self.marks:add(true, row, 0, {
+        self.marks:add('head_background', row, 0, {
             end_row = row + 1,
             hl_group = highlight,
             hl_eol = true,
         })
         if win_col > 0 and #padding > 0 then
             -- Overwrite anything beyond width with padding highlight
-            self.marks:add(true, row, 0, {
+            self.marks:add('head_background', row, 0, {
                 priority = 0,
                 virt_text = padding,
                 virt_text_win_col = win_col,
@@ -225,7 +225,7 @@ function Render:border(width)
 
     local line_above = line(self.heading.above)
     if not virtual and self:empty_line('above') and self.info.start_row - 1 ~= self.context.last_heading then
-        self.marks:add(true, self.info.start_row - 1, 0, {
+        self.marks:add('head_border', self.info.start_row - 1, 0, {
             virt_text = line_above,
             virt_text_pos = 'overlay',
         })
@@ -238,7 +238,7 @@ function Render:border(width)
 
     local line_below = line(self.heading.below)
     if not virtual and self:empty_line('below') then
-        self.marks:add(true, self.info.end_row + 1, 0, {
+        self.marks:add('head_border', self.info.end_row + 1, 0, {
             virt_text = line_below,
             virt_text_pos = 'overlay',
         })

Diff for: lua/render-markdown/render/link.lua

@@ -46,7 +46,7 @@ function Render:setup()
 end
 
 function Render:render()
-    local added = self.marks:add(true, self.info.start_row, self.info.start_col, {
+    local added = self.marks:add('link', self.info.start_row, self.info.start_col, {
         end_row = self.info.end_row,
         end_col = self.info.end_col,
         virt_text = { { self.data.text, self.data.highlight } },

Diff for: lua/render-markdown/render/list_marker.lua

@@ -63,7 +63,7 @@ end
 
 ---@private
 function Render:hide_marker()
-    self.marks:add(true, self.info.start_row, self.info.start_col + self.leading_spaces, {
+    self.marks:add('check_icon', self.info.start_row, self.info.start_col + self.leading_spaces, {
         end_row = self.info.end_row,
         end_col = self.info.end_col,
         conceal = '',
@@ -77,7 +77,7 @@ function Render:icon(level)
     if icon == nil then
         return
     end
-    self.marks:add(true, self.info.start_row, self.info.start_col, {
+    self.marks:add('bullet', self.info.start_row, self.info.start_col, {
         end_row = self.info.end_row,
         end_col = self.info.end_col,
         virt_text = { { str.pad(self.leading_spaces) .. icon, self.bullet.highlight } },

Diff for: lua/render-markdown/render/quote.lua

@@ -58,7 +58,7 @@ end
 ---@private
 ---@param info render.md.NodeInfo
 function Render:quote_marker(info)
-    self.marks:add(true, info.start_row, info.start_col, {
+    self.marks:add('quote', info.start_row, info.start_col, {
         end_row = info.end_row,
         end_col = info.end_col,
         virt_text = { { info.text:gsub('>', self.data.icon), self.data.highlight } },

Diff for: lua/render-markdown/render/shortcut.lua

@@ -47,7 +47,7 @@ function Render:callout(callout)
     end
 
     local text, conceal = self:callout_title(callout)
-    local added = self.marks:add(true, self.info.start_row, self.info.start_col, {
+    local added = self.marks:add('callout', self.info.start_row, self.info.start_col, {
         end_row = self.info.end_row,
         end_col = self.info.end_col,
         virt_text = { { text, callout.highlight } },
@@ -86,7 +86,7 @@ function Render:checkbox(checkbox)
 
     local inline = self.config.checkbox.position == 'inline'
     local icon, highlight = checkbox.rendered, checkbox.highlight
-    local added = self.marks:add(true, self.info.start_row, self.info.start_col, {
+    local added = self.marks:add('check_icon', self.info.start_row, self.info.start_col, {
         end_row = self.info.end_row,
         end_col = self.info.end_col,
         virt_text = { { inline and icon or str.pad_to(self.info.text, icon) .. icon, highlight } },
@@ -112,7 +112,7 @@ function Render:wiki_link()
         icon, highlight = link_component.icon, link_component.highlight
     end
     local link_text = icon .. parts[#parts]
-    local added = self.marks:add(true, self.info.start_row, self.info.start_col - 1, {
+    local added = self.marks:add('link', self.info.start_row, self.info.start_col - 1, {
         end_row = self.info.end_row,
         end_col = self.info.end_col + 1,
         virt_text = { { link_text, highlight } },

Diff for: lua/render-markdown/render/table.lua

@@ -221,7 +221,7 @@ function Render:delimiter()
     text = text .. border[4] .. table.concat(sections, border[5]) .. border[6]
     text = text .. str.pad_to(delim.info.text, text)
 
-    self.marks:add(true, delim.info.start_row, delim.info.start_col, {
+    self.marks:add('table_border', delim.info.start_row, delim.info.start_col, {
         end_row = delim.info.end_row,
         end_col = delim.info.end_col,
         virt_text = { { text, self.table.head } },
@@ -237,7 +237,7 @@ function Render:row(row)
 
     if vim.tbl_contains({ 'trimmed', 'padded', 'raw' }, self.table.cell) then
         for _, pipe in ipairs(row.pipes) do
-            self.marks:add(true, pipe.start_row, pipe.start_col, {
+            self.marks:add('table_border', pipe.start_row, pipe.start_col, {
                 end_row = pipe.end_row,
                 end_col = pipe.end_col,
                 virt_text = { { border[10], highlight } },
@@ -267,7 +267,7 @@ function Render:row(row)
     end
 
     if self.table.cell == 'overlay' then
-        self.marks:add(true, row.info.start_row, row.info.start_col, {
+        self.marks:add('table_border', row.info.start_row, row.info.start_col, {
             end_row = row.info.end_row,
             end_col = row.info.end_col,
             virt_text = { { row.info.text:gsub('|', border[10]), highlight } },

Diff for: lua/render-markdown/state.lua

@@ -136,7 +136,17 @@ function M.validate()
             return validator:spec(config, nilable, key, path)
         end
 
-        get_spec('anti_conceal'):type('enabled', 'boolean'):type({ 'above', 'below' }, 'number'):check()
+        get_spec('anti_conceal')
+            :type('enabled', 'boolean')
+            :type({ 'above', 'below' }, 'number')
+            :type('ignore', 'table')
+            :check()
+        get_spec({ 'anti_conceal', 'ignore' })
+            :type({ 'head_icon', 'head_background', 'head_border' }, { 'boolean', 'nil' })
+            :type({ 'code_language', 'code_background', 'code_border' }, { 'boolean', 'nil' })
+            :type({ 'dash', 'bullet', 'check_icon', 'check_scope' }, { 'boolean', 'nil' })
+            :type({ 'quote', 'table_border', 'callout', 'link', 'sign' }, { 'boolean', 'nil' })
+            :check()
 
         get_spec('padding'):type('highlight', 'string'):check()
 

Diff for: lua/render-markdown/types.lua

@@ -149,6 +149,7 @@
 
 ---@class (exact) render.md.AntiConceal
 ---@field public enabled boolean
+---@field public ignore table<render.md.Element, boolean>
 ---@field public above integer
 ---@field public below integer