feat: Add dash.width option

## Details

Add dash.width option which is either the string 'full' or an integer.

When it is 'full' the dashed line will extend across the entire line,
which is the current behavior and the default value.

When it is a number the width of the dashed line will be the hard coded
value provided.

Original PR: #92

Co-Authored-By: Zeioth <[email protected]>

Author: MeanderingProgrammer

Diff for: README.md

@@ -254,6 +254,8 @@ 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 = 'full',
         -- Highlight for the whole line generated from the icon
         highlight = 'RenderMarkdownDash',
     },
@@ -497,6 +499,8 @@ 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 = 'full',
         -- Highlight for the whole line generated from the icon
         highlight = 'RenderMarkdownDash',
     },

Diff for: doc/render-markdown.txt

@@ -1,4 +1,4 @@
-*render-markdown.txt*           For 0.10.0           Last change: 2024 July 23
+*render-markdown.txt*           For 0.10.0           Last change: 2024 July 24
 
 ==============================================================================
 Table of Contents                          *render-markdown-table-of-contents*
@@ -294,6 +294,8 @@ 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 = 'full',
             -- Highlight for the whole line generated from the icon
             highlight = 'RenderMarkdownDash',
         },
@@ -538,6 +540,8 @@ 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 = 'full',
             -- Highlight for the whole line generated from the icon
             highlight = 'RenderMarkdownDash',
         },

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

@@ -139,13 +139,22 @@ M.render_dash = function(buf, info)
     if not dash.enabled then
         return nil
     end
+
+    local width
+    if dash.width == 'full' then
+        width = util.get_width(buf)
+    else
+        ---@type integer
+        width = dash.width
+    end
+
     ---@type render.md.Mark
     return {
         conceal = true,
         start_row = info.start_row,
         start_col = 0,
         opts = {
-            virt_text = { { dash.icon:rep(util.get_width(buf)), dash.highlight } },
+            virt_text = { { dash.icon:rep(width), dash.highlight } },
             virt_text_pos = 'overlay',
         },
     }

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

@@ -44,6 +44,11 @@ local M = {}
 ---@field public rendered? string
 ---@field public highlight? string
 
+---@class render.md.UserQuote
+---@field public enabled? boolean
+---@field public icon? string
+---@field public highlight? string
+
 ---@class render.md.UserCheckboxComponent
 ---@field public icon? string
 ---@field public highlight? string
@@ -59,9 +64,10 @@ local M = {}
 ---@field public icons? string[]
 ---@field public highlight? string
 
----@class render.md.UserBasicComponent
+---@class render.md.UserDash
 ---@field public enabled? boolean
 ---@field public icon? string
+---@field public width? 'full'|integer
 ---@field public highlight? string
 
 ---@class render.md.UserCode
@@ -111,10 +117,10 @@ local M = {}
 ---@field public latex? render.md.UserLatex
 ---@field public heading? render.md.UserHeading
 ---@field public code? render.md.UserCode
----@field public dash? render.md.UserBasicComponent
+---@field public dash? render.md.UserDash
 ---@field public bullet? render.md.UserBullet
 ---@field public checkbox? render.md.UserCheckbox
----@field public quote? render.md.UserBasicComponent
+---@field public quote? render.md.UserQuote
 ---@field public pipe_table? render.md.UserPipeTable
 ---@field public callout? table<string, render.md.UserCustomComponent>
 ---@field public link? render.md.UserLink
@@ -270,6 +276,8 @@ 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 = 'full',
         -- Highlight for the whole line generated from the icon
         highlight = 'RenderMarkdownDash',
     },

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

@@ -24,6 +24,20 @@ function state.validate()
         }
     end
 
+    ---@param value any
+    ---@param valid_values string[]
+    ---@param valid_type type
+    ---@return vim.validate.Spec
+    local function one_of_or(value, valid_values, valid_type)
+        return {
+            value,
+            function(v)
+                return vim.tbl_contains(valid_values, v) or type(v) == valid_type
+            end,
+            'one of ' .. vim.inspect(valid_values) .. ' or ' .. valid_type,
+        }
+    end
+
     ---@param value string[]
     ---@return vim.validate.Spec
     local function string_array(value)
@@ -133,6 +147,7 @@ function state.validate()
     append_errors('render-markdown.dash', dash, {
         enabled = { dash.enabled, 'boolean' },
         icon = { dash.icon, 'string' },
+        width = one_of_or(dash.width, { 'full' }, 'number'),
         highlight = { dash.highlight, 'string' },
     })
 

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

@@ -29,6 +29,11 @@
 ---@field public rendered string
 ---@field public highlight string
 
+---@class render.md.Quote
+---@field public enabled boolean
+---@field public icon string
+---@field public highlight string
+
 ---@class render.md.CheckboxComponent
 ---@field public icon string
 ---@field public highlight string
@@ -44,9 +49,10 @@
 ---@field public icons string[]
 ---@field public highlight string
 
----@class render.md.BasicComponent
+---@class render.md.Dash
 ---@field public enabled boolean
 ---@field public icon string
+---@field public width 'full'|integer
 ---@field public highlight string
 
 ---@class render.md.Code
@@ -96,10 +102,10 @@
 ---@field public latex render.md.Latex
 ---@field public heading render.md.Heading
 ---@field public code render.md.Code
----@field public dash render.md.BasicComponent
+---@field public dash render.md.Dash
 ---@field public bullet render.md.Bullet
 ---@field public checkbox render.md.Checkbox
----@field public quote render.md.BasicComponent
+---@field public quote render.md.Quote
 ---@field public pipe_table render.md.PipeTable
 ---@field public callout table<string, render.md.CustomComponent>
 ---@field public link render.md.Link