chore(refactor): store config inside context

## Details

Stores the main configuration inside of the context since the 2 are
largely used together anyway, offers more flexibility, hopefully fewer
hacks whenever we need information from one in the other.

Reduces the number of places we need access to `state` module. Pass
`context` to `marks` directly instead of getting via a buffer.

Author: MeanderingProgrammer

lua/render-markdown/config.lua

@@ -1,38 +1,35 @@
 local Env = require('render-markdown.lib.env')
 local Range = require('render-markdown.core.range')
 
----@class render.md.main.Components
+---@class render.md.main.Full
+---@field modes render.md.Modes
 ---@field callout table<string, render.md.callout.Config>
 ---@field checkbox table<string, render.md.checkbox.custom.Config>
 
 ---@class render.md.main.Config: render.md.buffer.Config
----@field private modes render.md.Modes
----@field private components render.md.main.Components
+---@field private full render.md.main.Full
 local Config = {}
 Config.__index = Config
 
 ---@param config render.md.buffer.Config
 ---@return render.md.main.Config
 function Config.new(config)
-    -- Super set of render modes across top level and individual components
+    -- super set of render modes across top level and individual components
     local modes = config.render_modes
     for _, component in pairs(config) do
         if type(component) == 'table' then
-            modes = Config.fold_modes(modes, component['render_modes'])
+            modes = Config.fold(modes, component['render_modes'])
         end
     end
 
-    ---@type render.md.main.Components
-    local components = {
+    ---@type render.md.main.Full
+    local full = {
+        modes = modes,
         callout = Config.normalize(config.callout),
         checkbox = Config.normalize(config.checkbox.custom),
     }
 
-    local instance = vim.tbl_deep_extend(
-        'force',
-        { modes = modes, components = components },
-        config
-    )
+    local instance = vim.tbl_deep_extend('force', { full = full }, config)
     return setmetatable(instance, Config)
 end
 
@@ -63,25 +60,25 @@ function Config.validate(spec)
 end
 
 ---@private
----@param current render.md.Modes
+---@param acc render.md.Modes
 ---@param new? render.md.Modes
 ---@return render.md.Modes
-function Config.fold_modes(current, new)
-    if type(current) == 'boolean' and type(new) == 'boolean' then
-        return current or new
-    elseif type(current) == 'boolean' and type(new) == 'table' then
-        return current or new
-    elseif type(current) == 'table' and type(new) == 'boolean' then
-        return new or current
-    elseif type(current) == 'table' and type(new) == 'table' then
-        -- Copy to avoid modifying inputs
+function Config.fold(acc, new)
+    if type(acc) == 'boolean' and type(new) == 'boolean' then
+        return acc or new
+    elseif type(acc) == 'boolean' and type(new) == 'table' then
+        return acc or new
+    elseif type(acc) == 'table' and type(new) == 'boolean' then
+        return new or acc
+    elseif type(acc) == 'table' and type(new) == 'table' then
+        -- copy to avoid modifying inputs
         local result = {}
-        vim.list_extend(result, current)
+        vim.list_extend(result, acc)
         vim.list_extend(result, new)
         return result
     else
-        -- Should only occur if new is nil, keep current value
-        return current
+        -- should only occur if new is nil, keep current value
+        return acc
     end
 end
 
@@ -100,19 +97,19 @@ end
 ---@param mode string
 ---@return boolean
 function Config:render(mode)
-    return Env.mode.is(mode, self.modes)
+    return Env.mode.is(mode, self.full.modes)
 end
 
 ---@param node render.md.Node
 ---@return render.md.callout.Config?
 function Config:get_callout(node)
-    return self.components.callout[node.text:lower()]
+    return self.full.callout[node.text:lower()]
 end
 
 ---@param node render.md.Node
 ---@return render.md.checkbox.custom.Config?
 function Config:get_checkbox(node)
-    return self.components.checkbox[node.text:lower()]
+    return self.full.checkbox[node.text:lower()]
 end
 
 ---@param mode string

lua/render-markdown/core/context.lua

@@ -8,22 +8,18 @@ local log = require('render-markdown.core.log')
 ---@class render.md.context.Props
 ---@field buf integer
 ---@field win integer
+---@field config render.md.main.Config
 ---@field mode string
----@field top_level_mode boolean
 
 ---@class render.md.context.Offset
 ---@field col integer
 ---@field width integer
 
----@class render.md.Context
+---@class render.md.Context: render.md.context.Props
 ---@field private ranges render.md.Range[]
 ---@field private callouts table<integer, render.md.callout.Config>
 ---@field private checkboxes table<integer, render.md.checkbox.custom.Config>
 ---@field private offsets table<integer, render.md.context.Offset[]>
----@field buf integer
----@field win integer
----@field mode string
----@field top_level_mode boolean
 ---@field conceal render.md.Conceal
 ---@field last_heading? integer
 local Context = {}
@@ -47,8 +43,9 @@ function Context.new(props, offset)
 
     self.buf = props.buf
     self.win = props.win
+    self.config = props.config
     self.mode = props.mode
-    self.top_level_mode = props.top_level_mode
+
     self.conceal = Conceal.new(self)
     self.last_heading = nil
 
@@ -63,7 +60,7 @@ function Context:skip(config)
         return true
     end
     -- Enabled config in top level modes should not be skipped
-    if self.top_level_mode then
+    if Env.mode.is(self.mode, self.config.render_modes) then
         return false
     end
     -- Enabled config in config modes should not be skipped

lua/render-markdown/core/ui.lua

@@ -151,14 +151,14 @@ function M.run_update(buf, win, change)
             buffer:set_marks(M.parse_buffer({
                 buf = buf,
                 win = win,
+                config = config,
                 mode = mode,
-                top_level_mode = Env.mode.is(mode, config.render_modes),
             }))
         end
         local hidden = config:hidden(mode, row)
         local extmarks = buffer:get_marks()
         if initial then
-            Compat.lsp_window_height(buf, win, extmarks)
+            Compat.fix_lsp_window(buf, win, extmarks)
             state.on.initial({ buf = buf, win = win })
         end
         for _, extmark in ipairs(extmarks) do
@@ -181,22 +181,12 @@ end
 ---@param mode string
 ---@return 'default'|'rendered'
 function M.next_state(config, win, mode)
-    if not state.enabled then
-        return 'default'
-    end
-    if not config.enabled then
-        return 'default'
-    end
-    if not config:render(mode) then
-        return 'default'
-    end
-    if Env.win.get(win, 'diff') then
-        return 'default'
-    end
-    if Env.win.view(win).leftcol ~= 0 then
-        return 'default'
-    end
-    return 'rendered'
+    local render = state.enabled
+        and config.enabled
+        and config:render(mode)
+        and not Env.win.get(win, 'diff')
+        and Env.win.view(win).leftcol == 0
+    return render and 'rendered' or 'default'
 end
 
 ---@private

lua/render-markdown/handler/html.lua

@@ -1,24 +1,18 @@
 local Context = require('render-markdown.core.context')
 local Marks = require('render-markdown.lib.marks')
-local state = require('render-markdown.state')
 local ts = require('render-markdown.integ.ts')
 
 ---@class render.md.handler.buf.Html
----@field private config render.md.main.Config
----@field private context render.md.Context
----@field private marks render.md.Marks
 ---@field private query vim.treesitter.Query
 ---@field private renderers table<string, render.md.Render>
+---@field private context render.md.Context
 local Handler = {}
 Handler.__index = Handler
 
 ---@param buf integer
 ---@return render.md.handler.buf.Html
 function Handler.new(buf)
     local self = setmetatable({}, Handler)
-    self.config = state.get(buf)
-    self.context = Context.get(buf)
-    self.marks = Marks.new(buf, true)
     self.query = ts.parse(
         'html',
         [[
@@ -30,24 +24,26 @@ function Handler.new(buf)
         comment = require('render-markdown.render.html_comment'),
         tag = require('render-markdown.render.html_tag'),
     }
+    self.context = Context.get(buf)
     return self
 end
 
 ---@param root TSNode
 ---@return render.md.Mark[]
 function Handler:parse(root)
-    if self.context:skip(self.config.html) then
+    if self.context:skip(self.context.config.html) then
         return {}
     end
+    local marks = Marks.new(self.context, true)
     self.context:query(root, self.query, function(capture, node)
         local renderer = self.renderers[capture]
         assert(renderer ~= nil, 'Unhandled html capture: ' .. capture)
-        local render = renderer:new(self.marks, self.config, self.context, node)
+        local render = renderer:new(self.context, marks, node)
         if render:setup() then
             render:render()
         end
     end)
-    return self.marks:get()
+    return marks:get()
 end
 
 ---@class render.md.handler.Html: render.md.Handler

lua/render-markdown/handler/latex.lua

@@ -4,7 +4,6 @@ local Marks = require('render-markdown.lib.marks')
 local Node = require('render-markdown.lib.node')
 local Str = require('render-markdown.lib.str')
 local log = require('render-markdown.core.log')
-local state = require('render-markdown.state')
 
 ---@class render.md.latex.Cache: { [string]: string }
 local Cache = {}
@@ -15,8 +14,9 @@ local M = {}
 ---@param ctx render.md.handler.Context
 ---@return render.md.Mark[]
 function M.parse(ctx)
-    local latex = state.get(ctx.buf).latex
-    if Context.get(ctx.buf):skip(latex) then
+    local context = Context.get(ctx.buf)
+    local latex = context.config.latex
+    if context:skip(latex) then
         return {}
     end
     if vim.fn.executable(latex.converter) ~= 1 then
@@ -55,7 +55,7 @@ function M.parse(ctx)
     local above = latex.position == 'above'
     local row = above and node.start_row or node.end_row
 
-    local marks = Marks.new(ctx.buf, true)
+    local marks = Marks.new(context, true)
     marks:add(false, row, 0, {
         virt_lines = lines,
         virt_lines_above = above,

lua/render-markdown/handler/markdown.lua

@@ -1,24 +1,18 @@
 local Context = require('render-markdown.core.context')
 local Marks = require('render-markdown.lib.marks')
-local state = require('render-markdown.state')
 local ts = require('render-markdown.integ.ts')
 
 ---@class render.md.handler.buf.Markdown
----@field private config render.md.main.Config
----@field private context render.md.Context
----@field private marks render.md.Marks
 ---@field private query vim.treesitter.Query
 ---@field private renderers table<string, render.md.Render>
+---@field private context render.md.Context
 local Handler = {}
 Handler.__index = Handler
 
 ---@param buf integer
 ---@return render.md.handler.buf.Markdown
 function Handler.new(buf)
     local self = setmetatable({}, Handler)
-    self.config = state.get(buf)
-    self.context = Context.get(buf)
-    self.marks = Marks.new(buf, false)
     self.query = ts.parse(
         'markdown',
         [[
@@ -65,21 +59,23 @@ function Handler.new(buf)
         section = require('render-markdown.render.section'),
         table = require('render-markdown.render.table'),
     }
+    self.context = Context.get(buf)
     return self
 end
 
 ---@param root TSNode
 ---@return render.md.Mark[]
 function Handler:parse(root)
+    local marks = Marks.new(self.context, false)
     self.context:query(root, self.query, function(capture, node)
         local renderer = self.renderers[capture]
         assert(renderer ~= nil, 'Unhandled markdown capture: ' .. capture)
-        local render = renderer:new(self.marks, self.config, self.context, node)
+        local render = renderer:new(self.context, marks, node)
         if render:setup() then
             render:render()
         end
     end)
-    return self.marks:get()
+    return marks:get()
 end
 
 ---@class render.md.handler.Markdown: render.md.Handler

lua/render-markdown/handler/markdown_inline.lua

@@ -1,24 +1,18 @@
 local Context = require('render-markdown.core.context')
 local Marks = require('render-markdown.lib.marks')
-local state = require('render-markdown.state')
 local ts = require('render-markdown.integ.ts')
 
 ---@class render.md.handler.buf.MarkdownInline
----@field private config render.md.main.Config
----@field private context render.md.Context
----@field private marks render.md.Marks
 ---@field private query vim.treesitter.Query
 ---@field private renderers table<string, render.md.Render>
+---@field private context render.md.Context
 local Handler = {}
 Handler.__index = Handler
 
 ---@param buf integer
 ---@return render.md.handler.buf.MarkdownInline
 function Handler.new(buf)
     local self = setmetatable({}, Handler)
-    self.config = state.get(buf)
-    self.context = Context.get(buf)
-    self.marks = Marks.new(buf, true)
     self.query = ts.parse(
         'markdown_inline',
         [[
@@ -44,21 +38,23 @@ function Handler.new(buf)
         link = require('render-markdown.render.link'),
         shortcut = require('render-markdown.render.shortcut'),
     }
+    self.context = Context.get(buf)
     return self
 end
 
 ---@param root TSNode
 ---@return render.md.Mark[]
 function Handler:parse(root)
+    local marks = Marks.new(self.context, true)
     self.context:query(root, self.query, function(capture, node)
         local renderer = self.renderers[capture]
         assert(renderer ~= nil, 'Unhandled inline capture: ' .. capture)
-        local render = renderer:new(self.marks, self.config, self.context, node)
+        local render = renderer:new(self.context, marks, node)
         if render:setup() then
             render:render()
         end
     end)
-    return self.marks:get()
+    return marks:get()
 end
 
 ---@class render.md.handler.MarkdownInline: render.md.Handler

lua/render-markdown/health.lua

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