feat: add scope_highlight to list items

## Details

Request: #354

Adds a `scope_highlight` parameter to the `bullet` configuration which
is used in the same way as the `checkbox` equivalent to highlight the item.

Also allows `highlight` to be the same type as `icons`, i.e. `string` |
`string[]` | `string[][]` | `function`. The support for a plain string
was added in this change as well to ensure backwards compatibility for
the `highlight` configuration.

Update documentation formatting and improve validation messages.

Author: MeanderingProgrammer

CHANGELOG.md

@@ -549,7 +549,7 @@ The fields impacted are:
 - Case insensitive callout matching [#74](https://github.com/MeanderingProgrammer/render-markdown.nvim/issues/74)
   [123048b](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/123048b428eb85618780fcef9ea9f4d68b5d2508)
 - Improve lazy.nvim instructions [#80](https://github.com/MeanderingProgrammer/render-markdown.nvim/pull/80)
-- Improve LaTeX compatibility [#90](https://github.com/MeanderingProgrammer/render-markdown.nvim/pull/90)
+- Improve latex compatibility [#90](https://github.com/MeanderingProgrammer/render-markdown.nvim/pull/90)
   [695501b](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/695501bd98b1f2ec052889fc4faef24dedd7091b)
 - Heading block width [#94](https://github.com/MeanderingProgrammer/render-markdown.nvim/pull/94)
   [426b135](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/426b13574c8264636e5660e5f5a3b4f5e3d5a937)
@@ -822,7 +822,7 @@ The fields impacted are:
   [fea6f3d](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/fea6f3de62d864633ffe4e1e0fd92d1e746f77ed)
 - Use buffer parser to handle injections [#3](https://github.com/MeanderingProgrammer/render-markdown.nvim/issues/3)
   [e64255d](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/e64255d52dcdf05eb37d9e93fbfd300648c4c4dd)
-- Add LaTeX support [#6](https://github.com/MeanderingProgrammer/render-markdown.nvim/issues/6)
+- Add latex support [#6](https://github.com/MeanderingProgrammer/render-markdown.nvim/issues/6)
   [138a796](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/138a7962fcbe9cddcb47cc40a58ec0f5ab99ddfe)
   [da85a5e](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/da85a5e5885f1a11ab2b7a9059c16f3eede89bfe)
 - Support block quotes [106946a](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/106946ae924706c885bda14a9160398e79880f30)
@@ -835,7 +835,7 @@ The fields impacted are:
 - Add fat tables option [fb00297](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/fb00297774c6f44c0cc3346459ed85168ac93dce)
 - Support list icon based on level [#1](https://github.com/MeanderingProgrammer/render-markdown.nvim/issues/1)
   [#11](https://github.com/MeanderingProgrammer/render-markdown.nvim/pull/11)
-- Refactor + LaTeX cache [2b98d16](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/2b98d16f938dc9cedaa5f1c0659081035655f781)
+- Refactor + latex cache [2b98d16](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/2b98d16f938dc9cedaa5f1c0659081035655f781)
 - Support horizontal break [af819f3](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/af819f39c63aeb09ff3801dbfd5188cea55e48e7)
 - Support checkboxes [90637a1](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/90637a1120de47a3be57b00b7db4eee0d24834c8)
 

README.md

@@ -4,7 +4,7 @@ local util = require('benches.util')
 
 describe('README.md', function()
     it('default', function()
-        local base_marks = 115
+        local base_marks = 114
         util.less_than(util.setup('README.md'), 60)
         util.num_marks(base_marks)
 

benches/readme_spec.lua

@@ -52,9 +52,9 @@ For each `mark` in the return value the fields mean:
 By not specifying the `extends` field and having the `parse` implementation return
 an empty table we can disable a builtin handler. Though this has little benefit and
 can be accomplished in other ways like setting `{ latex = { enabled = false } }`
-for `LaTeX`.
+for `latex`.
 
-Still as a toy example disabling the `LaTeX` handler can be done with:
+Still as a toy example disabling the `latex` handler can be done with:
 
 ```lua
 require('render-markdown').setup({

doc/custom-handlers.md

@@ -1,12 +1,12 @@
 # Limitations
 
-## `LaTeX` Formula Positioning
+## `latex` Formula Positioning
 
 [ISSUE #6](https://github.com/MeanderingProgrammer/render-markdown.nvim/issues/6)
 
-`LaTeX` formula evaluations are placed above text rather than overlaid.
+`latex` formula evaluations are placed above text rather than overlaid.
 
-A way around this is to use a separate plugin for `LaTeX` and disable that feature
+A way around this is to use a separate plugin for `latex` and disable that feature
 in this plugin. Different plugins will have different setups, below are some examples:
 
 [latex.nvim](https://github.com/ryleelyman/latex.nvim)

doc/limitations.md

@@ -11,7 +11,7 @@ plugin is not functioning how you expect. As such it is recommended to go in ord
 
 If there are any `errors` these should be looked at closely, `warnings` can largely
 be ignored. They are generated to help debug issues for less critical components,
-i.e. `LaTeX` support.
+i.e. `latex` support.
 
 ## Validate `filetype`
 

doc/render-markdown.txt

@@ -1,6 +1,9 @@
 local Iter = require('render-markdown.lib.iter')
 
+---@alias render.md.debug.SpecKind 'type'|'value'
+
 ---@class render.md.debug.Spec
+---@field kind render.md.debug.SpecKind
 ---@field message string
 ---@field validation fun(value: any): boolean, string?
 
@@ -56,38 +59,39 @@ function Spec:nested(keys, f, nilable)
 end
 
 ---@param keys string|string[]
----@param input_types type|type[]
+---@param ts type|type[]
 ---@return render.md.debug.ValidatorSpec
-function Spec:type(keys, input_types)
-    local types, message = self:handle_types(input_types, '')
-    return self:add(keys, message, function(value)
+function Spec:type(keys, ts)
+    local types, message = self:handle_types({}, ts)
+    return self:add(keys, 'type', message, function(value)
         return vim.tbl_contains(types, type(value))
     end)
 end
 
 ---@param keys string|string[]
 ---@param values string[]
----@param input_types? type|type[]
+---@param ts? type|type[]
 ---@return render.md.debug.ValidatorSpec
-function Spec:one_of(keys, values, input_types)
-    local types, message = self:handle_types(input_types, 'one of ' .. vim.inspect(values))
-    return self:add(keys, message, function(value)
+function Spec:one_of(keys, values, ts)
+    local options = Iter.list.map(values, vim.inspect)
+    local types, message = self:handle_types(options, ts)
+    return self:add(keys, 'value', message, function(value)
         return vim.tbl_contains(values, value) or vim.tbl_contains(types, type(value))
     end)
 end
 
 ---@param keys string|string[]
----@param list_type type
----@param input_types? type|type[]
+---@param t type
+---@param ts? type|type[]
 ---@return render.md.debug.ValidatorSpec
-function Spec:list(keys, list_type, input_types)
-    local types, message = self:handle_types(input_types, list_type .. ' list')
-    return self:add(keys, message, function(value)
+function Spec:list(keys, t, ts)
+    local types, message = self:handle_types({ t .. '[]' }, ts)
+    return self:add(keys, 'type', message, function(value)
         if vim.tbl_contains(types, type(value)) then
             return true
         elseif type(value) == 'table' then
             for i, item in ipairs(value) do
-                if type(item) ~= list_type then
+                if type(item) ~= t then
                     return false, string.format('[%d] is %s', i, type(item))
                 end
             end
@@ -99,23 +103,23 @@ function Spec:list(keys, list_type, input_types)
 end
 
 ---@param keys string|string[]
----@param list_type type
----@param input_types? type|type[]
+---@param t type
+---@param ts? type|type[]
 ---@return render.md.debug.ValidatorSpec
-function Spec:list_or_list_of_list(keys, list_type, input_types)
-    local types, message = self:handle_types(input_types, list_type .. ' list or list of list')
-    return self:add(keys, message, function(value)
-        if vim.tbl_contains(types, type(value)) then
+function Spec:nested_list(keys, t, ts)
+    local types, message = self:handle_types({ t, t .. '[]', t .. '[][]' }, ts)
+    return self:add(keys, 'type', message, function(value)
+        if type(value) == t or vim.tbl_contains(types, type(value)) then
             return true
         elseif type(value) == 'table' then
             for i, item in ipairs(value) do
                 if type(item) == 'table' then
                     for j, nested in ipairs(item) do
-                        if type(nested) ~= list_type then
+                        if type(nested) ~= t then
                             return false, string.format('[%d][%d] is %s', i, j, type(nested))
                         end
                     end
-                elseif type(item) ~= list_type then
+                elseif type(item) ~= t then
                     return false, string.format('[%d] is %s', i, type(item))
                 end
             end
@@ -128,11 +132,12 @@ end
 
 ---@param keys string|string[]
 ---@param values string[]
----@param input_types? type|type[]
+---@param ts? type|type[]
 ---@return render.md.debug.ValidatorSpec
-function Spec:one_or_list_of(keys, values, input_types)
-    local types, message = self:handle_types(input_types, 'one or list of ' .. vim.inspect(values))
-    return self:add(keys, message, function(value)
+function Spec:one_or_list_of(keys, values, ts)
+    local options = '(' .. table.concat(Iter.list.map(values, vim.inspect), '|') .. ')'
+    local types, message = self:handle_types({ options, options .. '[]' }, ts)
+    return self:add(keys, 'type', message, function(value)
         if vim.tbl_contains(types, type(value)) then
             return true
         elseif type(value) == 'string' then
@@ -151,41 +156,35 @@ function Spec:one_or_list_of(keys, values, input_types)
 end
 
 ---@private
----@param input_types? type|type[]
----@param prefix string
+---@param custom string[]
+---@param ts? type|type[]
 ---@return type[], string
-function Spec:handle_types(input_types, prefix)
+function Spec:handle_types(custom, ts)
     local types = nil
-    if input_types == nil then
+    if ts == nil then
         types = {}
-    elseif type(input_types) == 'string' then
-        types = { input_types }
+    elseif type(ts) == 'string' then
+        types = { ts }
     else
-        types = input_types
+        types = ts
     end
     if self.nilable and not vim.tbl_contains(types, 'nil') then
         table.insert(types, 'nil')
     end
-    local message = prefix
-    if #types > 0 then
-        if #message > 0 then
-            message = message .. ' or '
-        end
-        message = message .. 'type ' .. table.concat(types, ' or ')
-    end
-    return types, message
+    return types, table.concat(vim.list_extend(custom, types), ' or ')
 end
 
 ---@private
 ---@param keys string|string[]
+---@param kind render.md.debug.SpecKind
 ---@param message string
 ---@param validation fun(v: any): boolean, string?
 ---@return render.md.debug.ValidatorSpec
-function Spec:add(keys, message, validation)
+function Spec:add(keys, kind, message, validation)
     if self.config ~= nil then
         keys = type(keys) == 'table' and keys or { keys }
         for _, key in ipairs(keys) do
-            self.specs[key] = { message = message, validation = validation }
+            self.specs[key] = { kind = kind, message = message, validation = validation }
         end
     end
     return self
@@ -223,7 +222,13 @@ function Validator:check(path, config, specs)
         local value = config[key]
         local ok, info = spec.validation(value)
         if not ok then
-            local message = string.format('%s.%s: expected %s, got %s', path, key, spec.message, type(value))
+            local message = string.format('%s.%s - expected: %s', path, key, spec.message)
+            if spec.kind == 'type' then
+                message = message .. string.format(', but got: %s', type(value))
+            end
+            if spec.kind == 'value' then
+                message = message .. string.format(', but got: %s', vim.inspect(value))
+            end
             if info ~= nil then
                 message = message .. string.format(', info: %s', info)
             end
@@ -232,7 +237,7 @@ function Validator:check(path, config, specs)
     end
     for key, _ in pairs(config) do
         if specs[key] == nil then
-            local message = string.format('%s.%s: is not a valid key', path, key)
+            local message = string.format('%s.%s - invalid key', path, key)
             table.insert(self.errors, message)
         end
     end

doc/troubleshooting.md

@@ -5,7 +5,7 @@ local state = require('render-markdown.state')
 local M = {}
 
 ---@private
-M.version = '8.0.16'
+M.version = '8.0.17'
 
 function M.check()
     M.start('version')