chore(refactor): move component tables out of context

## Details

Rather than storing the callouts, checkboxes, & offsets tables directly
in Context, take a similar approach as Conceal and move these into their
own modules and store an instance of each in Context.

Makes them easier to change in isolation without adding more overhead to
the Context. Store the node associated with checkboxes & callouts,
currently unused but will be in a follow up.

Other changes:

- make base `render` parent call `setup` on each instance as part of the
  call to `new`, return `nil` if false, handle `nil` where these are
  used, make `setup` protected, rename main `render` method to `run`
- add more general `query` method to `View` module, allows us to avoid
  exposing any state directly by removing `for_each`
- move `percent` calculation out of `Context` and into `Env`, since it
  only depends on the window, remove `width` method
- update `Conceal` node range logic to return 4 ints instead of a table
- fix overload return types for `Env.buf.get`
- `renderers` -> `modules`, `renderer` -> `module`
- rename list_item capture `bullet` -> `list`
- update CHANGELOG

Author: MeanderingProgrammer

CHANGELOG.md

@@ -18,6 +18,8 @@
 - use conceal lines for setext heading underline [78ffe3b](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/78ffe3b0500bbc7e37fabde723d96661538e8b32)
 - improve debug command [40fff90](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/40fff90caccb4a1c902681f0440806ee9ae95d0b)
 - use selene to prevent accidental print statements [7f81e9d](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/7f81e9dcc15504c044f20df39d28a590cd5c6ca5)
+- configurable indent for first line of paragraph [#417](https://github.com/MeanderingProgrammer/render-markdown.nvim/issues/417)
+  [57c7f33](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/57c7f33f276876c994898683680da9e3a3590d0d)
 
 ### Bug Fixes
 

doc/render-markdown.txt

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

lua/render-markdown/handler/html.lua

@@ -4,7 +4,7 @@ local ts = require('render-markdown.core.ts')
 
 ---@class render.md.handler.buf.Html
 ---@field private query vim.treesitter.Query
----@field private renderers table<string, render.md.Render>
+---@field private modules table<string, render.md.Render>
 ---@field private context render.md.request.Context
 local Handler = {}
 Handler.__index = Handler
@@ -20,7 +20,7 @@ function Handler.new(buf)
             (element) @tag
         ]]
     )
-    self.renderers = {
+    self.modules = {
         comment = require('render-markdown.render.html_comment'),
         tag = require('render-markdown.render.html_tag'),
     }
@@ -35,12 +35,12 @@ function Handler:parse(root)
         return {}
     end
     local marks = Marks.new(self.context, true)
-    self.context.view:query(root, self.query, function(capture, node)
-        local renderer = self.renderers[capture]
-        assert(renderer ~= nil, 'unhandled html capture: ' .. capture)
-        local render = renderer:new(self.context, marks, node)
-        if render:setup() then
-            render:render()
+    self.context.view:nodes(root, self.query, function(capture, node)
+        local module = self.modules[capture]
+        assert(module ~= nil, 'unhandled html capture: ' .. capture)
+        local render = module:new(self.context, marks, node)
+        if render then
+            render:run()
         end
     end)
     return marks:get()

lua/render-markdown/handler/markdown.lua

@@ -4,7 +4,7 @@ local ts = require('render-markdown.core.ts')
 
 ---@class render.md.handler.buf.Markdown
 ---@field private query vim.treesitter.Query
----@field private renderers table<string, render.md.Render>
+---@field private modules table<string, render.md.Render>
 ---@field private context render.md.request.Context
 local Handler = {}
 Handler.__index = Handler
@@ -35,7 +35,7 @@ function Handler.new(buf)
                 (plus_metadata)
             ] @dash
 
-            (list_item) @bullet
+            (list_item) @list
 
             [
                 (task_list_marker_unchecked)
@@ -47,13 +47,13 @@ function Handler.new(buf)
             (pipe_table) @table
         ]]
     )
-    self.renderers = {
-        bullet = require('render-markdown.render.bullet'),
+    self.modules = {
         checkbox = require('render-markdown.render.checkbox'),
         code = require('render-markdown.render.code'),
         dash = require('render-markdown.render.dash'),
         document = require('render-markdown.render.document'),
         heading = require('render-markdown.render.heading'),
+        list = require('render-markdown.render.bullet'),
         paragraph = require('render-markdown.render.paragraph'),
         quote = require('render-markdown.render.quote'),
         section = require('render-markdown.render.section'),
@@ -67,12 +67,12 @@ end
 ---@return render.md.Mark[]
 function Handler:parse(root)
     local marks = Marks.new(self.context, false)
-    self.context.view:query(root, self.query, function(capture, node)
-        local renderer = self.renderers[capture]
-        assert(renderer ~= nil, 'unhandled markdown capture: ' .. capture)
-        local render = renderer:new(self.context, marks, node)
-        if render:setup() then
-            render:render()
+    self.context.view:nodes(root, self.query, function(capture, node)
+        local module = self.modules[capture]
+        assert(module ~= nil, 'unhandled markdown capture: ' .. capture)
+        local render = module:new(self.context, marks, node)
+        if render then
+            render:run()
         end
     end)
     return marks:get()

lua/render-markdown/handler/markdown_inline.lua

@@ -4,7 +4,7 @@ local ts = require('render-markdown.core.ts')
 
 ---@class render.md.handler.buf.MarkdownInline
 ---@field private query vim.treesitter.Query
----@field private renderers table<string, render.md.Render>
+---@field private modules table<string, render.md.Render>
 ---@field private context render.md.request.Context
 local Handler = {}
 Handler.__index = Handler
@@ -32,7 +32,7 @@ function Handler.new(buf)
                 (#lua-match? @inline_highlight "==[^=]+=="))
         ]]
     )
-    self.renderers = {
+    self.modules = {
         code_inline = require('render-markdown.render.code_inline'),
         inline_highlight = require('render-markdown.render.inline_highlight'),
         link = require('render-markdown.render.link'),
@@ -46,12 +46,12 @@ end
 ---@return render.md.Mark[]
 function Handler:parse(root)
     local marks = Marks.new(self.context, true)
-    self.context.view:query(root, self.query, function(capture, node)
-        local renderer = self.renderers[capture]
-        assert(renderer ~= nil, 'unhandled inline capture: ' .. capture)
-        local render = renderer:new(self.context, marks, node)
-        if render:setup() then
-            render:render()
+    self.context.view:nodes(root, self.query, function(capture, node)
+        local module = self.modules[capture]
+        assert(module ~= nil, 'unhandled inline capture: ' .. capture)
+        local render = module:new(self.context, marks, node)
+        if render then
+            render:run()
         end
     end)
     return marks:get()

lua/render-markdown/health.lua

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

lua/render-markdown/lib/env.lua

@@ -133,8 +133,8 @@ end
 ---@param name string
 ---@return render.md.option.Value
 ---@overload fun(buf: integer, name: 'buflisted'): boolean
----@overload fun(buf: integer, name: 'buftype'): integer
----@overload fun(buf: integer, name: 'filetype'): integer
+---@overload fun(buf: integer, name: 'buftype'): string
+---@overload fun(buf: integer, name: 'filetype'): string
 ---@overload fun(buf: integer, name: 'tabstop'): integer
 function M.buf.get(buf, name)
     return vim.api.nvim_get_option_value(name, { buf = buf })
@@ -202,18 +202,27 @@ function M.win.buf(win)
     return vim.fn.winbufnr(win)
 end
 
----@param win integer
----@return integer
-function M.win.width(win)
-    local infos = vim.fn.getwininfo(win)
-    local textoff = #infos == 1 and infos[1].textoff or 0
-    return vim.api.nvim_win_get_width(win) - textoff
-end
-
 ---@param win integer
 ---@return vim.fn.winsaveview.ret
 function M.win.view(win)
     return vim.api.nvim_win_call(win, vim.fn.winsaveview)
 end
 
+---@param win integer
+---@param value number
+---@param used integer
+---@return integer
+function M.win.percent(win, value, used)
+    if value <= 0 then
+        return 0
+    elseif value >= 1 then
+        return value
+    else
+        local infos = vim.fn.getwininfo(win)
+        local textoff = #infos == 1 and infos[1].textoff or 0
+        local width = vim.api.nvim_win_get_width(win) - textoff - used
+        return math.floor((width * value) + 0.5)
+    end
+end
+
 return M

lua/render-markdown/lib/marks.lua

@@ -147,7 +147,7 @@ function Marks:run_update(mark)
         })
     end
     if mark.opts.virt_text_pos == 'inline' then
-        self.context:add_offset(row, {
+        self.context.offset:add(row, {
             col = start_col,
             width = Str.line_width(mark.opts.virt_text),
         })

lua/render-markdown/render/base.lua

@@ -7,22 +7,22 @@ local colors = require('render-markdown.core.colors')
 ---@field protected config render.md.main.Config
 ---@field protected marks render.md.Marks
 ---@field protected node render.md.Node
----@field setup fun(self: render.md.Render): boolean
----@field render fun(self: render.md.Render)
+---@field protected setup fun(self: render.md.Render): boolean
+---@field run fun(self: render.md.Render)
 local Base = {}
 Base.__index = Base
 
 ---@param context render.md.request.Context
 ---@param marks render.md.Marks
 ---@param node render.md.Node
----@return render.md.Render
+---@return render.md.Render?
 function Base:new(context, marks, node)
     local instance = setmetatable({}, self)
     instance.context = context
     instance.config = context.config
     instance.marks = marks
     instance.node = node
-    return instance
+    return instance:setup() and instance or nil
 end
 
 ---@protected

lua/render-markdown/render/bullet.lua

@@ -12,22 +12,24 @@ local Str = require('render-markdown.lib.str')
 local Render = setmetatable({}, Base)
 Render.__index = Render
 
+---@protected
 ---@return boolean
 function Render:setup()
     local marker = self.node:child_at(0)
     if not marker then
         return false
     end
+    local checkbox = self.context.checkbox:get(self.node)
     self.data = {
         marker = marker,
         -- https://github.com/tree-sitter-grammars/tree-sitter-markdown/issues/127
         spaces = Str.spaces('start', marker.text),
-        checkbox = self.context:get_checkbox(self.node.start_row),
+        checkbox = checkbox and checkbox.config,
     }
     return true
 end
 
-function Render:render()
+function Render:run()
     if self:has_checkbox() then
         -- Hide the list marker for checkboxes rather than replacing with a bullet point
         self:hide_marker()