Fix a variety of health check configuration edge cases by using vim.validate

Author: MeanderingProgrammer

lua/render-markdown/health.lua

@@ -35,7 +35,7 @@ function M.check()
     end
 
     vim.health.start('markdown.nvim [configuration]')
-    local errors = M.check_keys(md.default_config, state.config, {})
+    local errors = M.check_config(state.config)
     if #errors == 0 then
         vim.health.ok('valid')
     end
@@ -69,27 +69,157 @@ function M.check_executable(name, advice)
     end
 end
 
----@param t1 table<any, any>
----@param t2 table<any, any>
----@param path string[]
+---@param config render.md.Config
 ---@return string[]
-function M.check_keys(t1, t2, path)
+function M.check_config(config)
     local errors = {}
-    for k, v2 in pairs(t2) do
-        local v1 = t1[k]
-        local key_path = vim.list_extend(vim.list_extend({}, path), { k })
-        local key = vim.fn.join(key_path, '.')
-        if v1 == nil then
-            table.insert(errors, string.format('Invalid key: %s', key))
-        elseif type(v1) ~= type(v2) then
-            table.insert(errors, string.format('Invalid type: %s, expected %s, found %s', key, type(v1), type(v2)))
-        elseif type(v1) == 'table' and type(v2) == 'table' then
-            -- Some tables are meant to have unrestricted keys
-            if not vim.tbl_contains({ 'win_options', 'custom', 'custom_handlers' }, k) then
-                vim.list_extend(errors, M.check_keys(v1, v2, key_path))
+
+    ---@param value string
+    ---@param valid_values string[]
+    ---@return vim.validate.Spec
+    local function one_of(value, valid_values)
+        return {
+            value,
+            function(v)
+                return vim.tbl_contains(valid_values, v)
+            end,
+            'one of ' .. vim.inspect(valid_values),
+        }
+    end
+
+    ---@param path string?
+    ---@param opts table<string, vim.validate.Spec>
+    local function append_errors(path, opts)
+        local ok, err = pcall(vim.validate, opts)
+        if not ok then
+            if path == nil then
+                table.insert(errors, err)
+            else
+                table.insert(errors, path .. '.' .. err)
             end
         end
     end
+
+    ---@param path string
+    ---@param values string[]
+    local function all_strings(path, values)
+        for i, value in ipairs(values) do
+            append_errors(path, {
+                [tostring(i)] = { value, 'string' },
+            })
+        end
+    end
+
+    append_errors(nil, {
+        start_enabled = { config.start_enabled, 'boolean' },
+        latex_enabled = { config.latex_enabled, 'boolean' },
+        max_file_size = { config.max_file_size, 'number' },
+        markdown_query = { config.markdown_query, 'string' },
+        markdown_quote_query = { config.markdown_quote_query, 'string' },
+        inline_query = { config.inline_query, 'string' },
+        latex_converter = { config.latex_converter, 'string' },
+        log_level = one_of(config.log_level, { 'debug', 'error' }),
+        file_types = { config.file_types, 'table' },
+        render_modes = { config.render_modes, 'table' },
+        headings = { config.headings, 'table' },
+        dash = { config.dash, 'string' },
+        bullets = { config.bullets, 'table' },
+        checkbox = { config.checkbox, 'table' },
+        quote = { config.quote, 'string' },
+        callout = { config.callout, 'table' },
+        win_options = { config.win_options, 'table' },
+        code_style = one_of(config.code_style, { 'full', 'normal', 'none' }),
+        table_style = one_of(config.table_style, { 'full', 'normal', 'none' }),
+        cell_style = one_of(config.cell_style, { 'overlay', 'raw' }),
+        custom_handlers = { config.custom_handlers, 'table' },
+        highlights = { config.highlights, 'table' },
+    })
+
+    all_strings('file_types', config.file_types)
+    all_strings('render_modes', config.render_modes)
+    all_strings('headings', config.headings)
+    all_strings('bullets', config.bullets)
+
+    append_errors('checkbox', {
+        unchecked = { config.checkbox.unchecked, 'string' },
+        checked = { config.checkbox.checked, 'string' },
+        custom = { config.checkbox.custom, 'table' },
+    })
+    for name, component in pairs(config.checkbox.custom) do
+        append_errors('checkbox.custom.' .. name, {
+            raw = { component.raw, 'string' },
+            rendered = { component.rendered, 'string' },
+            highlight = { component.highlight, 'string' },
+        })
+    end
+
+    append_errors('callout', {
+        note = { config.callout.note, 'string' },
+        tip = { config.callout.tip, 'string' },
+        important = { config.callout.important, 'string' },
+        warning = { config.callout.warning, 'string' },
+        caution = { config.callout.caution, 'string' },
+        custom = { config.callout.custom, 'table' },
+    })
+    for name, component in pairs(config.callout.custom) do
+        append_errors('callout.custom.' .. name, {
+            raw = { component.raw, 'string' },
+            rendered = { component.rendered, 'string' },
+            highlight = { component.highlight, 'string' },
+        })
+    end
+
+    for name, win_option in pairs(config.win_options) do
+        append_errors('win_options.' .. name, {
+            default = { win_option.default, { 'number', 'string' } },
+            rendered = { win_option.rendered, { 'number', 'string' } },
+        })
+    end
+
+    for name, handler in pairs(config.custom_handlers) do
+        append_errors('custom_handlers.' .. name, {
+            render = { handler.render, 'function' },
+            extends = { handler.extends, 'boolean', true },
+        })
+    end
+
+    append_errors('highlights', {
+        heading = { config.highlights.heading, 'table' },
+        dash = { config.highlights.dash, 'string' },
+        code = { config.highlights.code, 'string' },
+        bullet = { config.highlights.bullet, 'string' },
+        checkbox = { config.highlights.checkbox, 'table' },
+        table = { config.highlights.table, 'table' },
+        latex = { config.highlights.latex, 'string' },
+        quote = { config.highlights.quote, 'string' },
+        callout = { config.highlights.callout, 'table' },
+    })
+
+    append_errors('highlights.heading', {
+        backgrounds = { config.highlights.heading.backgrounds, 'table' },
+        foregrounds = { config.highlights.heading.foregrounds, 'table' },
+    })
+    all_strings('highlights.heading.backgrounds', config.highlights.heading.backgrounds)
+    all_strings('highlights.heading.foregrounds', config.highlights.heading.foregrounds)
+
+    append_errors('highlights.checkbox', {
+        unchecked = { config.highlights.checkbox.unchecked, 'string' },
+        checked = { config.highlights.checkbox.checked, 'string' },
+    })
+
+    append_errors('highlights.table', {
+        head = { config.highlights.table.head, 'string' },
+        row = { config.highlights.table.row, 'string' },
+    })
+
+    append_errors('highlights.callout', {
+        note = { config.highlights.callout.note, 'string' },
+        tip = { config.highlights.callout.tip, 'string' },
+        important = { config.highlights.callout.important, 'string' },
+        warning = { config.highlights.callout.warning, 'string' },
+        caution = { config.highlights.callout.caution, 'string' },
+    })
+
     return errors
 end