feat: Allow users to set repeat linebreak for quotes / callouts

# Details

Request: #114

Adds the a `quote -> repeat_linebreak` boolean that defaults to false.
This setting applies both to regular block quotes as well as callouts.

When set will create an extmark with the `virt_text_repeat_linebreak`
option set. This value rquires neovim >= 0.10.0. With default settings
if this option is set it will obscure text on the wrapped line. Have
added suggestions for how to configure showbreak, breakindent, &
breakindentopt to get decent results.

Author: MeanderingProgrammer

README.md

@@ -337,6 +337,12 @@ require('render-markdown').setup({
         enabled = true,
         -- Replaces '>' of 'block_quote'
         icon = '▋',
+        -- Whether to repeat icon on wrapped lines. Requires neovim >= 0.10. This will obscure text if
+        -- not configured correctly with :h 'showbreak', :h 'breakindent' and :h 'breakindentopt'. A
+        -- combination of these that is likely to work is showbreak = '  ' (2 spaces), breakindent = true,
+        -- breakindentopt = '' (empty string). These values are not validated by this plugin. If you want
+        -- to avoid adding these to your main configuration then set them in win_options for this plugin.
+        repeat_linebreak = false,
         -- Highlight for the quote icon
         highlight = 'RenderMarkdownQuote',
     },
@@ -633,6 +639,12 @@ require('render-markdown').setup({
         enabled = true,
         -- Replaces '>' of 'block_quote'
         icon = '▋',
+        -- Whether to repeat icon on wrapped lines. Requires neovim >= 0.10. This will obscure text if
+        -- not configured correctly with :h 'showbreak', :h 'breakindent' and :h 'breakindentopt'. A
+        -- combination of these that is likely to work is showbreak = '  ' (2 spaces), breakindent = true,
+        -- breakindentopt = '' (empty string). These values are not validated by this plugin. If you want
+        -- to avoid adding these to your main configuration then set them in win_options for this plugin.
+        repeat_linebreak = false,
         -- Highlight for the quote icon
         highlight = 'RenderMarkdownQuote',
     },

doc/render-markdown.txt

@@ -370,6 +370,12 @@ Full Default Configuration ~
             enabled = true,
             -- Replaces '>' of 'block_quote'
             icon = '▋',
+            -- Whether to repeat icon on wrapped lines. Requires neovim >= 0.10. This will obscure text if
+            -- not configured correctly with :h 'showbreak', :h 'breakindent' and :h 'breakindentopt'. A
+            -- combination of these that is likely to work is showbreak = '  ' (2 spaces), breakindent = true,
+            -- breakindentopt = '' (empty string). These values are not validated by this plugin. If you want
+            -- to avoid adding these to your main configuration then set them in win_options for this plugin.
+            repeat_linebreak = false,
             -- Highlight for the quote icon
             highlight = 'RenderMarkdownQuote',
         },
@@ -670,6 +676,12 @@ BLOCK QUOTES                              *render-markdown-setup-block-quotes*
             enabled = true,
             -- Replaces '>' of 'block_quote'
             icon = '▋',
+            -- Whether to repeat icon on wrapped lines. Requires neovim >= 0.10. This will obscure text if
+            -- not configured correctly with :h 'showbreak', :h 'breakindent' and :h 'breakindentopt'. A
+            -- combination of these that is likely to work is showbreak = '  ' (2 spaces), breakindent = true,
+            -- breakindentopt = '' (empty string). These values are not validated by this plugin. If you want
+            -- to avoid adding these to your main configuration then set them in win_options for this plugin.
+            repeat_linebreak = false,
             -- Highlight for the quote icon
             highlight = 'RenderMarkdownQuote',
         },

lua/render-markdown/context.lua

@@ -1,3 +1,5 @@
+local util = require('render-markdown.util')
+
 ---@class render.md.Context
 ---@field private buf integer
 ---@field private win integer
@@ -88,7 +90,7 @@ end
 ---@private
 ---@return table<integer, [integer, integer][]>
 function Context:compute_conceal()
-    local conceallevel = vim.api.nvim_get_option_value('conceallevel', { scope = 'local', win = self.win })
+    local conceallevel = util.get_win(self.win, 'conceallevel')
     if conceallevel == 0 then
         return {}
     end

lua/render-markdown/handler/markdown.lua

@@ -507,6 +507,7 @@ function M.quote_marker(config, info, block_quote)
             end_col = info.end_col,
             virt_text = { { info.text:gsub('>', quote.icon), highlight } },
             virt_text_pos = 'overlay',
+            virt_text_repeat_linebreak = quote.repeat_linebreak or nil,
         },
     }
 end

lua/render-markdown/health.lua

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

lua/render-markdown/init.lua

@@ -19,8 +19,8 @@ local M = {}
 ---@field public bottom_pad? integer
 
 ---@class (exact) render.md.UserWindowOption
----@field public default? number|string
----@field public rendered? number|string
+---@field public default? number|string|boolean
+---@field public rendered? number|string|boolean
 
 ---@class (exact) render.md.UserSign
 ---@field public enabled? boolean
@@ -50,6 +50,7 @@ local M = {}
 ---@class (exact) render.md.UserQuote
 ---@field public enabled? boolean
 ---@field public icon? string
+---@field public repeat_linebreak? boolean
 ---@field public highlight? string
 
 ---@class (exact) render.md.UserCheckboxComponent
@@ -354,6 +355,12 @@ M.default_config = {
         enabled = true,
         -- Replaces '>' of 'block_quote'
         icon = '▋',
+        -- Whether to repeat icon on wrapped lines. Requires neovim >= 0.10. This will obscure text if
+        -- not configured correctly with :h 'showbreak', :h 'breakindent' and :h 'breakindentopt'. A
+        -- combination of these that is likely to work is showbreak = '  ' (2 spaces), breakindent = true,
+        -- breakindentopt = '' (empty string). These values are not validated by this plugin. If you want
+        -- to avoid adding these to your main configuration then set them in win_options for this plugin.
+        repeat_linebreak = false,
         -- Highlight for the quote icon
         highlight = 'RenderMarkdownQuote',
     },

lua/render-markdown/state.lua

@@ -250,6 +250,7 @@ function M.validate()
             append_errors(path .. '.quote', quote, {
                 enabled = { quote.enabled, 'boolean', nilable },
                 icon = { quote.icon, 'string', nilable },
+                repeat_linebreak = { quote.repeat_linebreak, 'boolean', nilable },
                 highlight = { quote.highlight, 'string', nilable },
             })
         end
@@ -299,8 +300,8 @@ function M.validate()
         if config.win_options ~= nil then
             for name, win_option in pairs(config.win_options) do
                 append_errors(path .. '.win_options.' .. name, win_option, {
-                    default = { win_option.default, { 'number', 'string' } },
-                    rendered = { win_option.rendered, { 'number', 'string' } },
+                    default = { win_option.default, { 'number', 'string', 'boolean' } },
+                    rendered = { win_option.rendered, { 'number', 'string', 'boolean' } },
                 })
             end
         end

lua/render-markdown/types.lua

@@ -8,8 +8,8 @@
 ---@field public bottom_pad integer
 
 ---@class (exact) render.md.WindowOption
----@field public default number|string
----@field public rendered number|string
+---@field public default number|string|boolean
+---@field public rendered number|string|boolean
 
 ---@class (exact) render.md.Sign
 ---@field public enabled boolean
@@ -39,6 +39,7 @@
 ---@class (exact) render.md.Quote
 ---@field public enabled boolean
 ---@field public icon string
+---@field public repeat_linebreak boolean
 ---@field public highlight string
 
 ---@class (exact) render.md.CheckboxComponent

lua/render-markdown/util.lua

@@ -28,14 +28,21 @@ end
 
 ---@param win integer
 ---@param name string
----@param value number|string
+---@return number|string|boolean
+function M.get_win(win, name)
+    return vim.api.nvim_get_option_value(name, { scope = 'local', win = win })
+end
+
+---@param win integer
+---@param name string
+---@param value number|string|boolean
 function M.set_win(win, name, value)
     vim.api.nvim_set_option_value(name, value, { scope = 'local', win = win })
 end
 
 ---@param buf integer
 ---@param name string
----@return number|string
+---@return number|string|boolean
 function M.get_buf(buf, name)
     return vim.api.nvim_get_option_value(name, { buf = buf })
 end