chore(refactor): use class for main update logic

## Details

Rather than calling `run_update` inside of `ui` module, we now create
and run an instance of the new `Updater` class which is still fully
contained inside the `ui` module.

Gives us easy access to shared fields, rather then passing them between
all the methods as needed.

The only things staying at the top level of `ui` are the namespace and
clear methods, as those are shared between all instances / needed
outside the context of an instance of update.

Other changes:

- move `file_types` out of `state` module FINISH THIS!!!!!!!!
- `render.md.buffer.Config` -> `render.md.partial.Config`
- `render.md.buffer.UserConfig` -> `render.md.partial.UserConfig`
- `render.md.main.Config` -> `render.md.buf.Config`
- `render-markdown.lib.buffer` -> `render-markdown.lib.decorator`
- `render-markdown.lib.decorator` no longer contains logic to check for
  an empty buffer, this has been moved to a simple method in `env.buf`
- hidden range creation has been moved out of `config` module and into
  the new `ui` `Updater` class (only usage)
- `config` module has been split up to create an instance of a new
  `resolved` module, which contains the computed / normalized values
  needed at runtime. This inner instance is made public and implements
  some of the methods previously stored inside of `config`
- rename completion source methods `setup` -> `init` for consistency

Author: MeanderingProgrammer

doc/render-markdown.txt

@@ -1,4 +1,4 @@
-*render-markdown.txt*         For NVIM v0.11.1        Last change: 2025 May 22
+*render-markdown.txt*         For NVIM v0.11.1        Last change: 2025 May 23
 
 ==============================================================================
 Table of Contents                          *render-markdown-table-of-contents*

lua/render-markdown/config/overrides.lua

@@ -1,7 +1,7 @@
 ---@class (exact) render.md.overrides.Config
----@field buflisted table<boolean, render.md.buffer.UserConfig>
----@field buftype table<string, render.md.buffer.UserConfig>
----@field filetype table<string, render.md.buffer.UserConfig>
+---@field buflisted table<boolean, render.md.partial.UserConfig>
+---@field buftype table<string, render.md.partial.UserConfig>
+---@field filetype table<string, render.md.partial.UserConfig>
 
 ---@class render.md.overrides.Cfg
 local M = {}

lua/render-markdown/core/manager.lua

@@ -4,6 +4,7 @@ local state = require('render-markdown.state')
 local ui = require('render-markdown.core.ui')
 
 ---@class render.md.manager.Config
+---@field file_types string[]
 ---@field ignore fun(buf: integer): boolean
 ---@field change_events string[]
 ---@field on render.md.on.Config
@@ -103,13 +104,13 @@ function M.attach(buf)
     M.config.on.attach({ buf = buf })
     require('render-markdown.core.ts').init()
     if M.config.completions.lsp.enabled then
-        require('render-markdown.integ.lsp').setup()
+        require('render-markdown.integ.lsp').init()
     elseif M.config.completions.blink.enabled then
-        require('render-markdown.integ.blink').setup()
+        require('render-markdown.integ.blink').init()
     elseif M.config.completions.coq.enabled then
-        require('render-markdown.integ.coq').setup()
+        require('render-markdown.integ.coq').init()
     else
-        require('render-markdown.integ.cmp').setup()
+        require('render-markdown.integ.cmp').init()
     end
 
     local events = {
@@ -122,7 +123,7 @@ function M.attach(buf)
     }
     local change_events = { 'DiffUpdated', 'ModeChanged', 'TextChanged' }
     vim.list_extend(change_events, M.config.change_events)
-    if config:render('i') then
+    if config.resolved:render('i') then
         vim.list_extend(events, { 'CursorHoldI', 'CursorMovedI' })
         vim.list_extend(change_events, { 'TextChangedI' })
     end
@@ -171,15 +172,17 @@ function M.should_attach(buf)
         return false
     end
 
-    local file_type, file_types = Env.buf.get(buf, 'filetype'), state.file_types
+    local file_type = Env.buf.get(buf, 'filetype')
+    local file_types = M.config.file_types
     if not vim.tbl_contains(file_types, file_type) then
         local reason = file_type .. ' /∈ ' .. vim.inspect(file_types)
         log.buf('info', 'attach', buf, 'skip', 'file type', reason)
         return false
     end
 
     local config = state.get(buf)
-    local file_size, max_file_size = Env.file_size_mb(buf), config.max_file_size
+    local file_size = Env.file_size_mb(buf)
+    local max_file_size = config.max_file_size
     if file_size > max_file_size then
         local reason = ('%f > %f'):format(file_size, max_file_size)
         log.buf('info', 'attach', buf, 'skip', 'file size', reason)

lua/render-markdown/core/ui.lua

@@ -1,9 +1,10 @@
-local Buffer = require('render-markdown.lib.buffer')
 local Compat = require('render-markdown.lib.compat')
 local Context = require('render-markdown.request.context')
+local Decorator = require('render-markdown.lib.decorator')
 local Env = require('render-markdown.lib.env')
 local Extmark = require('render-markdown.lib.extmark')
 local Iter = require('render-markdown.lib.iter')
+local Range = require('render-markdown.lib.range')
 local handlers = require('render-markdown.core.handlers')
 local log = require('render-markdown.core.log')
 local state = require('render-markdown.state')
@@ -18,26 +19,26 @@ local M = {}
 M.ns = vim.api.nvim_create_namespace('render-markdown.nvim')
 
 ---@private
----@type table<integer, render.md.Buffer>
+---@type table<integer, render.md.Decorator>
 M.cache = {}
 
 ---called from state on setup
 ---@param config render.md.ui.Config
 function M.setup(config)
     M.config = config
     -- reset cache
-    for buf, buffer in pairs(M.cache) do
-        M.clear_buffer(buf, buffer)
+    for buf, decorator in pairs(M.cache) do
+        M.clear(buf, decorator)
     end
     M.cache = {}
 end
 
 ---@param buf integer
----@return render.md.Buffer
+---@return render.md.Decorator
 function M.get(buf)
     local result = M.cache[buf]
     if not result then
-        result = Buffer.new(buf)
+        result = Decorator.new()
         M.cache[buf] = result
     end
     return result
@@ -50,114 +51,148 @@ end
 ---@param change boolean
 function M.update(buf, win, event, change)
     log.buf('info', 'update', buf, event, ('change %s'):format(change))
-    if not Env.valid(buf, win) then
-        return
-    end
-
-    local parse = M.parse(buf, win, change)
-    local config = state.get(buf)
-    local buffer = M.get(buf)
-    if buffer:is_empty() then
-        return
-    end
-
-    local update = log.runtime('update', function()
-        M.run_update(buf, win, change)
-    end)
-    buffer:run(parse, config.debounce, update)
+    M.updater.new(buf, win, change):start()
 end
 
 ---@private
+---@param buf integer
+---@param decorator render.md.Decorator
+function M.clear(buf, decorator)
+    vim.api.nvim_buf_clear_namespace(buf, M.ns, 0, -1)
+    decorator:clear()
+end
+
+---@class render.md.ui.Updater
+---@field private buf integer
+---@field private win integer
+---@field private change boolean
+---@field private decorator render.md.Decorator
+---@field private config render.md.buf.Config
+---@field private mode string
+local Updater = {}
+Updater.__index = Updater
+
 ---@param buf integer
 ---@param win integer
 ---@param change boolean
-function M.run_update(buf, win, change)
-    if not Env.valid(buf, win) then
+---@return render.md.ui.Updater
+function Updater.new(buf, win, change)
+    local self = setmetatable({}, Updater)
+    self.buf = buf
+    self.win = win
+    self.change = change
+    self.decorator = M.get(buf)
+    self.config = state.get(buf)
+    return self
+end
+
+function Updater:start()
+    if not Env.valid(self.buf, self.win) then
         return
     end
+    if Env.buf.empty(self.buf) then
+        return
+    end
+    self.decorator:schedule(
+        self:should_parse(),
+        self.config.debounce,
+        log.runtime('update', function()
+            self:run()
+        end)
+    )
+end
 
-    local parse = M.parse(buf, win, change)
-    local config = state.get(buf)
-    local buffer = M.get(buf)
-    local mode = Env.mode.get()
-    local row = Env.row.get(buf, win)
-
-    local render = config.enabled
-        and config:render(mode)
-        and not Env.win.get(win, 'diff')
-        and Env.win.view(win).leftcol == 0
+---@private
+---@return boolean
+function Updater:should_parse()
+    -- need to parse on changes or when we have not parsed the visible range yet
+    return self.change or not Context.contains(self.buf, self.win)
+end
 
-    log.buf('info', 'render', buf, render)
+---@private
+function Updater:run()
+    if not Env.valid(self.buf, self.win) then
+        return
+    end
+    self.mode = Env.mode.get() -- mode is only available after this point
+    local render = self.config.enabled
+        and self.config.resolved:render(self.mode)
+        and not Env.win.get(self.win, 'diff')
+        and Env.win.view(self.win).leftcol == 0
+    log.buf('info', 'render', self.buf, render)
     local next_state = render and 'rendered' or 'default'
-    for _, window in ipairs(Env.buf.windows(buf)) do
-        for name, value in pairs(config.win_options) do
+    for _, window in ipairs(Env.buf.windows(self.buf)) do
+        for name, value in pairs(self.config.win_options) do
             Env.win.set(window, name, value[next_state])
         end
     end
-
     if render then
-        local initial = buffer:initial()
-        if initial or parse then
-            M.clear_buffer(buf, buffer)
-            local extmarks = M.parse_buffer(buf, win, config, mode)
-            buffer:set_marks(extmarks)
-            if initial then
-                Compat.fix_lsp_window(buf, win, extmarks)
-                M.config.on.initial({ buf = buf, win = win })
-            end
-        end
-        local range = config:hidden(mode, row)
-        local extmarks = buffer:get_marks()
-        for _, extmark in ipairs(extmarks) do
-            if extmark:get().conceal and extmark:overlaps(range) then
-                extmark:hide(M.ns, buf)
-            else
-                extmark:show(M.ns, buf)
-            end
-        end
-        M.config.on.render({ buf = buf, win = win })
+        self:render()
+        M.config.on.render({ buf = self.buf, win = self.win })
     else
-        M.clear_buffer(buf, buffer)
-        M.config.on.clear({ buf = buf, win = win })
+        M.clear(self.buf, self.decorator)
+        M.config.on.clear({ buf = self.buf, win = self.win })
     end
 end
 
 ---@private
----@param buf integer
----@param win integer
----@param change boolean
----@return boolean
-function M.parse(buf, win, change)
-    -- need to parse when things change or we have not parsed the visible range yet
-    return change or not Context.contains(buf, win)
-end
-
----@private
----@param buf integer
----@param buffer render.md.Buffer
-function M.clear_buffer(buf, buffer)
-    vim.api.nvim_buf_clear_namespace(buf, M.ns, 0, -1)
-    buffer:set_marks(nil)
+function Updater:render()
+    local initial = self.decorator:initial()
+    if initial or self:should_parse() then
+        M.clear(self.buf, self.decorator)
+        local extmarks = self:get_extmarks()
+        self.decorator:set(extmarks)
+        if initial then
+            Compat.fix_lsp_window(self.buf, self.win, extmarks)
+            M.config.on.initial({ buf = self.buf, win = self.win })
+        end
+    end
+    local range = self:hidden()
+    local extmarks = self.decorator:get()
+    for _, extmark in ipairs(extmarks) do
+        if extmark:get().conceal and extmark:overlaps(range) then
+            extmark:hide(M.ns, self.buf)
+        else
+            extmark:show(M.ns, self.buf)
+        end
+    end
 end
 
 ---@private
----@param buf integer
----@param win integer
----@param config render.md.main.Config
----@param mode string
 ---@return render.md.Extmark[]
-function M.parse_buffer(buf, win, config, mode)
-    local has_parser, parser = pcall(vim.treesitter.get_parser, buf)
+function Updater:get_extmarks()
+    local has_parser, parser = pcall(vim.treesitter.get_parser, self.buf)
     if not has_parser or not parser then
-        log.buf('error', 'fail', buf, 'no treesitter parser found')
+        log.buf('error', 'fail', self.buf, 'no treesitter parser found')
         return {}
     end
     -- reset buffer context
-    local context = Context.start(buf, win, config, mode)
+    local context = Context.new(self.buf, self.win, self.config, self.mode)
     -- make sure injections are processed
     context.view:parse(parser)
     local marks = handlers.run(context, parser)
     return Iter.list.map(marks, Extmark.new)
 end
 
+---@private
+---@return render.md.Range?
+function Updater:hidden()
+    -- anti-conceal is not enabled -> hide nothing
+    -- row is not known -> buffer is not active -> hide nothing
+    local config = self.config.anti_conceal
+    local row = Env.row.get(self.buf, self.win)
+    if not config.enabled or not row then
+        return nil
+    end
+    if Env.mode.is(self.mode, { 'v', 'V', '\22' }) then
+        local start = vim.fn.getpos('v')[2] - 1
+        return Range.new(math.min(row, start), math.max(row, start))
+    else
+        return Range.new(row - config.above, row + config.below)
+    end
+end
+
+---@private
+M.updater = Updater
+
 return M

lua/render-markdown/debug/marks.lua

@@ -158,7 +158,7 @@ function M.show()
     local range = Range.new(row, row)
 
     local marks = {} ---@type render.md.debug.Mark[]
-    for _, extmark in ipairs(ui.get(buf):get_marks()) do
+    for _, extmark in ipairs(ui.get(buf):get()) do
         if extmark:overlaps(range) then
             marks[#marks + 1] = Mark.new(extmark:get())
         end

lua/render-markdown/health.lua

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

lua/render-markdown/init.lua

@@ -1,7 +1,7 @@
 ---@class render.md.Init: render.md.Api
 local M = {}
 
----@class (exact) render.md.Config: render.md.buffer.Config
+---@class (exact) render.md.Config: render.md.partial.Config
 ---@field preset render.md.config.Preset
 ---@field log_level render.md.log.Level
 ---@field log_runtime boolean
@@ -15,7 +15,7 @@ local M = {}
 ---@field overrides render.md.overrides.Config
 ---@field custom_handlers table<string, render.md.Handler>
 
----@class (exact) render.md.buffer.Config: render.md.base.Config
+---@class (exact) render.md.partial.Config: render.md.base.Config
 ---@field max_file_size number
 ---@field debounce integer
 ---@field anti_conceal render.md.anti.conceal.Config