feat: heading position right

## Details

Request: #238

Adds a new option for `heading.position` for value `right`.

When set icons will be added to the end of the heading line rather than
at the beginning. This will also conceal the atx heading `#` values.
To make this easier internally the query for headings has changed from
getting markers, i.e. atx_h1_marker, to instead grab the entire heading
line, i.e. atx_heading. From there we do some processing on the node to
get different parts like the marker. Needed to make some minor
adjustments to ranges as part of this change.

Inline icons for headings now remove the space between the marker and
the heading title, using the space of the icon itself rather than doing
the double spaced thing. Users can add an additional space to the icons
in the configuration to get back the old behavior.

Added an offset to the list module `add_over` method to allow the
starts / ends to by slightly modified but still to be based off of a
specific node. Used this in a few other places where applicable.

Added more unit tests for different heading configuration behaviors.

Author: MeanderingProgrammer

README.md

@@ -212,8 +212,9 @@ require('render-markdown').setup({
         -- Turn on / off any sign column related rendering
         sign = true,
         -- Determines how icons fill the available space:
-        --  inline:  underlying '#'s are concealed resulting in a left aligned icon
-        --  overlay: result is left padded with spaces to hide any additional '#'
+        --  right:   '#'s are concealed and icon is appended to right side
+        --  inline:  '#'s are concealed and icon is inlined on left side
+        --  overlay: icon is left padded with spaces and inserted on left hiding any additional '#'
         position = 'overlay',
         -- Replaces '#+' of 'atx_h._marker'
         -- The number of '#' in the heading determines the 'level'
@@ -619,8 +620,9 @@ require('render-markdown').setup({
         -- Turn on / off any sign column related rendering
         sign = true,
         -- Determines how icons fill the available space:
-        --  inline:  underlying '#'s are concealed resulting in a left aligned icon
-        --  overlay: result is left padded with spaces to hide any additional '#'
+        --  right:   '#'s are concealed and icon is appended to right side
+        --  inline:  '#'s are concealed and icon is inlined on left side
+        --  overlay: icon is left padded with spaces and inserted on left hiding any additional '#'
         position = 'overlay',
         -- Replaces '#+' of 'atx_h._marker'
         -- The number of '#' in the heading determines the 'level'

doc/render-markdown.txt

@@ -259,8 +259,9 @@ Default Configuration ~
             -- Turn on / off any sign column related rendering
             sign = true,
             -- Determines how icons fill the available space:
-            --  inline:  underlying '#'s are concealed resulting in a left aligned icon
-            --  overlay: result is left padded with spaces to hide any additional '#'
+            --  right:   '#'s are concealed and icon is appended to right side
+            --  inline:  '#'s are concealed and icon is inlined on left side
+            --  overlay: icon is left padded with spaces and inserted on left hiding any additional '#'
             position = 'overlay',
             -- Replaces '#+' of 'atx_h._marker'
             -- The number of '#' in the heading determines the 'level'
@@ -664,8 +665,9 @@ Heading Configuration ~
             -- Turn on / off any sign column related rendering
             sign = true,
             -- Determines how icons fill the available space:
-            --  inline:  underlying '#'s are concealed resulting in a left aligned icon
-            --  overlay: result is left padded with spaces to hide any additional '#'
+            --  right:   '#'s are concealed and icon is appended to right side
+            --  inline:  '#'s are concealed and icon is inlined on left side
+            --  overlay: icon is left padded with spaces and inserted on left hiding any additional '#'
             position = 'overlay',
             -- Replaces '#+' of 'atx_h._marker'
             -- The number of '#' in the heading determines the 'level'

lua/render-markdown/handler/markdown.lua

@@ -24,15 +24,10 @@ function Handler.new(buf)
         [[
             (section) @section
 
-            (atx_heading [
-                (atx_h1_marker)
-                (atx_h2_marker)
-                (atx_h3_marker)
-                (atx_h4_marker)
-                (atx_h5_marker)
-                (atx_h6_marker)
-            ] @heading)
-            (setext_heading) @heading
+            [
+                (atx_heading)
+                (setext_heading)
+            ] @heading
 
             (section (paragraph) @paragraph)
 

lua/render-markdown/health.lua

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

lua/render-markdown/init.lua

@@ -156,7 +156,7 @@ local M = {}
 ---@field public left_margin? number
 ---@field public min_width? integer
 
----@alias render.md.heading.Position 'overlay'|'inline'
+---@alias render.md.heading.Position 'overlay'|'inline'|'right'
 ---@alias render.md.heading.Width 'full'|'block'
 
 ---@class (exact) render.md.UserHeading
@@ -330,8 +330,9 @@ M.default_config = {
         -- Turn on / off any sign column related rendering
         sign = true,
         -- Determines how icons fill the available space:
-        --  inline:  underlying '#'s are concealed resulting in a left aligned icon
-        --  overlay: result is left padded with spaces to hide any additional '#'
+        --  right:   '#'s are concealed and icon is appended to right side
+        --  inline:  '#'s are concealed and icon is inlined on left side
+        --  overlay: icon is left padded with spaces and inserted on left hiding any additional '#'
         position = 'overlay',
         -- Replaces '#+' of 'atx_h._marker'
         -- The number of '#' in the heading determines the 'level'

lua/render-markdown/lib/list.lua

@@ -32,11 +32,13 @@ end
 ---@param element boolean|render.md.Element
 ---@param node render.md.Node
 ---@param opts vim.api.keyset.set_extmark
+---@param offset? Range4
 ---@return boolean
-function Marks:add_over(element, node, opts)
-    opts.end_row = node.end_row
-    opts.end_col = node.end_col
-    return self:add(element, node.start_row, node.start_col, opts)
+function Marks:add_over(element, node, opts, offset)
+    offset = offset or { 0, 0, 0, 0 }
+    opts.end_row = node.end_row + offset[3]
+    opts.end_col = node.end_col + offset[4]
+    return self:add(element, node.start_row + offset[1], node.start_col + offset[2], opts)
 end
 
 ---@param element boolean|render.md.Element

lua/render-markdown/render/heading.lua

@@ -6,6 +6,7 @@ local colors = require('render-markdown.colors')
 
 ---@class render.md.data.Heading
 ---@field atx boolean
+---@field marker render.md.Node
 ---@field level integer
 ---@field icon? string
 ---@field sign? string
@@ -17,7 +18,6 @@ local colors = require('render-markdown.colors')
 ---@field right_pad number
 ---@field min_width integer
 ---@field border boolean
----@field end_row integer
 
 ---@class render.md.width.Heading
 ---@field margin integer
@@ -37,15 +37,24 @@ function Render:setup()
         return false
     end
 
-    local atx, level = nil, nil
-    if self.node.type == 'setext_heading' then
-        atx, level = false, self.node:child('setext_h1_underline') ~= nil and 1 or 2
+    local atx = nil
+    local marker = nil
+    local level = nil
+    if self.node.type == 'atx_heading' then
+        atx = true
+        marker = assert(self.node:child_at(0), 'atx heading expected child marker')
+        level = Str.width(marker.text)
+    elseif self.node.type == 'setext_heading' then
+        atx = false
+        marker = assert(self.node:child_at(1), 'ext heading expected child underline')
+        level = marker.type == 'setext_h1_underline' and 1 or 2
     else
-        atx, level = true, Str.width(self.node.text)
+        return false
     end
 
     self.data = {
         atx = atx,
+        marker = marker,
         level = level,
         icon = List.cycle(self.heading.icons, level),
         sign = List.cycle(self.heading.signs, level),
@@ -57,21 +66,23 @@ function Render:setup()
         right_pad = List.clamp(self.heading.right_pad, level) or 0,
         min_width = List.clamp(self.heading.min_width, level) or 0,
         border = List.clamp(self.heading.border, level) or false,
-        end_row = self.node.end_row + (atx and 1 or 0),
     }
 
     return true
 end
 
 function Render:render()
-    local width = self:width(self:icon())
     if self.heading.sign then
         self:sign(self.data.sign, self.data.foreground)
     end
+    local width = self:width(self:icon())
     self:background(width)
-    self:border(width)
     self:left_pad(width)
-    self:conceal_underline()
+    if self.data.atx then
+        self:border(width)
+    else
+        self:conceal_underline()
+    end
 end
 
 ---@private
@@ -84,58 +95,78 @@ function Render:icon()
     if self.data.background ~= nil then
         table.insert(highlight, self.data.background)
     end
-
-    if not self.data.atx then
+    if self.data.atx then
+        local marker = self.data.marker
+        -- Add 1 to account for space after last `#`
+        local width = self.context:width(marker) + 1
+        if icon == nil or #highlight == 0 then
+            return width
+        end
+        if self.heading.position == 'right' then
+            self.marks:add_over(true, marker, {
+                conceal = '',
+            }, { 0, 0, 0, 1 })
+            self.marks:add_over('head_icon', marker, {
+                priority = 1000,
+                virt_text = { { icon, highlight } },
+                virt_text_pos = 'eol',
+            })
+            return 1 + Str.width(icon)
+        else
+            local padding = width - Str.width(icon)
+            if self.heading.position == 'inline' or padding < 0 then
+                local added = self.marks:add_over(true, marker, {
+                    virt_text = { { icon, highlight } },
+                    virt_text_pos = 'inline',
+                    conceal = '',
+                }, { 0, 0, 0, 1 })
+                return added and Str.width(icon) or width
+            else
+                self.marks:add_over('head_icon', marker, {
+                    virt_text = { { Str.pad(padding) .. icon, highlight } },
+                    virt_text_pos = 'overlay',
+                })
+                return width
+            end
+        end
+    else
+        local node = self.node
         if icon == nil or #highlight == 0 then
             return 0
         end
-        local added = true
-        for row = self.node.start_row, self.data.end_row - 1 do
-            added = added
-                and self.marks:add('head_icon', row, self.node.start_col, {
+        if self.heading.position == 'right' then
+            self.marks:add_over('head_icon', node, {
+                priority = 1000,
+                virt_text = { { icon, highlight } },
+                virt_text_pos = 'eol',
+            })
+            return 1 + Str.width(icon)
+        else
+            local added = true
+            for row = node.start_row, node.end_row - 1 do
+                local added_row = self.marks:add('head_icon', row, node.start_col, {
                     end_row = row,
-                    end_col = self.node.end_col,
-                    virt_text = { { row == self.node.start_row and icon or Str.pad(Str.width(icon)), highlight } },
+                    end_col = node.end_col,
+                    virt_text = { { row == node.start_row and icon or Str.pad(Str.width(icon)), highlight } },
                     virt_text_pos = 'inline',
                 })
+                added = added and added_row
+            end
+            return added and Str.width(icon) or 0
         end
-        return added and Str.width(icon) or 0
-    end
-
-    -- For atx headings we add 1 to the available width to account for the space after the last `#`
-    local width = self.context:width(self.node) + 1
-    if icon == nil or #highlight == 0 then
-        return width
-    end
-
-    local padding = width - Str.width(icon)
-    if self.heading.position == 'inline' or padding < 0 then
-        local added = self.marks:add_over('head_icon', self.node, {
-            virt_text = { { icon, highlight } },
-            virt_text_pos = 'inline',
-            conceal = '',
-        })
-        return added and Str.width(icon) + 1 or width
-    else
-        self.marks:add_over('head_icon', self.node, {
-            virt_text = { { Str.pad(padding) .. icon, highlight } },
-            virt_text_pos = 'overlay',
-        })
-        return width
     end
 end
 
 ---@private
 ---@param icon_width integer
 ---@return render.md.width.Heading
 function Render:width(icon_width)
-    local text_width = nil
+    local width = icon_width
     if self.data.atx then
-        text_width = self.context:width(self.node:sibling('inline'))
+        width = width + self.context:width(self.node:child('inline'))
     else
-        text_width = vim.fn.max(Iter.list.map(self.node:lines(), Str.width))
+        width = width + vim.fn.max(Iter.list.map(self.node:lines(), Str.width))
     end
-    local width = icon_width + text_width
     local left_padding = self.context:resolve_offset(self.data.left_pad, width)
     local right_padding = self.context:resolve_offset(self.data.right_pad, width)
     width = math.max(left_padding + width + right_padding, self.data.min_width)
@@ -159,7 +190,7 @@ function Render:background(width)
         win_col = width.margin + width.content + self:indent(self.data.level)
         table.insert(padding, self:padding_text(vim.o.columns * 2))
     end
-    for row = self.node.start_row, self.data.end_row - 1 do
+    for row = self.node.start_row, self.node.end_row - 1 do
         self.marks:add('head_background', row, 0, {
             end_row = row + 1,
             hl_group = highlight,
@@ -179,8 +210,7 @@ end
 ---@private
 ---@param width render.md.width.Heading
 function Render:border(width)
-    -- Only atx headings support borders
-    if not self.data.border or not self.data.atx then
+    if not self.data.border then
         return
     end
 
@@ -226,13 +256,13 @@ function Render:border(width)
 
     local line_below = line(self.heading.below)
     if not virtual and self:empty_line('below') then
-        self.marks:add('head_border', self.node.end_row + 1, 0, {
+        self.marks:add('head_border', self.node.end_row, 0, {
             virt_text = line_below,
             virt_text_pos = 'overlay',
         })
-        self.context.last_heading = self.node.end_row + 1
+        self.context.last_heading = self.node.end_row
     else
-        self.marks:add(false, self.node.end_row, 0, {
+        self.marks:add(false, self.node.start_row, 0, {
             virt_lines = { self:indent_virt_line(line_below, self.data.level) },
         })
     end
@@ -256,27 +286,21 @@ function Render:left_pad(width)
     if width.padding > 0 then
         table.insert(virt_text, self:padding_text(width.padding, self.data.background))
     end
-    if #virt_text > 0 then
-        for row = self.node.start_row, self.data.end_row - 1 do
-            self.marks:add(false, row, 0, {
-                priority = 0,
-                virt_text = virt_text,
-                virt_text_pos = 'inline',
-            })
-        end
+    if #virt_text == 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 = virt_text,
+            virt_text_pos = 'inline',
+        })
     end
 end
 
 ---@private
 function Render:conceal_underline()
-    if self.data.atx then
-        return
-    end
-    local node = self.node:child(string.format('setext_h%d_underline', self.data.level))
-    if node == nil then
-        return
-    end
-    self.marks:add_over(true, node, {
+    self.marks:add_over(true, self.data.marker, {
         conceal = '',
     })
 end

lua/render-markdown/render/list_item.lua

@@ -71,12 +71,9 @@ end
 
 ---@private
 function Render:hide_marker()
-    local node = self.data.marker
-    self.marks:add('check_icon', node.start_row, node.start_col + self.data.spaces, {
-        end_row = node.end_row,
-        end_col = node.end_col,
+    self.marks:add_over('check_icon', self.data.marker, {
         conceal = '',
-    })
+    }, { 0, self.data.spaces, 0, 0 })
 end
 
 ---@private