chore: move configs into individual modules

## Details

Rather than storing all type definition in `init.lua` & having all the
validation in `state.lua` create individual modules for each of the top
level configuration in a config folder and put the validation for these
in these modules.

Change the configuration naming pattern:

- from: `render.md.<module>` / `render.md.User<module>`
- to: `render.md.<module>.Config` / `render.md.<module>.UserConfig`

Makes writing code to automate the creation of user types easier and
more consistent. Users shouldn't really be relying on these but if they
are then they'll need to make changes.

Author: MeanderingProgrammer

benches/util.lua

@@ -1,5 +1,8 @@
 ---@module 'luassert'
 
+local eq = assert.are.same
+local truthy = assert.truthy
+
 ---@class render.md.bench.Util
 local M = {}
 
@@ -49,14 +52,14 @@ end
 ---@param actual number
 ---@param max number
 function M.less_than(actual, max)
-    assert.truthy(actual < max, string.format('expected %f < %f', actual, max))
+    truthy(actual < max, string.format('expected %f < %f', actual, max))
 end
 
 ---@param expected integer
 function M.num_marks(expected)
     local ui = require('render-markdown.core.ui')
     local marks = vim.api.nvim_buf_get_extmarks(0, ui.ns, 0, -1, {})
-    assert.are.same(expected, #marks)
+    eq(expected, #marks)
 end
 
 return M

doc/custom-handlers.md

@@ -14,26 +14,26 @@ Each handler must conform to the following interface:
 ```lua
 ---@class (exact) render.md.Handler
 ---@field extends? boolean
----@field parse fun(ctx: render.md.HandlerContext): render.md.Mark[]
+---@field parse fun(ctx: render.md.handler.Context): render.md.Mark[]
 
----@class (exact) render.md.HandlerContext
+---@class (exact) render.md.handler.Context
 ---@field buf integer
 ---@field root TSNode
 
 ---@class (exact) render.md.Mark
 ---@field conceal boolean
 ---@field start_row integer
 ---@field start_col integer
----@field opts render.md.MarkOpts
+---@field opts render.md.mark.Opts
 
----@class render.md.MarkOpts: vim.api.keyset.set_extmark
----@field virt_text? render.md.MarkLine
+---@class render.md.mark.Opts: vim.api.keyset.set_extmark
+---@field virt_text? render.md.mark.Line
 ---@field virt_text_pos? 'eol'|'inline'|'overlay'
----@field virt_lines? render.md.MarkLine[]
+---@field virt_lines? render.md.mark.Line[]
 
----@alias render.md.MarkLine render.md.MarkText[]
+---@alias render.md.mark.Line render.md.mark.Text[]
 
----@class (exact) render.md.MarkText
+---@class (exact) render.md.mark.Text
 ---@field [1] string text
 ---@field [2] string|string[] highlights
 ```
@@ -90,7 +90,7 @@ local function parse_python(ctx)
     local marks = {}
     for id, node in query:iter_captures(ctx.root, ctx.buf) do
         local capture = query.captures[id]
-        local start_row, _, _, _ = node:range()
+        local start_row = node:range()
         if capture == 'def' then
             marks[#marks + 1] = {
                 conceal = true,

doc/render-markdown.txt

@@ -1,4 +1,4 @@
-*render-markdown.txt*           For 0.11.0          Last change: 2025 April 03
+*render-markdown.txt*           For 0.11.0          Last change: 2025 April 06
 
 ==============================================================================
 Table of Contents                          *render-markdown-table-of-contents*

lua/render-markdown/api.lua

@@ -50,7 +50,7 @@ function M.debug()
 end
 
 function M.config()
-    local difference = state.difference(require('render-markdown').default_config)
+    local difference = state.difference(require('render-markdown').default)
     if vim.tbl_count(difference) == 0 then
         vim.print('Default Configuration')
     else

lua/render-markdown/config.lua

@@ -1,18 +1,18 @@
 local Env = require('render-markdown.lib.env')
 local Range = require('render-markdown.core.range')
 
----@class render.md.component.Config
----@field callout table<string, render.md.CustomCallout>
----@field checkbox table<string, render.md.CustomCheckbox>
+---@class render.md.Components
+---@field callout table<string, render.md.callout.Config>
+---@field checkbox table<string, render.md.checkbox.custom.Config>
 
----@class render.md.buffer.Config: render.md.BufferConfig
+---@class render.md.BufferConfig: render.md.buffer.Config
 ---@field private modes render.md.Modes
----@field private component render.md.component.Config
+---@field private components render.md.Components
 local Config = {}
 Config.__index = Config
 
----@param config render.md.BufferConfig
----@return render.md.buffer.Config
+---@param config render.md.buffer.Config
+---@return render.md.BufferConfig
 function Config.new(config)
     -- Super set of render modes across top level and individual components
     local modes = config.render_modes
@@ -22,16 +22,42 @@ function Config.new(config)
         end
     end
 
-    ---@type render.md.component.Config
-    local component = {
+    ---@type render.md.Components
+    local components = {
         callout = Config.normalize(config.callout),
         checkbox = Config.normalize(config.checkbox.custom),
     }
 
-    local instance = vim.tbl_deep_extend('force', { modes = modes, component = component }, config)
+    local instance = vim.tbl_deep_extend('force', { modes = modes, components = components }, config)
     return setmetatable(instance, 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)
+end
+
 ---@private
 ---@param current render.md.Modes
 ---@param new? render.md.Modes
@@ -56,7 +82,7 @@ function Config.fold_modes(current, new)
 end
 
 ---@private
----@generic T: render.md.CustomCallout|render.md.CustomCheckbox
+---@generic T: render.md.callout.Config|render.md.checkbox.custom.Config
 ---@param components table<string, T>
 ---@return table<string, T>
 function Config.normalize(components)
@@ -74,15 +100,15 @@ function Config:render(mode)
 end
 
 ---@param node render.md.Node
----@return render.md.CustomCallout?
+---@return render.md.callout.Config?
 function Config:get_callout(node)
-    return self.component.callout[node.text:lower()]
+    return self.components.callout[node.text:lower()]
 end
 
 ---@param node render.md.Node
----@return render.md.CustomCheckbox?
+---@return render.md.checkbox.custom.Config?
 function Config:get_checkbox(node)
-    return self.component.checkbox[node.text:lower()]
+    return self.components.checkbox[node.text:lower()]
 end
 
 ---@param mode string

lua/render-markdown/config/anti_conceal.lua

@@ -0,0 +1,41 @@
+---@class (exact) render.md.anti.conceal.Config
+---@field enabled boolean
+---@field ignore render.md.conceal.Ignore
+---@field above integer
+---@field below integer
+
+---@alias render.md.conceal.Ignore table<render.md.Element, render.md.Modes>
+
+---@enum (key) render.md.Element
+local element = {
+    head_icon = 'head_icon',
+    head_background = 'head_background',
+    head_border = 'head_border',
+    code_language = 'code_language',
+    code_background = 'code_background',
+    code_border = 'code_border',
+    dash = 'dash',
+    bullet = 'bullet',
+    check_icon = 'check_icon',
+    check_scope = 'check_scope',
+    quote = 'quote',
+    table_border = 'table_border',
+    callout = 'callout',
+    link = 'link',
+    sign = 'sign',
+}
+
+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()
+end
+
+return M

lua/render-markdown/config/base.lua

@@ -0,0 +1,14 @@
+---@class (exact) render.md.base.Config
+---@field enabled boolean
+---@field render_modes render.md.Modes
+
+---@alias render.md.Modes boolean|string[]
+
+local M = {}
+
+---@param spec render.md.debug.ValidatorSpec
+function M.validate(spec)
+    spec:type('enabled', 'boolean'):list('render_modes', 'string', 'boolean')
+end
+
+return M

lua/render-markdown/config/bullet.lua

@@ -0,0 +1,38 @@
+---@class (exact) render.md.bullet.Config: render.md.base.Config
+---@field icons render.md.bullet.Text
+---@field ordered_icons render.md.bullet.Text
+---@field left_pad render.md.bullet.Int
+---@field right_pad render.md.bullet.Int
+---@field highlight render.md.bullet.Text
+---@field scope_highlight render.md.bullet.Text
+
+---@class (exact) render.md.bullet.Context
+---@field level integer
+---@field index integer
+---@field value string
+
+---@alias render.md.bullet.Text
+---| string
+---| string[]
+---| string[][]
+---| fun(ctx: render.md.bullet.Context): string?
+
+---@alias render.md.bullet.Int
+---| integer
+---| fun(ctx: render.md.bullet.Context): integer
+
+local M = {}
+
+---@param spec render.md.debug.ValidatorSpec
+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()
+end
+
+return M

lua/render-markdown/config/callout.lua

@@ -0,0 +1,23 @@
+---@class (exact) render.md.callout.Config
+---@field raw string
+---@field rendered string
+---@field highlight string
+---@field quote_icon? string
+---@field category? string
+
+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()
+end
+
+return M

lua/render-markdown/config/checkbox.lua

@@ -0,0 +1,39 @@
+---@class (exact) render.md.checkbox.Config: render.md.base.Config
+---@field right_pad integer
+---@field unchecked render.md.checkbox.component.Config
+---@field checked render.md.checkbox.component.Config
+---@field custom table<string, render.md.checkbox.custom.Config>
+
+---@class (exact) render.md.checkbox.component.Config
+---@field icon string
+---@field highlight string
+---@field scope_highlight? string
+
+---@class (exact) render.md.checkbox.custom.Config
+---@field raw string
+---@field rendered string
+---@field highlight string
+---@field scope_highlight? string
+
+local M = {}
+
+---@param spec render.md.debug.ValidatorSpec
+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()
+        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()
+end
+
+return M