chore(refactor): add config module for custom handlers, reduce global state

## Details

Add `custom_handlers` module under config directory for validation and
setting default value.

Moves `on`, `completions`, `ignore`, and `change_events` out of the
global state module. Leaves only `enabled` & `file_types` available
globally, I think those will have to stick around.

Author: MeanderingProgrammer

README.md

@@ -850,9 +850,10 @@ require('render-markdown').setup({
         -- Override for different filetype values, @see :h 'filetype'.
         filetype = {},
     },
-    -- Mapping from treesitter language to user defined handlers.
-    -- @see [Custom Handlers](doc/custom-handlers.md)
-    custom_handlers = {},
+    custom_handlers = {
+        -- Mapping from treesitter language to user defined handlers.
+        -- @see [Custom Handlers](doc/custom-handlers.md)
+    },
 })
 ```
 

doc/render-markdown.txt

@@ -915,9 +915,10 @@ Default Configuration ~
             -- Override for different filetype values, @see :h 'filetype'.
             filetype = {},
         },
-        -- Mapping from treesitter language to user defined handlers.
-        -- @see [Custom Handlers](doc/custom-handlers.md)
-        custom_handlers = {},
+        custom_handlers = {
+            -- Mapping from treesitter language to user defined handlers.
+            -- @see [Custom Handlers](doc/custom-handlers.md)
+        },
     })
 <
 

lua/render-markdown/config/custom_handlers.lua

@@ -0,0 +1,20 @@
+---@class render.md.custom.handlers
+local M = {}
+
+---@type table<string, render.md.Handler>
+M.default = {
+    -- Mapping from treesitter language to user defined handlers.
+    -- @see [Custom Handlers](doc/custom-handlers.md)
+}
+
+---@param spec render.md.debug.ValidatorSpec
+function M.validate(spec)
+    spec:each(function(handler)
+        handler:type('extends', { 'boolean', 'nil' })
+        handler:type('parse', 'function')
+        handler:check()
+    end)
+    spec:check()
+end
+
+return M

lua/render-markdown/core/ui.lua

@@ -41,6 +41,7 @@ function Cache.get(buf)
 end
 
 ---@class render.md.ui.Config
+---@field on render.md.callback.Config
 ---@field custom_handlers table<string, render.md.Handler>
 
 ---@class render.md.Ui
@@ -152,7 +153,7 @@ function M.run_update(buf, win, change)
         local extmarks = buffer:get_marks()
         if initial then
             Compat.fix_lsp_window(buf, win, extmarks)
-            state.on.initial({ buf = buf, win = win })
+            M.config.on.initial({ buf = buf, win = win })
         end
         for _, extmark in ipairs(extmarks) do
             if extmark:get().conceal and extmark:overlaps(hidden) then
@@ -161,10 +162,10 @@ function M.run_update(buf, win, change)
                 extmark:show(M.ns, buf)
             end
         end
-        state.on.render({ buf = buf, win = win })
+        M.config.on.render({ buf = buf, win = win })
     else
         M.clear(buf, buffer)
-        state.on.clear({ buf = buf, win = win })
+        M.config.on.clear({ buf = buf, win = win })
     end
 end
 

lua/render-markdown/health.lua

@@ -5,7 +5,7 @@ local state = require('render-markdown.state')
 local M = {}
 
 ---@private
-M.version = '8.3.15'
+M.version = '8.3.16'
 
 function M.check()
     M.start('version')

lua/render-markdown/init.lua

@@ -100,9 +100,7 @@ M.default = {
     html = require('render-markdown.config.html').default,
     win_options = require('render-markdown.config.win_options').default,
     overrides = require('render-markdown.config.overrides').default,
-    -- Mapping from treesitter language to user defined handlers.
-    -- @see [Custom Handlers](doc/custom-handlers.md)
-    custom_handlers = {},
+    custom_handlers = require('render-markdown.config.custom_handlers').default,
 }
 
 ---@param opts? render.md.UserConfig

lua/render-markdown/integ/blink.lua

@@ -1,7 +1,6 @@
 ---@module 'blink.cmp'
 
 local source = require('render-markdown.integ.source')
-local state = require('render-markdown.state')
 
 ---@class render.md.blink.Source: blink.cmp.Source
 local Source = {}
@@ -61,6 +60,7 @@ function Source.setup()
         name = 'RenderMarkdown',
         module = 'render-markdown.integ.blink',
     })
+    local state = require('render-markdown.state')
     for _, file_type in ipairs(state.file_types) do
         pcall(blink.add_filetype_source, file_type, id)
     end

lua/render-markdown/integ/source.lua

@@ -10,9 +10,19 @@ local markers = {
     block_quote_marker = '>',
 }
 
+---@class render.md.source.Config
+---@field completions render.md.completions.Config
+
 ---@class render.md.Source
+---@field private config render.md.source.Config
 local M = {}
 
+---called from state on setup
+---@param config render.md.source.Config
+function M.setup(config)
+    M.config = config
+end
+
 ---@return boolean
 function M.enabled()
     return manager.attached(Env.buf.current())
@@ -47,7 +57,7 @@ function M.items(buf, row, col)
 
     local items = {}
     local config = state.get(buf)
-    local filter = state.completions.filter
+    local filter = M.config.completions.filter
     local prefix = Str.spaces('end', marker) == 0 and ' ' or ''
     if node:type() == 'block_quote' then
         for _, value in pairs(config.callout) do

lua/render-markdown/manager.lua

@@ -6,12 +6,25 @@ local ui = require('render-markdown.core.ui')
 ---@type integer[]
 local buffers = {}
 
+---@class render.md.manager.Config
+---@field ignore fun(buf: integer): boolean
+---@field change_events string[]
+---@field on render.md.callback.Config
+---@field completions render.md.completions.Config
+
 ---@class render.md.Manager
+---@field private config render.md.manager.Config
 local M = {}
 
 ---@private
 M.group = vim.api.nvim_create_augroup('RenderMarkdown', {})
 
+---called from state on setup
+---@param config render.md.manager.Config
+function M.setup(config)
+    M.config = config
+end
+
 ---called from plugin directory
 function M.init()
     -- lazy loading: ignores current buffer as FileType event already executed
@@ -86,13 +99,13 @@ function M.attach(buf)
     end
 
     local config = state.get(buf)
-    state.on.attach({ buf = buf })
+    M.config.on.attach({ buf = buf })
     require('render-markdown.integ.ts').init()
-    if state.completions.lsp.enabled then
+    if M.config.completions.lsp.enabled then
         require('render-markdown.integ.lsp').setup()
-    elseif state.completions.blink.enabled then
+    elseif M.config.completions.blink.enabled then
         require('render-markdown.integ.blink').setup()
-    elseif state.completions.coq.enabled then
+    elseif M.config.completions.coq.enabled then
         require('render-markdown.integ.coq').setup()
     else
         require('render-markdown.integ.cmp').setup()
@@ -107,7 +120,7 @@ function M.attach(buf)
         'WinScrolled',
     }
     local change_events = { 'DiffUpdated', 'ModeChanged', 'TextChanged' }
-    vim.list_extend(change_events, state.change_events)
+    vim.list_extend(change_events, M.config.change_events)
     if config:render('i') then
         vim.list_extend(events, { 'CursorHoldI', 'CursorMovedI' })
         vim.list_extend(change_events, { 'TextChangedI' })
@@ -175,7 +188,7 @@ function M.should_attach(buf)
         return false
     end
 
-    if state.ignore(buf) then
+    if M.config.ignore(buf) then
         log.buf('info', 'attach', buf, 'skip', 'user ignore')
         return false
     end

lua/render-markdown/state.lua

@@ -8,10 +8,6 @@ local Cache = {}
 ---@field private config render.md.Config
 ---@field enabled boolean
 ---@field file_types string[]
----@field ignore fun(buf: integer): boolean
----@field change_events string[]
----@field on render.md.callback.Config
----@field completions render.md.completions.Config
 local M = {}
 
 ---called from init on setup
@@ -20,17 +16,23 @@ function M.setup(config)
     M.config = config
     M.enabled = config.enabled
     M.file_types = config.file_types
-    M.ignore = config.ignore
-    M.change_events = config.change_events
-    M.on = config.on
-    M.completions = config.completions
+    require('render-markdown.manager').setup({
+        ignore = config.ignore,
+        change_events = config.change_events,
+        on = config.on,
+        completions = config.completions,
+    })
     require('render-markdown.core.log').setup({
         level = config.log_level,
         runtime = config.log_runtime,
     })
     require('render-markdown.core.ui').setup({
+        on = config.on,
         custom_handlers = config.custom_handlers,
     })
+    require('render-markdown.integ.source').setup({
+        completions = config.completions,
+    })
     require('render-markdown.integ.ts').setup({
         file_types = config.file_types,
         injections = config.injections,
@@ -132,14 +134,7 @@ function M.validate()
     spec:nested('on', require('render-markdown.config.on').validate)
     spec:nested('completions', require('render-markdown.config.completions').validate)
     spec:nested('overrides', require('render-markdown.config.overrides').validate)
-    spec:nested('custom_handlers', function(handlers)
-        handlers:each(function(handler)
-            handler:type('extends', { 'boolean', 'nil' })
-            handler:type('parse', 'function')
-            handler:check()
-        end)
-        handlers:check()
-    end)
+    spec:nested('custom_handlers', require('render-markdown.config.custom_handlers').validate)
     spec:check()
     return validator:get_errors()
 end