feat: allow render_modes to be a boolean

## Details

Allow the render modes parameter to be a boolean rather than a list of
modes. When it is a boolean the mode of the current buffer stops playing
a role and rendering either always occurs or never occurs. Using false
does not make sense in this case but by setting it to true one can avoid
adding all the modes to the list.

Made the main buffer Config a class so that logic to determine things
like should render and handling the different types can be centralized.

Author: MeanderingProgrammer

lua/render-markdown/components.lua renamed to lua/render-markdown/config.lua

@@ -4,29 +4,40 @@
 
 ---@class render.md.buffer.Config: render.md.BufferConfig
 ---@field component render.md.component.Config
-
----@class render.md.component.Resolver
-local M = {}
+local Config = {}
+Config.__index = Config
 
 ---@param config render.md.BufferConfig
 ---@return render.md.buffer.Config
-function M.resolve(config)
+function Config.new(config)
     ---@type render.md.component.Config
     local component = {
-        callout = M.normalize(config.callout),
-        checkbox = M.normalize(config.checkbox.custom),
+        callout = Config.normalize(config.callout),
+        checkbox = Config.normalize(config.checkbox.custom),
     }
-    return vim.tbl_deep_extend('force', { component = component }, config)
+    local instance = vim.tbl_deep_extend('force', { component = component }, config)
+    return setmetatable(instance, Config)
 end
 
 ---@private
 ---@param components table<string, render.md.CustomComponent>
-function M.normalize(components)
+function Config.normalize(components)
     local result = {}
     for _, component in pairs(components) do
         result[component.raw:lower()] = component
     end
     return result
 end
 
-return M
+---@param mode string
+---@return boolean
+function Config:render(mode)
+    local modes = self.render_modes
+    if type(modes) == 'table' then
+        return vim.tbl_contains(modes, mode)
+    else
+        return modes
+    end
+end
+
+return Config

lua/render-markdown/core/ui.lua

@@ -121,7 +121,7 @@ function M.next_state(config, win)
     if not util.view(win).leftcol == 0 then
         return 'default'
     end
-    if not vim.tbl_contains(config.render_modes, vim.fn.mode(true)) then
+    if not config:render(vim.fn.mode(true)) then
         return 'default'
     end
     return 'rendered'

lua/render-markdown/health.lua

@@ -4,7 +4,7 @@ local state = require('render-markdown.state')
 local M = {}
 
 ---@private
-M.version = '7.0.6'
+M.version = '7.0.7'
 
 function M.check()
     M.start('version')

lua/render-markdown/init.lua

@@ -157,7 +157,7 @@ local M = {}
 ---@field public enabled? boolean
 ---@field public max_file_size? number
 ---@field public debounce? integer
----@field public render_modes? string[]
+---@field public render_modes? string[]|boolean
 ---@field public anti_conceal? render.md.UserAntiConceal
 ---@field public heading? render.md.UserHeading
 ---@field public code? render.md.UserCode

lua/render-markdown/manager.lua

@@ -59,7 +59,7 @@ function M.attach(buf)
     local config = state.get_config(buf)
     local events = { 'BufWinEnter', 'BufLeave', 'CursorHold', 'CursorMoved' }
     local change_events = { 'ModeChanged', 'TextChanged' }
-    if vim.tbl_contains(config.render_modes, 'i') then
+    if config:render('i') then
         vim.list_extend(events, { 'CursorHoldI', 'CursorMovedI' })
         vim.list_extend(change_events, { 'TextChangedI' })
     end

lua/render-markdown/state.lua

@@ -1,4 +1,4 @@
-local components = require('render-markdown.components')
+local Config = require('render-markdown.config')
 local log = require('render-markdown.core.log')
 local presets = require('render-markdown.presets')
 local treesitter = require('render-markdown.core.treesitter')
@@ -78,7 +78,7 @@ function M.get_config(buf)
                 buf_config = vim.tbl_deep_extend('force', buf_config, override)
             end
         end
-        config = components.resolve(buf_config)
+        config = Config.new(buf_config)
         configs[buf] = config
     end
     return config
@@ -113,45 +113,49 @@ end
 
 ---@return string[]
 function M.validate()
-    local errors = {}
+    ---@param types type[]
+    ---@param nilable boolean
+    ---@return string
+    local function handle_types(types, nilable)
+        if nilable then
+            table.insert(types, 'nil')
+        end
+        return #types == 0 and '' or (' or type ' .. vim.inspect(types))
+    end
 
     ---@param value any
-    ---@param valid_values string[]
-    ---@param valid_types type[]
+    ---@param values string[]
+    ---@param types type[]
     ---@param nilable boolean
     ---@return vim.validate.Spec
-    local function one_of(value, valid_values, valid_types, nilable)
-        if nilable then
-            table.insert(valid_types, 'nil')
-        end
+    local function one_of(value, values, types, nilable)
+        local suffix = handle_types(types, nilable)
         return {
             value,
             function(v)
-                return vim.tbl_contains(valid_values, v) or vim.tbl_contains(valid_types, type(v))
+                return vim.tbl_contains(values, v) or vim.tbl_contains(types, type(v))
             end,
-            'one of ' .. vim.inspect(valid_values) .. ' or type ' .. vim.inspect(valid_types),
+            'one of ' .. vim.inspect(values) .. suffix,
         }
     end
 
     ---@param value any
-    ---@param valid_values string[]
+    ---@param values string[]
+    ---@param types type[]
     ---@param nilable boolean
     ---@return vim.validate.Spec
-    local function one_or_array_of(value, valid_values, nilable)
-        local description = 'one or array of ' .. vim.inspect(valid_values)
-        if nilable then
-            description = description .. ' or nil'
-        end
+    local function one_or_array_of(value, values, types, nilable)
+        local suffix = handle_types(types, nilable)
         return {
             value,
             function(v)
-                if v == nil then
-                    return nilable
+                if vim.tbl_contains(types, type(v)) then
+                    return true
                 elseif type(v) == 'string' then
-                    return vim.tbl_contains(valid_values, v)
+                    return vim.tbl_contains(values, v)
                 elseif type(v) == 'table' then
                     for i, item in ipairs(v) do
-                        if not vim.tbl_contains(valid_values, item) then
+                        if not vim.tbl_contains(values, item) then
                             return false, string.format('Index %d is %s', i, item)
                         end
                     end
@@ -160,23 +164,21 @@ function M.validate()
                     return false
                 end
             end,
-            description,
+            'one or array of ' .. vim.inspect(values) .. suffix,
         }
     end
 
-    ---@param value string[]
+    ---@param value any
+    ---@param types type[]
     ---@param nilable boolean
     ---@return vim.validate.Spec
-    local function string_array(value, nilable)
-        local description = 'string array'
-        if nilable then
-            description = description .. ' or nil'
-        end
+    local function string_array(value, types, nilable)
+        local suffix = handle_types(types, nilable)
         return {
             value,
             function(v)
-                if v == nil then
-                    return nilable
+                if vim.tbl_contains(types, type(v)) then
+                    return true
                 elseif type(v) == 'table' then
                     for i, item in ipairs(v) do
                         if type(item) ~= 'string' then
@@ -188,10 +190,12 @@ function M.validate()
                     return false
                 end
             end,
-            description,
+            'string array' .. suffix,
         }
     end
 
+    local errors = {}
+
     ---@param suffix string
     ---@param input table<string, any>
     ---@param opts table<string, vim.validate.Spec>
@@ -227,18 +231,18 @@ function M.validate()
                 enabled = { heading.enabled, 'boolean', nilable },
                 sign = { heading.sign, 'boolean', nilable },
                 position = one_of(heading.position, { 'overlay', 'inline' }, {}, nilable),
-                icons = string_array(heading.icons, nilable),
-                signs = string_array(heading.signs, nilable),
-                width = one_or_array_of(heading.width, { 'full', 'block' }, nilable),
+                icons = string_array(heading.icons, {}, nilable),
+                signs = string_array(heading.signs, {}, nilable),
+                width = one_or_array_of(heading.width, { 'full', 'block' }, {}, nilable),
                 left_pad = { heading.left_pad, 'number', nilable },
                 right_pad = { heading.right_pad, 'number', nilable },
                 min_width = { heading.min_width, 'number', nilable },
                 border = { heading.border, 'boolean', nilable },
                 border_prefix = { heading.border_prefix, 'boolean', nilable },
                 above = { heading.above, 'string', nilable },
                 below = { heading.below, 'string', nilable },
-                backgrounds = string_array(heading.backgrounds, nilable),
-                foregrounds = string_array(heading.foregrounds, nilable),
+                backgrounds = string_array(heading.backgrounds, {}, nilable),
+                foregrounds = string_array(heading.foregrounds, {}, nilable),
             })
         end
 
@@ -250,7 +254,7 @@ function M.validate()
                 style = one_of(code.style, { 'full', 'normal', 'language', 'none' }, {}, nilable),
                 position = one_of(code.position, { 'left', 'right' }, {}, nilable),
                 language_pad = { code.language_pad, 'number', nilable },
-                disable_background = string_array(code.disable_background, nilable),
+                disable_background = string_array(code.disable_background, {}, nilable),
                 width = one_of(code.width, { 'full', 'block' }, {}, nilable),
                 left_pad = { code.left_pad, 'number', nilable },
                 right_pad = { code.right_pad, 'number', nilable },
@@ -277,7 +281,7 @@ function M.validate()
         if bullet ~= nil then
             append_errors(path .. '.bullet', bullet, {
                 enabled = { bullet.enabled, 'boolean', nilable },
-                icons = string_array(bullet.icons, nilable),
+                icons = string_array(bullet.icons, {}, nilable),
                 left_pad = { bullet.left_pad, 'number', nilable },
                 right_pad = { bullet.right_pad, 'number', nilable },
                 highlight = { bullet.highlight, 'string', nilable },
@@ -336,7 +340,7 @@ function M.validate()
                 style = one_of(pipe_table.style, { 'full', 'normal', 'none' }, {}, nilable),
                 cell = one_of(pipe_table.cell, { 'padded', 'raw', 'overlay' }, {}, nilable),
                 min_width = { pipe_table.min_width, 'number', nilable },
-                border = string_array(pipe_table.border, nilable),
+                border = string_array(pipe_table.border, {}, nilable),
                 alignment_indicator = { pipe_table.alignment_indicator, 'string', nilable },
                 head = { pipe_table.head, 'string', nilable },
                 row = { pipe_table.row, 'string', nilable },
@@ -408,7 +412,7 @@ function M.validate()
         enabled = { config.enabled, 'boolean' },
         max_file_size = { config.max_file_size, 'number' },
         debounce = { config.debounce, 'number' },
-        render_modes = string_array(config.render_modes, false),
+        render_modes = string_array(config.render_modes, { 'boolean' }, false),
         anti_conceal = { config.anti_conceal, 'table' },
         heading = { config.heading, 'table' },
         code = { config.code, 'table' },
@@ -427,7 +431,7 @@ function M.validate()
         markdown_quote_query = { config.markdown_quote_query, 'string' },
         inline_query = { config.inline_query, 'string' },
         log_level = one_of(config.log_level, { 'debug', 'error' }, {}, false),
-        file_types = string_array(config.file_types, false),
+        file_types = string_array(config.file_types, {}, false),
         injections = { config.injections, 'table' },
         latex = { config.latex, 'table' },
         overrides = { config.overrides, 'table' },
@@ -465,7 +469,7 @@ function M.validate()
                 enabled = { override.enabled, 'boolean', true },
                 max_file_size = { override.max_file_size, 'number', true },
                 debounce = { override.debounce, 'number', true },
-                render_modes = string_array(override.render_modes, true),
+                render_modes = string_array(override.render_modes, {}, true),
                 anti_conceal = { override.anti_conceal, 'table', true },
                 heading = { override.heading, 'table', true },
                 code = { override.code, 'table', true },

lua/render-markdown/types.lua

@@ -132,7 +132,7 @@
 ---@field public enabled boolean
 ---@field public max_file_size number
 ---@field public debounce integer
----@field public render_modes string[]
+---@field public render_modes string[]|boolean
 ---@field public anti_conceal render.md.AntiConceal
 ---@field public heading render.md.Heading
 ---@field public code render.md.Code

tests/state_spec.lua

@@ -70,22 +70,24 @@ describe('state', function()
         )
 
         eq(
-            { prefix .. '.log_level: expected one of { "debug", "error" } or type {}, got invalid' },
+            { prefix .. '.log_level: expected one of { "debug", "error" }, got invalid' },
             ---@diagnostic disable-next-line: assign-type-mismatch
             validate({ log_level = 'invalid' })
         )
 
         eq(
-            { prefix .. '.render_modes: expected string array, got true' },
+            { prefix .. '.render_modes: expected string array or type { "boolean" }, got invalid' },
             ---@diagnostic disable-next-line: assign-type-mismatch
-            validate({ render_modes = true })
+            validate({ render_modes = 'invalid' })
         )
 
-        ---@diagnostic disable-next-line: assign-type-mismatch
-        local errors = validate({ render_modes = { 1, 2 } })
-        eq(1, #errors)
-        eq(true, vim.startswith(errors[1], prefix .. '.render_modes: expected string array, got '))
-        eq(true, vim.endswith(errors[1], 'Info: Index 1 is number'))
+        local int_render_modes = { 1, 2 }
+        eq({
+            prefix
+                .. '.render_modes: expected string array or type { "boolean" }, got '
+                .. tostring(int_render_modes)
+                .. '. Info: Index 1 is number',
+        }, validate({ render_modes = int_render_modes }))
 
         eq(
             { prefix .. '.callout.new.highlight: expected string, got nil' },