feat: configurable scope priority

## Details

Request: #534

Adds `scope_priority` option to `bullet` & `checkbox` configurations.

This gets set as the priority for the scope highlight extmarks. The
default value is set to `nil` to avoid any changes to behavior, this
results in the extmark having the default priority of `4096`. Users can
configure it to a custom value to prefer showing treesitter highlights
or handle other potential conflicts.

Author: MeanderingProgrammer

README.md

@@ -583,6 +583,8 @@ require('render-markdown').setup({
         -- Highlight for item associated with the bullet point.
         -- Output is evaluated using the same logic as 'icons'.
         scope_highlight = {},
+        -- Priority to assign to scope highlight.
+        scope_priority = nil,
     },
     checkbox = {
         -- Checkboxes are a special instance of a 'list_item' that start with a 'shortcut_link'.
@@ -625,6 +627,8 @@ require('render-markdown').setup({
         custom = {
             todo = { raw = '[-]', rendered = '󰥔 ', highlight = 'RenderMarkdownTodo', scope_highlight = nil },
         },
+        -- Priority to assign to scope highlight.
+        scope_priority = nil,
     },
     quote = {
         -- Turn on / off block quote & callout rendering.
@@ -1244,6 +1248,8 @@ require('render-markdown').setup({
         -- Highlight for item associated with the bullet point.
         -- Output is evaluated using the same logic as 'icons'.
         scope_highlight = {},
+        -- Priority to assign to scope highlight.
+        scope_priority = nil,
     },
 })
 ```
@@ -1301,6 +1307,8 @@ require('render-markdown').setup({
         custom = {
             todo = { raw = '[-]', rendered = '󰥔 ', highlight = 'RenderMarkdownTodo', scope_highlight = nil },
         },
+        -- Priority to assign to scope highlight.
+        scope_priority = nil,
     },
 })
 ```

doc/render-markdown.txt

@@ -645,6 +645,8 @@ Default Configuration ~
             -- Highlight for item associated with the bullet point.
             -- Output is evaluated using the same logic as 'icons'.
             scope_highlight = {},
+            -- Priority to assign to scope highlight.
+            scope_priority = nil,
         },
         checkbox = {
             -- Checkboxes are a special instance of a 'list_item' that start with a 'shortcut_link'.
@@ -687,6 +689,8 @@ Default Configuration ~
             custom = {
                 todo = { raw = '[-]', rendered = '󰥔 ', highlight = 'RenderMarkdownTodo', scope_highlight = nil },
             },
+            -- Priority to assign to scope highlight.
+            scope_priority = nil,
         },
         quote = {
             -- Turn on / off block quote & callout rendering.
@@ -1296,6 +1300,8 @@ Bullet Point Configuration ~
             -- Highlight for item associated with the bullet point.
             -- Output is evaluated using the same logic as 'icons'.
             scope_highlight = {},
+            -- Priority to assign to scope highlight.
+            scope_priority = nil,
         },
     })
 <
@@ -1351,6 +1357,8 @@ Checkbox Configuration ~
             custom = {
                 todo = { raw = '[-]', rendered = '󰥔 ', highlight = 'RenderMarkdownTodo', scope_highlight = nil },
             },
+            -- Priority to assign to scope highlight.
+            scope_priority = nil,
         },
     })
 <

lua/render-markdown/health.lua

@@ -6,7 +6,7 @@ local state = require('render-markdown.state')
 local M = {}
 
 ---@private
-M.version = '8.9.1'
+M.version = '8.9.2'
 
 function M.check()
     M.start('versions')

lua/render-markdown/render/markdown/bullet.lua

@@ -161,6 +161,7 @@ function Render:scope()
         return
     end
     self.marks:over(self.config, true, self.node:scope(), {
+        priority = self.config.scope_priority,
         hl_group = highlight,
     })
 end

lua/render-markdown/render/markdown/checkbox.lua

@@ -123,6 +123,7 @@ function Render:scope()
         return
     end
     self.marks:over(self.config, 'check_scope', self.node:scope(), {
+        priority = self.config.scope_priority,
         hl_group = highlight,
     })
 end

lua/render-markdown/settings.lua

@@ -118,6 +118,7 @@ M.bullet = {}
 ---@field right_pad render.md.bullet.Integer
 ---@field highlight render.md.bullet.String
 ---@field scope_highlight render.md.bullet.String
+---@field scope_priority? integer
 
 ---@class (exact) render.md.bullet.Context
 ---@field level integer
@@ -174,6 +175,8 @@ M.bullet.default = {
     -- Highlight for item associated with the bullet point.
     -- Output is evaluated using the same logic as 'icons'.
     scope_highlight = {},
+    -- Priority to assign to scope highlight.
+    scope_priority = nil,
 }
 
 ---@return render.md.Schema
@@ -198,6 +201,7 @@ function M.bullet.schema()
         right_pad = integer_provider,
         highlight = string_provider,
         scope_highlight = string_provider,
+        scope_priority = { optional = true, type = 'number' },
     })
 end
 
@@ -280,6 +284,7 @@ M.checkbox = {}
 ---@field unchecked render.md.checkbox.component.Config
 ---@field checked render.md.checkbox.component.Config
 ---@field custom table<string, render.md.checkbox.custom.Config>
+---@field scope_priority? integer
 
 ---@class (exact) render.md.checkbox.component.Config
 ---@field icon string
@@ -334,6 +339,8 @@ M.checkbox.default = {
     custom = {
         todo = { raw = '[-]', rendered = '󰥔 ', highlight = 'RenderMarkdownTodo', scope_highlight = nil },
     },
+    -- Priority to assign to scope highlight.
+    scope_priority = nil,
 }
 
 ---@return render.md.Schema
@@ -362,6 +369,7 @@ function M.checkbox.schema()
         unchecked = component,
         checked = component,
         custom = { map = { { type = 'string' }, custom } },
+        scope_priority = { optional = true, type = 'number' },
     })
 end
 

lua/render-markdown/types.lua

@@ -58,6 +58,7 @@
 ---@field right_pad? render.md.bullet.Integer
 ---@field highlight? render.md.bullet.String
 ---@field scope_highlight? render.md.bullet.String
+---@field scope_priority? integer
 
 ---@alias render.md.callout.UserConfigs table<string, render.md.callout.UserConfig>
 
@@ -75,6 +76,7 @@
 ---@field unchecked? render.md.checkbox.component.UserConfig
 ---@field checked? render.md.checkbox.component.UserConfig
 ---@field custom? table<string, render.md.checkbox.custom.UserConfig>
+---@field scope_priority? integer
 
 ---@class (exact) render.md.checkbox.component.UserConfig
 ---@field icon? string