feat: allow checked / unchecked chechbox to provide scope highlight

## Details

Adds a `scope_highlight` property for use with checked and unchecked
checkboxes.

When provided the text associated with the checkbox gets highlighted by
this value.

This can be used to apply a strikethrough for checked checkboxes as an
example.

Author: MeanderingProgrammer

README.md

@@ -402,12 +402,16 @@ require('render-markdown').setup({
             icon = '󰄱 ',
             -- Highlight for the unchecked icon
             highlight = 'RenderMarkdownUnchecked',
+            -- Highlight for item associated with unchecked checkbox
+            scope_highlight = nil,
         },
         checked = {
             -- Replaces '[x]' of 'task_list_marker_checked'
             icon = '󰱒 ',
             -- Highligh for the checked icon
             highlight = 'RenderMarkdownChecked',
+            -- Highlight for item associated with checked checkbox
+            scope_highlight = nil,
         },
         -- Define custom checkbox states, more involved as they are not part of the markdown grammar
         -- As a result this requires neovim >= 0.10.0 since it relies on 'inline' extmarks
@@ -830,12 +834,16 @@ require('render-markdown').setup({
             icon = '󰄱 ',
             -- Highlight for the unchecked icon
             highlight = 'RenderMarkdownUnchecked',
+            -- Highlight for item associated with unchecked checkbox
+            scope_highlight = nil,
         },
         checked = {
             -- Replaces '[x]' of 'task_list_marker_checked'
             icon = '󰱒 ',
             -- Highligh for the checked icon
             highlight = 'RenderMarkdownChecked',
+            -- Highlight for item associated with checked checkbox
+            scope_highlight = nil,
         },
         -- Define custom checkbox states, more involved as they are not part of the markdown grammar
         -- As a result this requires neovim >= 0.10.0 since it relies on 'inline' extmarks

doc/render-markdown.txt

@@ -1,4 +1,4 @@
-*render-markdown.txt*         For 0.10.0        Last change: 2024 September 29
+*render-markdown.txt*         For 0.10.0        Last change: 2024 September 30
 
 ==============================================================================
 Table of Contents                          *render-markdown-table-of-contents*
@@ -450,12 +450,16 @@ Default Configuration ~
                 icon = '󰄱 ',
                 -- Highlight for the unchecked icon
                 highlight = 'RenderMarkdownUnchecked',
+                -- Highlight for item associated with unchecked checkbox
+                scope_highlight = nil,
             },
             checked = {
                 -- Replaces '[x]' of 'task_list_marker_checked'
                 icon = '󰱒 ',
                 -- Highligh for the checked icon
                 highlight = 'RenderMarkdownChecked',
+                -- Highlight for item associated with checked checkbox
+                scope_highlight = nil,
             },
             -- Define custom checkbox states, more involved as they are not part of the markdown grammar
             -- As a result this requires neovim >= 0.10.0 since it relies on 'inline' extmarks
@@ -868,12 +872,16 @@ Checkbox Configuration ~
                 icon = '󰄱 ',
                 -- Highlight for the unchecked icon
                 highlight = 'RenderMarkdownUnchecked',
+                -- Highlight for item associated with unchecked checkbox
+                scope_highlight = nil,
             },
             checked = {
                 -- Replaces '[x]' of 'task_list_marker_checked'
                 icon = '󰱒 ',
                 -- Highligh for the checked icon
                 highlight = 'RenderMarkdownChecked',
+                -- Highlight for item associated with checked checkbox
+                scope_highlight = nil,
             },
             -- Define custom checkbox states, more involved as they are not part of the markdown grammar
             -- As a result this requires neovim >= 0.10.0 since it relies on 'inline' extmarks

lua/render-markdown/health.lua

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

lua/render-markdown/init.lua

@@ -67,20 +67,21 @@ local M = {}
 ---@field public row? string
 ---@field public filler? string
 
----@class (exact) render.md.UserCustomComponent
----@field public raw? string
----@field public rendered? string
----@field public highlight? string
-
 ---@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.UserCustomComponent
+---@field public raw? string
+---@field public rendered? string
+---@field public highlight? string
+
 ---@class (exact) render.md.UserCheckboxComponent
 ---@field public icon? string
 ---@field public highlight? string
+---@field public scope_highlight? string
 
 ---@alias render.md.checkbox.Position 'overlay'|'inline'
 
@@ -89,7 +90,7 @@ local M = {}
 ---@field public position? render.md.checkbox.Position
 ---@field public unchecked? render.md.UserCheckboxComponent
 ---@field public checked? render.md.UserCheckboxComponent
----@field public custom? table<string, render.md.CustomComponent>
+---@field public custom? table<string, render.md.UserCustomComponent>
 
 ---@class (exact) render.md.UserBullet
 ---@field public enabled? boolean
@@ -476,12 +477,16 @@ M.default_config = {
             icon = '󰄱 ',
             -- Highlight for the unchecked icon
             highlight = 'RenderMarkdownUnchecked',
+            -- Highlight for item associated with unchecked checkbox
+            scope_highlight = nil,
         },
         checked = {
             -- Replaces '[x]' of 'task_list_marker_checked'
             icon = '󰱒 ',
             -- Highligh for the checked icon
             highlight = 'RenderMarkdownChecked',
+            -- Highlight for item associated with checked checkbox
+            scope_highlight = nil,
         },
         -- Define custom checkbox states, more involved as they are not part of the markdown grammar
         -- As a result this requires neovim >= 0.10.0 since it relies on 'inline' extmarks

lua/render-markdown/render/checkbox.lua

@@ -38,6 +38,12 @@ function Render:setup()
 end
 
 function Render:render()
+    self:icon()
+    self:highlight_scope()
+end
+
+---@private
+function Render:icon()
     local icon = self.checkbox.icon
     local text = self.inline and icon or str.pad_to(self.info.text, icon) .. icon
     self.marks:add(true, self.info.start_row, self.info.start_col, {
@@ -49,4 +55,21 @@ function Render:render()
     })
 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(true, paragraph.start_row, paragraph.start_col, {
+        end_row = paragraph.end_row,
+        end_col = paragraph.end_col,
+        hl_group = highlight,
+    })
+end
+
 return Render

lua/render-markdown/state.lua

@@ -189,8 +189,13 @@ function M.validate()
         validator
             :spec(path, config, { 'checkbox', 'unchecked' }, nilable)
             :type({ 'icon', 'highlight' }, 'string')
+            :type('scope_highlight', { 'string', 'nil' })
+            :check()
+        validator
+            :spec(path, config, { 'checkbox', 'checked' }, nilable)
+            :type({ 'icon', 'highlight' }, 'string')
+            :type('scope_highlight', { 'string', 'nil' })
             :check()
-        validator:spec(path, config, { 'checkbox', 'checked' }, nilable):type({ 'icon', 'highlight' }, 'string'):check()
         validator:spec(path, config, { 'checkbox', 'custom' }, nilable):for_each(function(spec)
             spec:type({ 'raw', 'rendered', 'highlight' }, 'string'):check()
         end)

lua/render-markdown/types.lua

@@ -50,20 +50,21 @@
 ---@field public row string
 ---@field public filler string
 
----@class (exact) render.md.CustomComponent
----@field public raw string
----@field public rendered string
----@field public highlight string
-
 ---@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.CustomComponent
+---@field public raw string
+---@field public rendered string
+---@field public highlight string
+
 ---@class (exact) render.md.CheckboxComponent
 ---@field public icon string
 ---@field public highlight string
+---@field public scope_highlight? string
 
 ---@class (exact) render.md.Checkbox
 ---@field public enabled boolean

scripts/update.py

@@ -35,7 +35,9 @@ def to_public_lines(self) -> list[str]:
             return []
         lines: list[str] = [self.name.replace("User", "")]
         for field in self.fields:
-            if "ConfigOverrides" in self.name:
+            if "scope_highlight" in field:
+                lines.append(field)
+            elif "ConfigOverrides" in self.name:
                 lines.append(field.replace("?", ""))
             else:
                 lines.append(field.replace("User", "").replace("?", ""))