feat: Add heading.width option

MeanderingProgrammer · Zeioth · MeanderingProgrammer · commit 426b13574c82 · 2024-07-25T05:28:12.000-07:00
## Details Currently headings always extend to the end of the current line. Some users do not like that, to support this add a width attribute with 2 values, 'full' & 'block'. 'full' behaves the same as now and extends the background to the end of the line. 'block' on the other hand ends right after the text of the heading. Original PR: #94 Co-Authored-By: Zeioth <Zeioth@hotmail.com>
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -64,6 +64,7 @@
 - Added to LazyVim distribution [#4139](https://github.com/LazyVim/LazyVim/pull/4139)
 - Supported by tokyonight.nvim colorscheme [71429c9](https://github.com/folke/tokyonight.nvim/commit/71429c97b7aeafecf333fa825a85eadb21426146)
 - Supported by cyberdream.nvim colorscheme [ba25d43](https://github.com/scottmckendry/cyberdream.nvim/commit/ba25d43d68dd34d31bee88286fb6179df2763c31)
+- Supported by rose-pine colorscheme [#303](https://github.com/rose-pine/neovim/pull/303)
 
 ## 4.1.0 (2024-07-14)
 
diff --git a/README.md b/README.md
@@ -202,6 +202,10 @@ require('render-markdown').setup({
         -- Added to the sign column if enabled
         -- The 'level' is used to index into the array using a cycle
         signs = { '󰫎 ' },
+        -- Width of the heading background:
+        --  block: width of the heading text
+        --  full: full width of the window
+        width = 'full',
         -- The 'level' is used to index into the array using a clamp
         -- Highlight for the heading icon and extends through the entire line
         backgrounds = {
@@ -260,7 +264,9 @@ require('render-markdown').setup({
         -- Replaces '---'|'***'|'___'|'* * *' of 'thematic_break'
         -- The icon gets repeated across the window's width
         icon = '─',
-        -- Width of the generated line, either the 'full' window width or a hard coded value
+        -- Width of the generated line:
+        --  <integer>: a hard coded width value
+        --  full: full width of the window
         width = 'full',
         -- Highlight for the whole line generated from the icon
         highlight = 'RenderMarkdownDash',
@@ -435,6 +441,10 @@ require('render-markdown').setup({
         -- Added to the sign column if enabled
         -- The 'level' is used to index into the array using a cycle
         signs = { '󰫎 ' },
+        -- Width of the heading background:
+        --  block: width of the heading text
+        --  full: full width of the window
+        width = 'full',
         -- The 'level' is used to index into the array using a clamp
         -- Highlight for the heading icon and extends through the entire line
         backgrounds = {
@@ -507,7 +517,9 @@ require('render-markdown').setup({
         -- Replaces '---'|'***'|'___'|'* * *' of 'thematic_break'
         -- The icon gets repeated across the window's width
         icon = '─',
-        -- Width of the generated line, either the 'full' window width or a hard coded value
+        -- Width of the generated line:
+        --  <integer>: a hard coded width value
+        --  full: full width of the window
         width = 'full',
         -- Highlight for the whole line generated from the icon
         highlight = 'RenderMarkdownDash',
diff --git a/doc/render-markdown.txt b/doc/render-markdown.txt
@@ -243,6 +243,10 @@ Full Default Configuration ~
             -- Added to the sign column if enabled
             -- The 'level' is used to index into the array using a cycle
             signs = { '󰫎 ' },
+            -- Width of the heading background:
+            --  block: width of the heading text
+            --  full: full width of the window
+            width = 'full',
             -- The 'level' is used to index into the array using a clamp
             -- Highlight for the heading icon and extends through the entire line
             backgrounds = {
@@ -301,7 +305,9 @@ Full Default Configuration ~
             -- Replaces '---'|'***'|'___'|'* * *' of 'thematic_break'
             -- The icon gets repeated across the window's width
             icon = '─',
-            -- Width of the generated line, either the 'full' window width or a hard coded value
+            -- Width of the generated line:
+            --  <integer>: a hard coded width value
+            --  full: full width of the window
             width = 'full',
             -- Highlight for the whole line generated from the icon
             highlight = 'RenderMarkdownDash',
@@ -475,6 +481,10 @@ HEADINGS                                      *render-markdown-setup-headings*
             -- Added to the sign column if enabled
             -- The 'level' is used to index into the array using a cycle
             signs = { '󰫎 ' },
+            -- Width of the heading background:
+            --  block: width of the heading text
+            --  full: full width of the window
+            width = 'full',
             -- The 'level' is used to index into the array using a clamp
             -- Highlight for the heading icon and extends through the entire line
             backgrounds = {
@@ -549,7 +559,9 @@ DASHED LINE                                *render-markdown-setup-dashed-line*
             -- Replaces '---'|'***'|'___'|'* * *' of 'thematic_break'
             -- The icon gets repeated across the window's width
             icon = '─',
-            -- Width of the generated line, either the 'full' window width or a hard coded value
+            -- Width of the generated line:
+            --  <integer>: a hard coded width value
+            --  full: full width of the window
             width = 'full',
             -- Highlight for the whole line generated from the icon
             highlight = 'RenderMarkdownDash',
diff --git a/doc/todo.md b/doc/todo.md
@@ -5,3 +5,4 @@
 - Add a performance test suite to measure improvements, relative value on
   same hardware should still be useful.
 - Look into showing marks when switching buffers, currently remains hidden
+- Figure out how to display the many configuration options & impact
diff --git a/lua/render-markdown/handler/markdown.lua b/lua/render-markdown/handler/markdown.lua
@@ -80,13 +80,15 @@ function M.render_heading(buf, info)
             end_row = info.end_row + 1,
             end_col = 0,
             hl_group = background,
-            hl_eol = true,
+            hl_eol = heading.width == 'full',
         },
     }
     list.add(marks, background_mark)
+
     if heading.sign then
         list.add(marks, M.render_sign(buf, info, list.cycle(heading.signs, level), foreground))
     end
+
     if icon == nil then
         return marks
     end
@@ -121,7 +123,7 @@ function M.render_heading(buf, info)
             opts = {
                 end_row = info.end_row,
                 end_col = info.end_col,
-                virt_text = { { str.pad(icon, padding), { foreground, background } } },
+                virt_text = { { str.pad(padding, icon), { foreground, background } } },
                 virt_text_pos = 'overlay',
             },
         }
@@ -187,9 +189,11 @@ function M.render_code(buf, info)
         return marks
     end
 
-    local width = util.get_width(buf)
-    if code.width == 'block' then
-        local lines = vim.api.nvim_buf_get_lines(buf, start_row, end_row, false)
+    local width
+    if code.width == 'full' then
+        width = util.get_width(buf)
+    elseif code.width == 'block' then
+        local lines = vim.api.nvim_buf_get_lines(buf, start_row, end_row, true)
         local code_width = vim.fn.max(vim.tbl_map(str.width, lines))
         width = code.left_pad + code_width + code.right_pad
     end
@@ -242,8 +246,8 @@ function M.render_code(buf, info)
     list.add(marks, background_mark)
 
     if code.width == 'block' then
-        -- overwrite anything beyond block width + right_pad with Normal
-        local pad = str.pad('', vim.o.columns * 2)
+        -- Overwrite anything beyond left_pad + block width + right_pad with Normal
+        local pad = str.pad(vim.o.columns * 2)
         for row = start_row, code.border == 'thin' and end_row or end_row - 1 do
             ---@type render.md.Mark
             local block_background_mark = {
@@ -275,7 +279,7 @@ function M.render_code(buf, info)
             opts = {
                 end_row = row + 1,
                 priority = 0,
-                virt_text = { { str.pad('', code.left_pad), code.highlight } },
+                virt_text = { { str.pad(code.left_pad), code.highlight } },
                 virt_text_pos = 'inline',
             },
         }
@@ -312,7 +316,7 @@ function M.render_language(buf, info, code_block)
         -- context they are in. This gets lumped into the delimiter node and as a result,
         -- after concealing, the extmark will be left shifted. Logic below accounts for this.
         local padding = str.leading_spaces(code_block.text)
-        icon_text = str.pad(icon_text .. info.text, padding)
+        icon_text = str.pad(padding, icon_text .. info.text)
     end
     local highlight = { icon_highlight }
     if code.style == 'full' then
@@ -391,7 +395,7 @@ function M.render_list_marker(buf, info)
             opts = {
                 end_row = info.end_row,
                 end_col = info.end_col,
-                virt_text = { { str.pad(icon, leading_spaces), bullet.highlight } },
+                virt_text = { { str.pad(leading_spaces, icon), bullet.highlight } },
                 virt_text_pos = 'overlay',
             },
         }
@@ -404,7 +408,7 @@ function M.render_list_marker(buf, info)
                 start_row = info.start_row,
                 start_col = info.end_col - 1,
                 opts = {
-                    virt_text = { { str.pad('', bullet.right_pad), 'Normal' } },
+                    virt_text = { { str.pad(bullet.right_pad), 'Normal' } },
                     virt_text_pos = 'inline',
                 },
             }
@@ -594,7 +598,7 @@ function M.render_table_row(buf, row, highlight)
                             start_row = cell.start_row,
                             start_col = cell.end_col - 1,
                             opts = {
-                                virt_text = { { str.pad('', offset), pipe_table.filler } },
+                                virt_text = { { str.pad(offset), pipe_table.filler } },
                                 virt_text_pos = 'inline',
                             },
                         }
diff --git a/lua/render-markdown/init.lua b/lua/render-markdown/init.lua
@@ -89,6 +89,7 @@ local M = {}
 ---@field public sign? boolean
 ---@field public icons? string[]
 ---@field public signs? string[]
+---@field public width? 'full'|'block'
 ---@field public backgrounds? string[]
 ---@field public foregrounds? string[]
 
@@ -228,6 +229,10 @@ M.default_config = {
         -- Added to the sign column if enabled
         -- The 'level' is used to index into the array using a cycle
         signs = { '󰫎 ' },
+        -- Width of the heading background:
+        --  block: width of the heading text
+        --  full: full width of the window
+        width = 'full',
         -- The 'level' is used to index into the array using a clamp
         -- Highlight for the heading icon and extends through the entire line
         backgrounds = {
@@ -286,7 +291,9 @@ M.default_config = {
         -- Replaces '---'|'***'|'___'|'* * *' of 'thematic_break'
         -- The icon gets repeated across the window's width
         icon = '─',
-        -- Width of the generated line, either the 'full' window width or a hard coded value
+        -- Width of the generated line:
+        --  <integer>: a hard coded width value
+        --  full: full width of the window
         width = 'full',
         -- Highlight for the whole line generated from the icon
         highlight = 'RenderMarkdownDash',
diff --git a/lua/render-markdown/state.lua b/lua/render-markdown/state.lua
@@ -127,6 +127,7 @@ function state.validate()
         sign = { heading.sign, 'boolean' },
         icons = string_array(heading.icons),
         signs = string_array(heading.signs),
+        width = one_of(heading.width, { 'full', 'block' }),
         backgrounds = string_array(heading.backgrounds),
         foregrounds = string_array(heading.foregrounds),
     })
diff --git a/lua/render-markdown/str.lua b/lua/render-markdown/str.lua
@@ -22,14 +22,18 @@ end
 ---@return string
 function M.pad_to(value, s)
     local padding = M.width(value) - M.width(s)
-    return M.pad(s, padding)
+    return M.pad(padding, s)
 end
 
----@param s string
 ---@param padding integer
+---@param s string?
 ---@return string
-function M.pad(s, padding)
-    return string.rep(' ', padding) .. s
+function M.pad(padding, s)
+    local result = string.rep(' ', padding)
+    if s ~= nil then
+        result = result .. s
+    end
+    return result
 end
 
 return M
diff --git a/lua/render-markdown/types.lua b/lua/render-markdown/types.lua
@@ -74,6 +74,7 @@
 ---@field public sign boolean
 ---@field public icons string[]
 ---@field public signs string[]
+---@field public width 'full'|'block'
 ---@field public backgrounds string[]
 ---@field public foregrounds string[]
 
