Change default dash character for thematic breaks

# Details

Updates the default thematic break dash to one that creates
a continuous line, same one used for tables.

Minor refactor on `ts.lua` module to be more consistent in
behavior across different methods.

Author: MeanderingProgrammer

README.md

@@ -137,7 +137,7 @@ require('render-markdown').setup({
     -- Characters that will replace the # at the start of headings
     headings = { '󰲡 ', '󰲣 ', '󰲥 ', '󰲧 ', '󰲩 ', '󰲫 ' },
     -- Character to use for the horizontal break
-    dash = '—',
+    dash = '─',
     -- Character to use for the bullet points in lists
     bullets = { '●', '○', '◆', '◇' },
     checkbox = {

demo/box_dash_quote.gif

@@ -174,7 +174,7 @@ modified by the user.
         -- Characters that will replace the # at the start of headings
         headings = { '󰲡 ', '󰲣 ', '󰲥 ', '󰲧 ', '󰲩 ', '󰲫 ' },
         -- Character to use for the horizontal break
-        dash = '—',
+        dash = '─',
         -- Character to use for the bullet points in lists
         bullets = { '●', '○', '◆', '◇' },
         checkbox = {

doc/render-markdown.txt

@@ -62,7 +62,7 @@ M.render_node = function(namespace, buf, capture, node)
             hl_eol = true,
         })
     elseif capture == 'list_marker' then
-        if ts.is_sibling(node, { 'task_list_marker_unchecked', 'task_list_marker_checked' }) then
+        if ts.sibling(node, { 'task_list_marker_unchecked', 'task_list_marker_checked' }) ~= nil then
             -- Hide the list marker for checkboxes rather than replacing with a bullet point
             vim.api.nvim_buf_set_extmark(buf, namespace, start_row, start_col, {
                 end_row = end_row,
@@ -74,7 +74,7 @@ M.render_node = function(namespace, buf, capture, node)
             -- edge cases in the parser: https://github.com/tree-sitter-grammars/tree-sitter-markdown/issues/127
             -- As a result we handle leading spaces here, can remove if this gets fixed upstream
             local _, leading_spaces = value:find('^%s*')
-            local level = ts.get_list_level(node)
+            local level = ts.level_in_section(node, 'list')
             local bullet = list.cycle(state.config.bullets, level)
 
             local list_marker_text = { string.rep(' ', leading_spaces or 0) .. bullet, highlights.bullet }
@@ -87,7 +87,7 @@ M.render_node = function(namespace, buf, capture, node)
         end
     elseif capture == 'quote_marker' then
         local highlight = highlights.quote
-        local quote = ts.get_parent(node, 'block_quote')
+        local quote = ts.parent_in_section(node, 'block_quote')
         if quote ~= nil then
             local quote_value = vim.treesitter.get_node_text(quote, buf)
             local key = callout.get_key_contains(quote_value)
@@ -137,7 +137,7 @@ M.render_node = function(namespace, buf, capture, node)
             return result
         end
 
-        local delim = ts.get_child(node, 'pipe_table_delimiter_row')
+        local delim = ts.child(node, 'pipe_table_delimiter_row')
         if delim == nil then
             return
         end

lua/render-markdown/handler/markdown.lua

@@ -130,7 +130,7 @@ M.default_config = {
     -- Characters that will replace the # at the start of headings
     headings = { '󰲡 ', '󰲣 ', '󰲥 ', '󰲧 ', '󰲩 ', '󰲫 ' },
     -- Character to use for the horizontal break
-    dash = '—',
+    dash = '─',
     -- Character to use for the bullet points in lists
     bullets = { '●', '○', '◆', '◇' },
     checkbox = {

lua/render-markdown/init.lua

@@ -1,59 +1,61 @@
-local M = {}
-
 ---@param node TSNode
----@param targets string[]
 ---@return boolean
-M.is_sibling = function(node, targets)
-    local sibling = node:next_sibling()
-    if sibling == nil then
-        return false
-    end
-    return vim.tbl_contains(targets, sibling:type())
+local function in_section(node)
+    -- reaching a section or document means we are outside section
+    return not vim.tbl_contains({ 'section', 'document' }, node:type())
 end
 
---- Walk through all parent nodes and count the number of list nodes
+local M = {}
+
+---Walk through parent nodes, count the number of target nodes
 ---@param node TSNode
+---@param target string
 ---@return integer
-M.get_list_level = function(node)
+M.level_in_section = function(node, target)
     local level = 0
     local parent = node:parent()
-    while parent ~= nil do
-        local parent_type = parent:type()
-        if vim.tbl_contains({ 'section', 'document' }, parent_type) then
-            -- reaching a section or document means we are clearly at the top of the list
-            break
-        elseif parent_type == 'list' then
-            -- found a list increase the level and continue
+    while parent ~= nil and in_section(parent) do
+        if parent:type() == target then
             level = level + 1
         end
         parent = parent:parent()
     end
     return level
 end
 
---- Walk through parent nodes until target, return first found
+---Walk through parent nodes, return first target node
 ---@param node TSNode
 ---@param target string
 ---@return TSNode?
-M.get_parent = function(node, target)
+M.parent_in_section = function(node, target)
     local parent = node:parent()
-    while parent ~= nil do
-        local parent_type = parent:type()
-        if vim.tbl_contains({ 'section', 'document' }, parent_type) then
-            -- reaching a section or document means we are clearly outside our target
-            break
-        elseif parent_type == target then
+    while parent ~= nil and in_section(parent) do
+        if parent:type() == target then
             return parent
         end
         parent = parent:parent()
     end
     return nil
 end
 
+---@param node TSNode
+---@param targets string[]
+---@return TSNode?
+M.sibling = function(node, targets)
+    local sibling = node:next_sibling()
+    while sibling ~= nil do
+        if vim.tbl_contains(targets, sibling:type()) then
+            return sibling
+        end
+        sibling = sibling:next_sibling()
+    end
+    return nil
+end
+
 ---@param node TSNode
 ---@param target string
 ---@return TSNode?
-M.get_child = function(node, target)
+M.child = function(node, target)
     for child in node:iter_children() do
         if child:type() == target then
             return child