feat: ignore option, checked before attaching

## Details

Adds top level `ignore` configuration option. This option should be a
function which accepts a buffer id as input and returns a boolean of
whether to ignore the buffer or not. Default value returns `false` for
all buffers to keep behavior unchanged.

This runs after the filetype & max file size checks. Users should use
this if they want to be more clever about the kinds of buffers this
plugin ignores, where the filetype, size, & option approaches are not
enough.

For instance you could use to check if a certain variable is set on the
buffer using `vim.api.nvim_buf_get_var` and ignore buffers that specify
certain variables.

At the time of attaching to a buffer it may not necessarily be
associated with a `window`, and even if it were this `window` can change
over time, so the function is not provided with a `window` id as part of
its input. Instead if users want to use the window of a `buffer` to
decide they'll need to do something like `local win = vim.fn.bufwinid(buf)`.

Minor other refactors:

- Update validator to not return self
- Name the local configs in renderers info

Author: MeanderingProgrammer

README.md

@@ -204,6 +204,10 @@ require('render-markdown').setup({
     log_runtime = false,
     -- Filetypes this plugin will run on.
     file_types = { 'markdown' },
+    -- Takes buffer as input, if it returns true this plugin will not attach to the buffer
+    ignore = function()
+        return false
+    end,
     -- Additional events that will trigger this plugin's render loop.
     change_events = {},
     -- Out of the box language injections for known filetypes that allow markdown to be interpreted

doc/render-markdown.txt

@@ -1,4 +1,4 @@
-*render-markdown.txt*           For 0.11.0          Last change: 2025 April 07
+*render-markdown.txt*           For 0.11.0          Last change: 2025 April 08
 
 ==============================================================================
 Table of Contents                          *render-markdown-table-of-contents*
@@ -269,6 +269,10 @@ Default Configuration ~
         log_runtime = false,
         -- Filetypes this plugin will run on.
         file_types = { 'markdown' },
+        -- Takes buffer as input, if it returns true this plugin will not attach to the buffer
+        ignore = function()
+            return false
+        end,
         -- Additional events that will trigger this plugin's render loop.
         change_events = {},
         -- Out of the box language injections for known filetypes that allow markdown to be interpreted

lua/render-markdown/api.lua

@@ -30,7 +30,8 @@ function M.buf_toggle()
 end
 
 function M.log()
-    require('render-markdown.core.log').open()
+    local log = require('render-markdown.core.log')
+    log.open()
 end
 
 function M.expand()
@@ -44,14 +45,17 @@ function M.contract()
 end
 
 function M.debug()
-    local buf, win = Env.buf.current(), Env.win.current()
-    local row, marks =
-        require('render-markdown.core.ui').get_row_marks(buf, win)
-    require('render-markdown.debug.marks').debug(row, marks)
+    local ui = require('render-markdown.core.ui')
+    local disply = require('render-markdown.debug.marks')
+    local buf = Env.buf.current()
+    local win = Env.win.current()
+    local row, marks = ui.get_row_marks(buf, win)
+    disply.show(row, marks)
 end
 
 function M.config()
-    local difference = state.difference(require('render-markdown').default)
+    local markdown = require('render-markdown')
+    local difference = state.difference(markdown.default)
     if vim.tbl_count(difference) == 0 then
         vim.print('Default Configuration')
     else

lua/render-markdown/command.lua

@@ -29,20 +29,19 @@ end
 ---@private
 ---@param opts { fargs: string[] }
 function M.command(opts)
-    local args, message = opts.fargs, nil
+    local args, err = opts.fargs, nil
     if #args == 0 or #args == 1 then
         local command = #args == 0 and api.enable or api[args[1]]
         if command ~= nil then
             command()
         else
-            message = string.format('unexpected command: %s', args[1])
+            err = string.format('unexpected command: %s', args[1])
         end
     else
-        message = string.format('unexpected # arguments: %d', #args)
+        err = string.format('unexpected # arguments: %d', #args)
     end
-    if message ~= nil then
-        local notification = string.format('%s: %s', M.plugin, message)
-        vim.notify(notification, vim.log.levels.ERROR)
+    if err ~= nil then
+        vim.notify(string.format('%s: %s', M.plugin, err), vim.log.levels.ERROR)
     end
 end
 

lua/render-markdown/config.lua

@@ -37,44 +37,28 @@ function Config.new(config)
 end
 
 ---@param spec render.md.debug.ValidatorSpec
----@return render.md.debug.ValidatorSpec
 function Config.validate(spec)
     require('render-markdown.config.base').validate(spec)
-    return spec:type('max_file_size', 'number')
-        :type('debounce', 'number')
-        :nested(
-            'anti_conceal',
-            require('render-markdown.config.anti_conceal').validate
-        )
-        :nested('bullet', require('render-markdown.config.bullet').validate)
-        :nested('callout', require('render-markdown.config.callout').validate)
-        :nested('checkbox', require('render-markdown.config.checkbox').validate)
-        :nested('code', require('render-markdown.config.code').validate)
-        :nested('dash', require('render-markdown.config.dash').validate)
-        :nested('heading', require('render-markdown.config.heading').validate)
-        :nested('html', require('render-markdown.config.html').validate)
-        :nested('indent', require('render-markdown.config.indent').validate)
-        :nested(
-            'inline_highlight',
-            require('render-markdown.config.inline_highlight').validate
-        )
-        :nested('latex', require('render-markdown.config.latex').validate)
-        :nested('link', require('render-markdown.config.link').validate)
-        :nested('padding', require('render-markdown.config.padding').validate)
-        :nested(
-            'paragraph',
-            require('render-markdown.config.paragraph').validate
-        )
-        :nested(
-            'pipe_table',
-            require('render-markdown.config.pipe_table').validate
-        )
-        :nested('quote', require('render-markdown.config.quote').validate)
-        :nested('sign', require('render-markdown.config.sign').validate)
-        :nested(
-            'win_options',
-            require('render-markdown.config.win_options').validate
-        )
+    spec:type('max_file_size', 'number')
+    spec:type('debounce', 'number')
+    spec:config('anti_conceal')
+    spec:config('bullet')
+    spec:config('callout')
+    spec:config('checkbox')
+    spec:config('code')
+    spec:config('dash')
+    spec:config('heading')
+    spec:config('html')
+    spec:config('indent')
+    spec:config('inline_highlight')
+    spec:config('latex')
+    spec:config('link')
+    spec:config('padding')
+    spec:config('paragraph')
+    spec:config('pipe_table')
+    spec:config('quote')
+    spec:config('sign')
+    spec:config('win_options')
 end
 
 ---@private

lua/render-markdown/config/anti_conceal.lua

@@ -7,7 +7,7 @@
 ---@alias render.md.conceal.Ignore table<render.md.Element, render.md.Modes>
 
 ---@enum (key) render.md.Element
-local element = {
+local Element = {
     head_icon = 'head_icon',
     head_background = 'head_background',
     head_border = 'head_border',
@@ -30,14 +30,15 @@ local M = {}
 ---@param spec render.md.debug.ValidatorSpec
 function M.validate(spec)
     spec:type('enabled', 'boolean')
-        :nested('ignore', function(ignore)
-            ignore
-                :list(vim.tbl_keys(element), 'string', { 'boolean', 'nil' })
-                :check()
-        end)
-        :type('above', 'number')
-        :type('below', 'number')
-        :check()
+    spec:nested('ignore', function(ignore)
+        for element in pairs(Element) do
+            ignore:list(element, 'string', { 'boolean', 'nil' })
+        end
+        ignore:check()
+    end)
+    spec:type('above', 'number')
+    spec:type('below', 'number')
+    spec:check()
 end
 
 return M

lua/render-markdown/config/base.lua

@@ -8,7 +8,8 @@ local M = {}
 
 ---@param spec render.md.debug.ValidatorSpec
 function M.validate(spec)
-    spec:type('enabled', 'boolean'):list('render_modes', 'string', 'boolean')
+    spec:type('enabled', 'boolean')
+    spec:list('render_modes', 'string', 'boolean')
 end
 
 return M

lua/render-markdown/config/bullet.lua

@@ -27,12 +27,12 @@ local M = {}
 function M.validate(spec)
     require('render-markdown.config.base').validate(spec)
     spec:nested_list('icons', 'string', 'function')
-        :nested_list('ordered_icons', 'string', 'function')
-        :type('left_pad', { 'number', 'function' })
-        :type('right_pad', { 'number', 'function' })
-        :nested_list('highlight', 'string', 'function')
-        :nested_list('scope_highlight', 'string', 'function')
-        :check()
+    spec:nested_list('ordered_icons', 'string', 'function')
+    spec:type('left_pad', { 'number', 'function' })
+    spec:type('right_pad', { 'number', 'function' })
+    spec:nested_list('highlight', 'string', 'function')
+    spec:nested_list('scope_highlight', 'string', 'function')
+    spec:check()
 end
 
 return M

lua/render-markdown/config/callout.lua

@@ -10,14 +10,14 @@ local M = {}
 ---@param spec render.md.debug.ValidatorSpec
 function M.validate(spec)
     spec:each(function(callout)
-        callout
-            :type('raw', 'string')
-            :type('rendered', 'string')
-            :type('highlight', 'string')
-            :type('quote_icon', { 'string', 'nil' })
-            :type('category', { 'string', 'nil' })
-            :check()
-    end, false):check()
+        callout:type('raw', 'string')
+        callout:type('rendered', 'string')
+        callout:type('highlight', 'string')
+        callout:type('quote_icon', { 'string', 'nil' })
+        callout:type('category', { 'string', 'nil' })
+        callout:check()
+    end, false)
+    spec:check()
 end
 
 return M

lua/render-markdown/config/checkbox.lua

@@ -21,22 +21,23 @@ local M = {}
 function M.validate(spec)
     require('render-markdown.config.base').validate(spec)
     spec:type('right_pad', 'number')
-        :nested({ 'unchecked', 'checked' }, function(box)
-            box:type('icon', 'string')
-                :type('highlight', 'string')
-                :type('scope_highlight', { 'string', 'nil' })
-                :check()
+    spec:nested({ 'unchecked', 'checked' }, function(box)
+        box:type('icon', 'string')
+        box:type('highlight', 'string')
+        box:type('scope_highlight', { 'string', 'nil' })
+        box:check()
+    end)
+    spec:nested('custom', function(boxes)
+        boxes:each(function(box)
+            box:type('raw', 'string')
+            box:type('rendered', 'string')
+            box:type('highlight', 'string')
+            box:type('scope_highlight', { 'string', 'nil' })
+            box:check()
         end)
-        :nested('custom', function(boxes)
-            boxes:each(function(box)
-                box:type('raw', 'string')
-                    :type('rendered', 'string')
-                    :type('highlight', 'string')
-                    :type('scope_highlight', { 'string', 'nil' })
-                    :check()
-            end)
-        end)
-        :check()
+        boxes:check()
+    end)
+    spec:check()
 end
 
 return M