feat: use conceal lines for setext heading underline

## Details

Add `conceal_lines` extmark over setext heading underlines in addition
to the normal `conceal`. Having both is fine so not adding any
conditional logic around this one and keeping both around.

Other minor changes:

- use standard `@enum` behavior based on values rather than keys
- use `tbl_values` instead of `tbl_keys` for validation for consistency
- use an `enum` for log levels instead of an `alias`
- use `number[]` for priorities instead of `integer[]` when sorting

Author: MeanderingProgrammer

lua/render-markdown/config/anti_conceal.lua

@@ -6,7 +6,7 @@
 
 ---@alias render.md.conceal.Ignore table<render.md.Element, render.md.Modes>
 
----@enum (key) render.md.Element
+---@enum render.md.Element
 local Element = {
     head_icon = 'head_icon',
     head_background = 'head_background',
@@ -31,7 +31,7 @@ local M = {}
 function M.validate(spec)
     spec:type('enabled', 'boolean')
     spec:nested('ignore', function(ignore)
-        for element in pairs(Element) do
+        for _, element in pairs(Element) do
             ignore:list(element, 'string', { 'boolean', 'nil' })
         end
         ignore:check()

lua/render-markdown/config/code.lua

@@ -23,27 +23,27 @@
 ---@field highlight_fallback string
 ---@field highlight_inline string
 
----@enum (key) render.md.code.Style
+---@enum render.md.code.Style
 local Style = {
     full = 'full',
     normal = 'normal',
     language = 'language',
     none = 'none',
 }
 
----@enum (key) render.md.code.Position
+---@enum render.md.code.Position
 local Position = {
     left = 'left',
     right = 'right',
 }
 
----@enum (key) render.md.code.Width
+---@enum render.md.code.Width
 local Width = {
     full = 'full',
     block = 'block',
 }
 
----@enum (key) render.md.code.Border
+---@enum render.md.code.Border
 local Border = {
     hide = 'hide',
     thin = 'thin',
@@ -57,18 +57,18 @@ local M = {}
 function M.validate(spec)
     require('render-markdown.config.base').validate(spec)
     spec:type('sign', 'boolean')
-    spec:one_of('style', vim.tbl_keys(Style))
-    spec:one_of('position', vim.tbl_keys(Position))
+    spec:one_of('style', vim.tbl_values(Style))
+    spec:one_of('position', vim.tbl_values(Position))
     spec:type('language_pad', 'number')
     spec:type('language_icon', 'boolean')
     spec:type('language_name', 'boolean')
     spec:list('disable_background', 'string', 'boolean')
-    spec:one_of('width', vim.tbl_keys(Width))
+    spec:one_of('width', vim.tbl_values(Width))
     spec:type('left_margin', 'number')
     spec:type('left_pad', 'number')
     spec:type('right_pad', 'number')
     spec:type('min_width', 'number')
-    spec:one_of('border', vim.tbl_keys(Border))
+    spec:one_of('border', vim.tbl_values(Border))
     spec:type('above', 'string')
     spec:type('below', 'string')
     spec:type('inline_left', 'string')

lua/render-markdown/config/heading.lua

@@ -27,14 +27,14 @@
 ---| string[]
 ---| fun(ctx: render.md.heading.Context): string?
 
----@enum (key) render.md.heading.Position
+---@enum render.md.heading.Position
 local Position = {
     overlay = 'overlay',
     inline = 'inline',
     right = 'right',
 }
 
----@enum (key) render.md.heading.Width
+---@enum render.md.heading.Width
 local Width = {
     full = 'full',
     block = 'block',
@@ -55,9 +55,9 @@ function M.validate(spec)
     spec:type('setext', 'boolean')
     spec:type('sign', 'boolean')
     spec:list('icons', 'string', 'function')
-    spec:one_of('position', vim.tbl_keys(Position))
+    spec:one_of('position', vim.tbl_values(Position))
     spec:list('signs', 'string')
-    spec:one_or_list_of('width', vim.tbl_keys(Width))
+    spec:one_or_list_of('width', vim.tbl_values(Width))
     spec:list('left_margin', 'number', 'number')
     spec:list('left_pad', 'number', 'number')
     spec:list('right_pad', 'number', 'number')

lua/render-markdown/config/latex.lua

@@ -5,7 +5,7 @@
 ---@field top_pad integer
 ---@field bottom_pad integer
 
----@enum (key) render.md.latex.Position
+---@enum render.md.latex.Position
 local Position = {
     above = 'above',
     below = 'below',
@@ -18,7 +18,7 @@ function M.validate(spec)
     require('render-markdown.config.base').validate(spec)
     spec:type('converter', 'string')
     spec:type('highlight', 'string')
-    spec:one_of('position', vim.tbl_keys(Position))
+    spec:one_of('position', vim.tbl_values(Position))
     spec:type('top_pad', 'number')
     spec:type('bottom_pad', 'number')
     spec:check()

lua/render-markdown/config/link.lua

@@ -33,7 +33,7 @@
 ---@field priority? integer
 ---@field highlight? string
 
----@enum (key) render.md.link.custom.Kind
+---@enum render.md.link.custom.Kind
 local Kind = {
     pattern = 'pattern',
     suffix = 'suffix',
@@ -65,7 +65,7 @@ function M.validate(spec)
         patterns:each(function(pattern)
             pattern:type('pattern', 'string')
             pattern:type('icon', 'string')
-            pattern:one_of('kind', vim.tbl_keys(Kind), 'nil')
+            pattern:one_of('kind', vim.tbl_values(Kind), 'nil')
             pattern:type('priority', { 'number', 'nil' })
             pattern:type('highlight', { 'string', 'nil' })
             pattern:check()

lua/render-markdown/config/pipe_table.lua

@@ -10,22 +10,22 @@
 ---@field row string
 ---@field filler string
 
----@enum (key) render.md.table.Preset
+---@enum render.md.table.Preset
 local Preset = {
     none = 'none',
     round = 'round',
     double = 'double',
     heavy = 'heavy',
 }
 
----@enum (key) render.md.table.Style
+---@enum render.md.table.Style
 local Style = {
     full = 'full',
     normal = 'normal',
     none = 'none',
 }
 
----@enum (key) render.md.table.Cell
+---@enum render.md.table.Cell
 local Cell = {
     trimmed = 'trimmed',
     padded = 'padded',
@@ -38,9 +38,9 @@ local M = {}
 ---@param spec render.md.debug.ValidatorSpec
 function M.validate(spec)
     require('render-markdown.config.base').validate(spec)
-    spec:one_of('preset', vim.tbl_keys(Preset))
-    spec:one_of('style', vim.tbl_keys(Style))
-    spec:one_of('cell', vim.tbl_keys(Cell))
+    spec:one_of('preset', vim.tbl_values(Preset))
+    spec:one_of('style', vim.tbl_values(Style))
+    spec:one_of('cell', vim.tbl_values(Cell))
     spec:type('padding', 'number')
     spec:type('min_width', 'number')
     spec:list('border', 'string')

lua/render-markdown/core/log.lua

@@ -10,7 +10,13 @@ local Env = require('render-markdown.lib.env')
 ---@field level render.md.log.Level
 ---@field runtime boolean
 
----@alias render.md.log.Level 'off'|'debug'|'info'|'error'
+---@enum render.md.log.Level
+local Level = {
+    debug = 'debug',
+    info = 'info',
+    error = 'error',
+    off = 'off',
+}
 
 ---@class render.md.Log
 ---@field private file string
@@ -108,7 +114,7 @@ end
 ---@param name string
 ---@param ... any
 function M.add(level, name, ...)
-    if M.level_value(level) < M.level_value(M.config.level) then
+    if M.level(level) < M.level(M.config.level) then
         return
     end
     local messages = {}
@@ -125,7 +131,7 @@ function M.add(level, name, ...)
         message = table.concat(messages, ' | '),
     }
     M.entries[#M.entries + 1] = entry
-    -- Periodically flush logs to disk
+    -- periodically flush logs to disk
     if #M.entries > 1000 then
         M.flush()
     end
@@ -134,14 +140,14 @@ end
 ---@private
 ---@param level render.md.log.Level
 ---@return integer
-function M.level_value(level)
-    if level == 'debug' then
+function M.level(level)
+    if level == Level.debug then
         return 1
-    elseif level == 'info' then
+    elseif level == Level.info then
         return 2
-    elseif level == 'error' then
+    elseif level == Level.error then
         return 3
-    elseif level == 'off' then
+    elseif level == Level.off then
         return 4
     else
         return 0

lua/render-markdown/debug/marks.lua

@@ -25,7 +25,8 @@ end
 ---@return boolean
 function Mark.__lt(a, b)
     local as, bs = a:priorities(), b:priorities()
-    for i = 1, math.max(#as, #bs) do
+    assert(#as == #bs)
+    for i = 1, #as do
         if as[i] ~= bs[i] then
             return as[i] < bs[i]
         end
@@ -34,13 +35,14 @@ function Mark.__lt(a, b)
 end
 
 ---@private
----@return integer[]
+---@return number[]
 function Mark:priorities()
     local virt_row = 0
     if self.opts.virt_lines ~= nil then
         virt_row = self.opts.virt_lines_above and -0.5 or 0.5
     end
     local win_col = self.opts.virt_text_win_col or 0
+    ---@type number[]
     return {
         -- rows
         self.row[1] + virt_row,

lua/render-markdown/debug/validator.lua

@@ -1,6 +1,6 @@
 local Iter = require('render-markdown.lib.iter')
 
----@enum (key) render.md.debug.spec.Kind
+---@enum render.md.debug.spec.Kind
 local Kind = {
     type = 'type',
     value = 'value',
@@ -245,9 +245,10 @@ function Validator:check(path, data, specs)
             message = message .. ', but got: '
             if spec.kind == Kind.type then
                 message = message .. type(value)
-            end
-            if spec.kind == Kind.value then
+            elseif spec.kind == Kind.value then
                 message = message .. vim.inspect(value)
+            else
+                error('invalid kind: ' .. spec.kind)
             end
             if info ~= nil then
                 message = message .. string.format(', info: %s', info)

lua/render-markdown/health.lua

@@ -5,7 +5,7 @@ local state = require('render-markdown.state')
 local M = {}
 
 ---@private
-M.version = '8.3.13'
+M.version = '8.3.14'
 
 function M.check()
     M.start('version')

lua/render-markdown/lib/node.lua

@@ -1,7 +1,7 @@
 local Iter = require('render-markdown.lib.iter')
 local Str = require('render-markdown.lib.str')
 
----@enum (key) render.md.node.Position
+---@enum render.md.node.Position
 local Position = {
     above = 'above',
     first = 'first',

lua/render-markdown/presets.lua

@@ -1,4 +1,4 @@
----@enum (key) render.md.config.Preset
+---@enum render.md.config.Preset
 local Preset = {
     none = 'none',
     lazy = 'lazy',

lua/render-markdown/render/heading.lua

@@ -108,6 +108,7 @@ function Render:render()
         self:border(box, false)
     else
         self.marks:over(true, self.data.marker, { conceal = '' })
+        self.marks:over(true, self.data.marker, { conceal_lines = '' })
     end
 end
 
@@ -231,6 +232,23 @@ function Render:background(box)
     end
 end
 
+---@private
+---@param box render.md.heading.Box
+function Render:padding(box)
+    local line = self:append({}, box.margin)
+    self:append(line, box.padding, self.data.background)
+    if #line == 0 then
+        return
+    end
+    for row = self.node.start_row, self.node.end_row - 1 do
+        self.marks:add(false, row, 0, {
+            priority = 0,
+            virt_text = line,
+            virt_text_pos = 'inline',
+        })
+    end
+end
+
 ---@private
 ---@param box render.md.heading.Box
 ---@param above boolean
@@ -271,21 +289,4 @@ function Render:border(box, above)
     end
 end
 
----@private
----@param box render.md.heading.Box
-function Render:padding(box)
-    local line = self:append({}, box.margin)
-    self:append(line, box.padding, self.data.background)
-    if #line == 0 then
-        return
-    end
-    for row = self.node.start_row, self.node.end_row - 1 do
-        self.marks:add(false, row, 0, {
-            priority = 0,
-            virt_text = line,
-            virt_text_pos = 'inline',
-        })
-    end
-end
-
 return Render

lua/render-markdown/render/table.lua

@@ -15,7 +15,7 @@ local log = require('render-markdown.core.log')
 ---@field width integer
 ---@field alignment render.md.table.Alignment
 
----@enum (key) render.md.table.Alignment
+---@enum render.md.table.Alignment
 local Alignment = {
     left = 'left',
     right = 'right',

tests/ad_hoc_spec.lua

@@ -26,11 +26,11 @@ describe('ad hoc', function()
             virt_text_pos = 'inline',
         })
         marks:add(2, 2, 0, 3, util.conceal())
+        marks:add(2, 2, 0, 3, util.conceal_lines())
         marks:add(2, 3, 0, 0, util.heading.bg(2))
         util.assert_view(marks, {
             '󰫎 󰲣 Heading 2 Line 1',
             '    Heading 2 Line 2',
-            '',
         })
     end)