feat: support scope_highlight in custom checkboxes

## Details

Request: #207

Functions the same way as scope_highlight for checked and unchecked
checkboxes, but for all the user defined ones.

Author: MeanderingProgrammer

Diff for: README.md

@@ -392,11 +392,12 @@ require('render-markdown').setup({
         -- As a result this requires neovim >= 0.10.0 since it relies on 'inline' extmarks
         -- Can specify as many additional states as you like following the 'todo' pattern below
         --   The key in this case 'todo' is for healthcheck and to allow users to change its values
-        --   'raw':       Matched against the raw text of a 'shortcut_link'
-        --   'rendered':  Replaces the 'raw' value when rendering
-        --   'highlight': Highlight for the 'rendered' icon
+        --   'raw':             Matched against the raw text of a 'shortcut_link'
+        --   'rendered':        Replaces the 'raw' value when rendering
+        --   'highlight':       Highlight for the 'rendered' icon
+        --   'scope_highlight': Highlight for item associated with custom checkbox
         custom = {
-            todo = { raw = '[-]', rendered = '󰥔 ', highlight = 'RenderMarkdownTodo' },
+            todo = { raw = '[-]', rendered = '󰥔 ', highlight = 'RenderMarkdownTodo', scope_highlight = nil },
         },
     },
     quote = {
@@ -858,11 +859,12 @@ require('render-markdown').setup({
         -- As a result this requires neovim >= 0.10.0 since it relies on 'inline' extmarks
         -- Can specify as many additional states as you like following the 'todo' pattern below
         --   The key in this case 'todo' is for healthcheck and to allow users to change its values
-        --   'raw':       Matched against the raw text of a 'shortcut_link'
-        --   'rendered':  Replaces the 'raw' value when rendering
-        --   'highlight': Highlight for the 'rendered' icon
+        --   'raw':             Matched against the raw text of a 'shortcut_link'
+        --   'rendered':        Replaces the 'raw' value when rendering
+        --   'highlight':       Highlight for the 'rendered' icon
+        --   'scope_highlight': Highlight for item associated with custom checkbox
         custom = {
-            todo = { raw = '[-]', rendered = '󰥔 ', highlight = 'RenderMarkdownTodo' },
+            todo = { raw = '[-]', rendered = '󰥔 ', highlight = 'RenderMarkdownTodo', scope_highlight = nil },
         },
     },
 })

Diff for: doc/render-markdown.txt

@@ -1,4 +1,4 @@
-*render-markdown.txt*          For 0.10.0         Last change: 2024 October 16
+*render-markdown.txt*          For 0.10.0         Last change: 2024 October 17
 
 ==============================================================================
 Table of Contents                          *render-markdown-table-of-contents*
@@ -441,11 +441,12 @@ Default Configuration ~
             -- As a result this requires neovim >= 0.10.0 since it relies on 'inline' extmarks
             -- Can specify as many additional states as you like following the 'todo' pattern below
             --   The key in this case 'todo' is for healthcheck and to allow users to change its values
-            --   'raw':       Matched against the raw text of a 'shortcut_link'
-            --   'rendered':  Replaces the 'raw' value when rendering
-            --   'highlight': Highlight for the 'rendered' icon
+            --   'raw':             Matched against the raw text of a 'shortcut_link'
+            --   'rendered':        Replaces the 'raw' value when rendering
+            --   'highlight':       Highlight for the 'rendered' icon
+            --   'scope_highlight': Highlight for item associated with custom checkbox
             custom = {
-                todo = { raw = '[-]', rendered = '󰥔 ', highlight = 'RenderMarkdownTodo' },
+                todo = { raw = '[-]', rendered = '󰥔 ', highlight = 'RenderMarkdownTodo', scope_highlight = nil },
             },
         },
         quote = {
@@ -895,11 +896,12 @@ Checkbox Configuration ~
             -- As a result this requires neovim >= 0.10.0 since it relies on 'inline' extmarks
             -- Can specify as many additional states as you like following the 'todo' pattern below
             --   The key in this case 'todo' is for healthcheck and to allow users to change its values
-            --   'raw':       Matched against the raw text of a 'shortcut_link'
-            --   'rendered':  Replaces the 'raw' value when rendering
-            --   'highlight': Highlight for the 'rendered' icon
+            --   'raw':             Matched against the raw text of a 'shortcut_link'
+            --   'rendered':        Replaces the 'raw' value when rendering
+            --   'highlight':       Highlight for the 'rendered' icon
+            --   'scope_highlight': Highlight for item associated with custom checkbox
             custom = {
-                todo = { raw = '[-]', rendered = '󰥔 ', highlight = 'RenderMarkdownTodo' },
+                todo = { raw = '[-]', rendered = '󰥔 ', highlight = 'RenderMarkdownTodo', scope_highlight = nil },
             },
         },
     })

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

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

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

@@ -92,6 +92,7 @@ local M = {}
 ---@field public raw? string
 ---@field public rendered? string
 ---@field public highlight? string
+---@field public scope_highlight? string
 
 ---@class (exact) render.md.UserCheckboxComponent
 ---@field public icon? string
@@ -506,11 +507,12 @@ M.default_config = {
         -- As a result this requires neovim >= 0.10.0 since it relies on 'inline' extmarks
         -- Can specify as many additional states as you like following the 'todo' pattern below
         --   The key in this case 'todo' is for healthcheck and to allow users to change its values
-        --   'raw':       Matched against the raw text of a 'shortcut_link'
-        --   'rendered':  Replaces the 'raw' value when rendering
-        --   'highlight': Highlight for the 'rendered' icon
+        --   'raw':             Matched against the raw text of a 'shortcut_link'
+        --   'rendered':        Replaces the 'raw' value when rendering
+        --   'highlight':       Highlight for the 'rendered' icon
+        --   'scope_highlight': Highlight for item associated with custom checkbox
         custom = {
-            todo = { raw = '[-]', rendered = '󰥔 ', highlight = 'RenderMarkdownTodo' },
+            todo = { raw = '[-]', rendered = '󰥔 ', highlight = 'RenderMarkdownTodo', scope_highlight = nil },
         },
     },
     quote = {

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

@@ -44,6 +44,27 @@ function Base:sign(text, highlight)
     })
 end
 
+---@protected
+---@param highlight? string
+function Base:checkbox_scope(highlight)
+    if highlight == nil then
+        return
+    end
+    local paragraph = self.info:sibling('paragraph')
+    if paragraph == nil then
+        return
+    end
+    paragraph = paragraph:child('inline')
+    if paragraph == nil then
+        return
+    end
+    self.marks:add('check_scope', paragraph.start_row, paragraph.start_col, {
+        end_row = paragraph.end_row,
+        end_col = paragraph.end_col,
+        hl_group = highlight,
+    })
+end
+
 ---@protected
 ---@param destination string
 ---@return render.md.LinkComponent?

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

@@ -39,7 +39,7 @@ end
 
 function Render:render()
     self:icon()
-    self:highlight_scope()
+    self:checkbox_scope(self.checkbox.scope_highlight)
 end
 
 ---@private
@@ -55,21 +55,4 @@ function Render:icon()
     })
 end
 
----@private
-function Render:highlight_scope()
-    local highlight = self.checkbox.scope_highlight
-    if highlight == nil then
-        return
-    end
-    local paragraph = self.info:sibling('paragraph')
-    if paragraph == nil then
-        return
-    end
-    self.marks:add('check_scope', paragraph.start_row, paragraph.start_col, {
-        end_row = paragraph.end_row,
-        end_col = paragraph.end_col,
-        hl_group = highlight,
-    })
-end
-
 return Render

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

@@ -2,9 +2,13 @@ local Base = require('render-markdown.render.base')
 local list = require('render-markdown.core.list')
 local str = require('render-markdown.core.str')
 
+---@class render.md.data.ListMarker
+---@field leading_spaces integer
+---@field checkbox? render.md.CustomCheckbox
+
 ---@class render.md.render.ListMarker: render.md.Renderer
 ---@field private bullet render.md.Bullet
----@field private leading_spaces integer
+---@field private data render.md.data.ListMarker
 local Render = setmetatable({}, Base)
 Render.__index = Render
 
@@ -21,10 +25,13 @@ end
 function Render:setup()
     self.bullet = self.config.bullet
 
-    -- List markers from tree-sitter should have leading spaces removed, however there are edge
-    -- cases in the parser: https://github.com/tree-sitter-grammars/tree-sitter-markdown/issues/127
-    -- As a result we account for leading spaces here, can remove if this gets fixed upstream
-    self.leading_spaces = str.spaces('start', self.info.text)
+    self.data = {
+        -- List markers from tree-sitter should have leading spaces removed, however there are edge
+        -- cases in the parser: https://github.com/tree-sitter-grammars/tree-sitter-markdown/issues/127
+        -- As a result we account for leading spaces here, can remove if this gets fixed upstream
+        leading_spaces = str.spaces('start', self.info.text),
+        checkbox = self.context:get_checkbox(self.info),
+    }
 
     return true
 end
@@ -33,6 +40,7 @@ function Render:render()
     if self:sibling_checkbox() then
         -- Hide the list marker for checkboxes rather than replacing with a bullet point
         self:hide_marker()
+        self:highlight_scope()
     else
         if not self.bullet.enabled then
             return
@@ -49,7 +57,7 @@ function Render:sibling_checkbox()
     if not self.config.checkbox.enabled then
         return false
     end
-    if self.context:get_checkbox(self.info) ~= nil then
+    if self.data.checkbox ~= nil then
         return true
     end
     if self.info:sibling('task_list_marker_unchecked') ~= nil then
@@ -63,13 +71,21 @@ end
 
 ---@private
 function Render:hide_marker()
-    self.marks:add('check_icon', self.info.start_row, self.info.start_col + self.leading_spaces, {
+    self.marks:add('check_icon', self.info.start_row, self.info.start_col + self.data.leading_spaces, {
         end_row = self.info.end_row,
         end_col = self.info.end_col,
         conceal = '',
     })
 end
 
+---@private
+function Render:highlight_scope()
+    if self.data.checkbox == nil then
+        return
+    end
+    self:checkbox_scope(self.data.checkbox.scope_highlight)
+end
+
 ---@private
 ---@param level integer
 function Render:icon(level)
@@ -80,7 +96,7 @@ function Render:icon(level)
     self.marks:add('bullet', self.info.start_row, self.info.start_col, {
         end_row = self.info.end_row,
         end_col = self.info.end_col,
-        virt_text = { { str.pad(self.leading_spaces) .. icon, self.bullet.highlight } },
+        virt_text = { { str.pad(self.data.leading_spaces) .. icon, self.bullet.highlight } },
         virt_text_pos = 'overlay',
     })
 end

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

@@ -200,7 +200,7 @@ function M.validate()
             :type('scope_highlight', { 'string', 'nil' })
             :check()
         get_spec({ 'checkbox', 'custom' }):for_each(false, function(spec)
-            spec:type({ 'raw', 'rendered', 'highlight' }, 'string')
+            spec:type({ 'raw', 'rendered', 'highlight' }, 'string'):type('scope_highlight', { 'string', 'nil' })
         end)
 
         get_spec('quote')

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

@@ -75,6 +75,7 @@
 ---@field public raw string
 ---@field public rendered string
 ---@field public highlight string
+---@field public scope_highlight? string
 
 ---@class (exact) render.md.CheckboxComponent
 ---@field public icon string