Update healthcheck to catch additional parameters, add excluded buftypes

# Details

Rendering on LSP buffers may not be a desired behavior. Disable it
by default with new `exclude.buftypes` value 'nofile'. Users can
re-enable if desired.

Update healthcheck logic to check that additional keys are not
defined in places they are not expected.

Move validate logic into state, write some unit tests as sanity check.

Author: MeanderingProgrammer

Diff for: README.md

@@ -160,6 +160,10 @@ require('render-markdown').setup({
     -- Vim modes that will show a rendered view of the markdown file
     -- All other modes will be uneffected by this plugin
     render_modes = { 'n', 'c' },
+    exclude = {
+        -- Buftypes ignored by this plugin, see :h 'buftype'
+        buftypes = { 'nofile' },
+    },
     latex = {
         -- Whether LaTeX should be rendered, mainly used for health check
         enabled = true,

Diff for: doc/render-markdown.txt

@@ -1,4 +1,4 @@
-*render-markdown.txt*           For 0.10.0           Last change: 2024 July 10
+*render-markdown.txt*           For 0.10.0           Last change: 2024 July 11
 
 ==============================================================================
 Table of Contents                          *render-markdown-table-of-contents*
@@ -197,6 +197,10 @@ Full Default Configuration ~
         -- Vim modes that will show a rendered view of the markdown file
         -- All other modes will be uneffected by this plugin
         render_modes = { 'n', 'c' },
+        exclude = {
+            -- Buftypes ignored by this plugin, see :h 'buftype'
+            buftypes = { 'nofile' },
+        },
         latex = {
             -- Whether LaTeX should be rendered, mainly used for health check
             enabled = true,

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

@@ -4,7 +4,7 @@ local M = {}
 
 function M.check()
     vim.health.start('markdown.nvim [configuration]')
-    local errors = M.check_config(state.config)
+    local errors = state.validate()
     if #errors == 0 then
         vim.health.ok('valid')
     end
@@ -44,191 +44,6 @@ function M.check()
     end
 end
 
----@param config render.md.Config
----@return string[]
-function M.check_config(config)
-    local errors = {}
-
-    ---@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, {
-        enabled = { config.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' },
-        log_level = one_of(config.log_level, { 'debug', 'error' }),
-        file_types = { config.file_types, 'table' },
-        render_modes = { config.render_modes, 'table' },
-        latex = { config.latex, 'table' },
-        heading = { config.heading, 'table' },
-        code = { config.code, 'table' },
-        dash = { config.dash, 'table' },
-        bullet = { config.bullet, 'table' },
-        pipe_table = { config.pipe_table, 'table' },
-        checkbox = { config.checkbox, 'table' },
-        quote = { config.quote, 'table' },
-        callout = { config.callout, 'table' },
-        link = { config.link, 'table' },
-        win_options = { config.win_options, 'table' },
-        custom_handlers = { config.custom_handlers, 'table' },
-    })
-
-    all_strings('file_types', config.file_types)
-    all_strings('render_modes', config.render_modes)
-
-    local latex = config.latex
-    append_errors('latex', {
-        enabled = { latex.enabled, 'boolean' },
-        converter = { latex.converter, 'string' },
-        highlight = { latex.highlight, 'string' },
-    })
-
-    local heading = config.heading
-    append_errors('heading', {
-        enabled = { heading.enabled, 'boolean' },
-        icons = { heading.icons, 'table' },
-        signs = { heading.signs, 'table' },
-        backgrounds = { heading.backgrounds, 'table' },
-        foregrounds = { heading.foregrounds, 'table' },
-    })
-    all_strings('heading.icons', heading.icons)
-    all_strings('heading.signs', heading.signs)
-    all_strings('heading.backgrounds', heading.backgrounds)
-    all_strings('heading.foregrounds', heading.foregrounds)
-
-    local code = config.code
-    append_errors('code', {
-        enabled = { code.enabled, 'boolean' },
-        style = one_of(code.style, { 'full', 'language', 'normal', 'none' }),
-        highlight = { code.highlight, 'string' },
-    })
-
-    local dash = config.dash
-    append_errors('dash', {
-        enabled = { dash.enabled, 'boolean' },
-        icon = { dash.icon, 'string' },
-        highlight = { dash.highlight, 'string' },
-    })
-
-    local bullet = config.bullet
-    append_errors('bullet', {
-        enabled = { bullet.enabled, 'boolean' },
-        icons = { bullet.icons, 'table' },
-        highlight = { bullet.highlight, 'string' },
-    })
-    all_strings('bullet.icons', bullet.icons)
-
-    local checkbox = config.checkbox
-    append_errors('checkbox', {
-        enabled = { checkbox.enabled, 'boolean' },
-        unchecked = { checkbox.unchecked, 'table' },
-        checked = { checkbox.checked, 'table' },
-        custom = { checkbox.custom, 'table' },
-    })
-    local unchecked = checkbox.unchecked
-    append_errors('checkbox.unchecked', {
-        icon = { unchecked.icon, 'string' },
-        highlight = { unchecked.highlight, 'string' },
-    })
-    local checked = checkbox.checked
-    append_errors('checkbox.checked', {
-        icon = { checked.icon, 'string' },
-        highlight = { checked.highlight, 'string' },
-    })
-    for name, component in pairs(checkbox.custom) do
-        append_errors('checkbox.custom.' .. name, {
-            raw = { component.raw, 'string' },
-            rendered = { component.rendered, 'string' },
-            highlight = { component.highlight, 'string' },
-        })
-    end
-
-    local quote = config.quote
-    append_errors('quote', {
-        enabled = { quote.enabled, 'boolean' },
-        icon = { quote.icon, 'string' },
-        highlight = { quote.highlight, 'string' },
-    })
-
-    local pipe_table = config.pipe_table
-    append_errors('pipe_table', {
-        enabled = { pipe_table.enabled, 'boolean' },
-        style = one_of(pipe_table.style, { 'full', 'normal', 'none' }),
-        cell = one_of(pipe_table.cell, { 'overlay', 'raw' }),
-        border = { pipe_table.border, 'table' },
-        head = { pipe_table.head, 'string' },
-        row = { pipe_table.row, 'string' },
-    })
-    all_strings('pipe_table.border', pipe_table.border)
-
-    for name, component in pairs(config.callout) do
-        append_errors('callout.' .. name, {
-            raw = { component.raw, 'string' },
-            rendered = { component.rendered, 'string' },
-            highlight = { component.highlight, 'string' },
-        })
-    end
-
-    local link = config.link
-    append_errors('link', {
-        enabled = { link.enabled, 'boolean' },
-        image = { link.image, 'string' },
-        hyperlink = { link.hyperlink, 'string' },
-        highlight = { link.highlight, 'string' },
-    })
-
-    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
-
-    return errors
-end
-
 ---@param name string
 ---@param advice string?
 function M.check_parser(name, advice)

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

@@ -67,6 +67,9 @@ local M = {}
 ---@field public converter? string
 ---@field public highlight? string
 
+---@class render.md.UserExclude
+---@field public buftypes? string[]
+
 ---@class render.md.UserConfig
 ---@field public enabled? boolean
 ---@field public max_file_size? number
@@ -76,6 +79,7 @@ local M = {}
 ---@field public log_level? 'debug'|'error'
 ---@field public file_types? string[]
 ---@field public render_modes? string[]
+---@field public exclude? render.md.UserExclude
 ---@field public latex? render.md.UserLatex
 ---@field public heading? render.md.UserHeading
 ---@field public code? render.md.UserCode
@@ -150,6 +154,10 @@ M.default_config = {
     -- Vim modes that will show a rendered view of the markdown file
     -- All other modes will be uneffected by this plugin
     render_modes = { 'n', 'c' },
+    exclude = {
+        -- Buftypes ignored by this plugin, see :h 'buftype'
+        buftypes = { 'nofile' },
+    },
     latex = {
         -- Whether LaTeX should be rendered, mainly used for health check
         enabled = true,

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

@@ -20,7 +20,10 @@ function M.setup()
         group = group,
         pattern = state.config.file_types,
         callback = function(event)
-            M.attach(group, event.buf)
+            local buftype = vim.api.nvim_get_option_value('buftype', { buf = event.buf })
+            if not vim.tbl_contains(state.config.exclude.buftypes, buftype) then
+                M.attach(group, event.buf)
+            end
         end,
     })
     -- Window resizing is not buffer specific so is managed more globablly