chore(refactor): move renders to sub directory based on language

MeanderingProgrammer · MeanderingProgrammer · commit 617f9c2b3585 · 2025-05-05T13:14:32.000-07:00
## Details

Rather than storing all the render classes in the render folder directly
move each one to a sub folder based on the language it is rendering for.

- html
  - html_comment -&gt; comment
  - html_tag -&gt; tag
- markdown
  - checkbox
  - code
  - dash
  - document
  - heading
  - bullet
  - paragraph
  - quote
  - section
  - table
- markdown_inline (uses folder name inline instead of markdown_inline)
  - code_inline -&gt; code
  - inline_highlight -&gt; highlight
  - link
  - shortcut

Other changes:

- instead of exposing any fields from `Base` render module, replace the
  `new` method with `execute` which in addition to calling `setup` also
  calls `run` if setup returns `true`, return whether `run` was executed
  as a boolean, for future use
- make `run` method `protected` in all render implementations, since
  it's not only used within `Base:execute`
diff --git a/doc/render-markdown.txt b/doc/render-markdown.txt
@@ -1,4 +1,4 @@
-*render-markdown.txt*         For NVIM v0.11.1        Last change: 2025 May 04
+*render-markdown.txt*         For NVIM v0.11.1        Last change: 2025 May 05
 
 ==============================================================================
 Table of Contents                          *render-markdown-table-of-contents*
diff --git a/lua/render-markdown/handler/html.lua b/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 modules table<string, render.md.Render>
+---@field private renders table<string, render.md.Render>
 ---@field private context render.md.request.Context
 local Handler = {}
 Handler.__index = Handler
@@ -20,9 +20,9 @@ function Handler.new(buf)
             (element) @tag
         ]]
     )
-    self.modules = {
-        comment = require('render-markdown.render.html_comment'),
-        tag = require('render-markdown.render.html_tag'),
+    self.renders = {
+        comment = require('render-markdown.render.html.comment'),
+        tag = require('render-markdown.render.html.tag'),
     }
     self.context = Context.get(buf)
     return self
@@ -36,12 +36,9 @@ function Handler:parse(root)
     end
     local marks = Marks.new(self.context, true)
     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
+        local render = self.renders[capture]
+        assert(render ~= nil, 'unhandled html capture: ' .. capture)
+        render:execute(self.context, marks, node)
     end)
     return marks:get()
 end
diff --git a/lua/render-markdown/handler/markdown.lua b/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 modules table<string, render.md.Render>
+---@field private renders table<string, render.md.Render>
 ---@field private context render.md.request.Context
 local Handler = {}
 Handler.__index = Handler
@@ -16,16 +16,10 @@ function Handler.new(buf)
     self.query = ts.parse(
         'markdown',
         [[
-            (document) @document
-
-            (section) @section
-
             [
-                (atx_heading)
-                (setext_heading)
-            ] @heading
-
-            (section (paragraph) @paragraph)
+                (task_list_marker_unchecked)
+                (task_list_marker_checked)
+            ] @checkbox
 
             (fenced_code_block) @code
 
@@ -35,29 +29,35 @@ function Handler.new(buf)
                 (plus_metadata)
             ] @dash
 
-            (list_item) @list
+            (document) @document
 
             [
-                (task_list_marker_unchecked)
-                (task_list_marker_checked)
-            ] @checkbox
+                (atx_heading)
+                (setext_heading)
+            ] @heading
+
+            (list_item) @list
+
+            (section (paragraph) @paragraph)
 
             (block_quote) @quote
 
+            (section) @section
+
             (pipe_table) @table
         ]]
     )
-    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'),
-        table = require('render-markdown.render.table'),
+    self.renders = {
+        checkbox = require('render-markdown.render.markdown.checkbox'),
+        code = require('render-markdown.render.markdown.code'),
+        dash = require('render-markdown.render.markdown.dash'),
+        document = require('render-markdown.render.markdown.document'),
+        heading = require('render-markdown.render.markdown.heading'),
+        list = require('render-markdown.render.markdown.bullet'),
+        paragraph = require('render-markdown.render.markdown.paragraph'),
+        quote = require('render-markdown.render.markdown.quote'),
+        section = require('render-markdown.render.markdown.section'),
+        table = require('render-markdown.render.markdown.table'),
     }
     self.context = Context.get(buf)
     return self
@@ -68,12 +68,9 @@ end
 function Handler:parse(root)
     local marks = Marks.new(self.context, false)
     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
+        local render = self.renders[capture]
+        assert(render ~= nil, 'unhandled markdown capture: ' .. capture)
+        render:execute(self.context, marks, node)
     end)
     return marks:get()
 end
diff --git a/lua/render-markdown/handler/markdown_inline.lua b/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 modules table<string, render.md.Render>
+---@field private renders table<string, render.md.Render>
 ---@field private context render.md.request.Context
 local Handler = {}
 Handler.__index = Handler
@@ -16,9 +16,10 @@ function Handler.new(buf)
     self.query = ts.parse(
         'markdown_inline',
         [[
-            (code_span) @code_inline
+            (code_span) @code
 
-            (shortcut_link) @shortcut
+            ((inline) @highlight
+                (#lua-match? @highlight "==[^=]+=="))
 
             [
                 (email_autolink)
@@ -28,15 +29,14 @@ function Handler.new(buf)
                 (uri_autolink)
             ] @link
 
-            ((inline) @inline_highlight
-                (#lua-match? @inline_highlight "==[^=]+=="))
+            (shortcut_link) @shortcut
         ]]
     )
-    self.modules = {
-        code_inline = require('render-markdown.render.code_inline'),
-        inline_highlight = require('render-markdown.render.inline_highlight'),
-        link = require('render-markdown.render.link'),
-        shortcut = require('render-markdown.render.shortcut'),
+    self.renders = {
+        code = require('render-markdown.render.inline.code'),
+        highlight = require('render-markdown.render.inline.highlight'),
+        link = require('render-markdown.render.inline.link'),
+        shortcut = require('render-markdown.render.inline.shortcut'),
     }
     self.context = Context.get(buf)
     return self
@@ -47,12 +47,9 @@ end
 function Handler:parse(root)
     local marks = Marks.new(self.context, true)
     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
+        local render = self.renders[capture]
+        assert(render ~= nil, 'unhandled inline capture: ' .. capture)
+        render:execute(self.context, marks, node)
     end)
     return marks:get()
 end
diff --git a/lua/render-markdown/health.lua b/lua/render-markdown/health.lua
@@ -5,7 +5,7 @@ local state = require('render-markdown.state')
 local M = {}
 
 ---@private
-M.version = '8.3.26'
+M.version = '8.3.27'
 
 function M.check()
     M.start('version')
diff --git a/lua/render-markdown/render/base.lua b/lua/render-markdown/render/base.lua
@@ -8,21 +8,26 @@ local colors = require('render-markdown.core.colors')
 ---@field protected marks render.md.Marks
 ---@field protected node render.md.Node
 ---@field protected setup fun(self: render.md.Render): boolean
----@field run fun(self: render.md.Render)
+---@field protected 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?
-function Base:new(context, marks, node)
+---@return boolean
+function Base:execute(context, marks, node)
     local instance = setmetatable({}, self)
     instance.context = context
     instance.config = context.config
     instance.marks = marks
     instance.node = node
-    return instance:setup() and instance or nil
+    if instance:setup() then
+        instance:run()
+        return true
+    else
+        return false
+    end
 end
 
 ---@protected
diff --git a/lua/render-markdown/render/html/comment.lua b/lua/render-markdown/render/html/comment.lua
@@ -15,6 +15,7 @@ function Render:setup()
     return true
 end
 
+---@protected
 function Render:run()
     self.marks:over(true, self.node, { conceal = '' })
     if self.info.text then
diff --git a/lua/render-markdown/render/html/tag.lua b/lua/render-markdown/render/html/tag.lua
@@ -20,6 +20,7 @@ function Render:setup()
     return self.info ~= nil
 end
 
+---@protected
 function Render:run()
     self.marks:over(true, self.node:child('start_tag'), { conceal = '' })
     self.marks:over(true, self.node:child('end_tag'), { conceal = '' })
diff --git a/lua/render-markdown/render/inline/code.lua b/lua/render-markdown/render/inline/code.lua
@@ -1,7 +1,7 @@
 local Base = require('render-markdown.render.base')
 local colors = require('render-markdown.core.colors')
 
----@class render.md.render.CodeInline: render.md.Render
+---@class render.md.render.inline.Code: render.md.Render
 ---@field private info render.md.code.Config
 local Render = setmetatable({}, Base)
 Render.__index = Render
@@ -19,6 +19,7 @@ function Render:setup()
     return true
 end
 
+---@protected
 function Render:run()
     local highlight = self.info.highlight_inline
     self.marks:over('code_background', self.node, { hl_group = highlight })
diff --git a/lua/render-markdown/render/inline/highlight.lua b/lua/render-markdown/render/inline/highlight.lua
@@ -1,6 +1,6 @@
 local Base = require('render-markdown.render.base')
 
----@class render.md.render.InlineHighlight: render.md.Render
+---@class render.md.render.inline.Highlight: render.md.Render
 ---@field private info render.md.inline.highlight.Config
 local Render = setmetatable({}, Base)
 Render.__index = Render
@@ -15,6 +15,7 @@ function Render:setup()
     return true
 end
 
+---@protected
 function Render:run()
     for _, range in ipairs(self.node:find('==[^=]+==')) do
         -- Hide first 2 equal signs
diff --git a/lua/render-markdown/render/inline/link.lua b/lua/render-markdown/render/inline/link.lua
@@ -4,7 +4,7 @@ local Base = require('render-markdown.render.base')
 ---@field icon render.md.mark.Text
 ---@field autolink boolean
 
----@class render.md.render.Link: render.md.Render
+---@class render.md.render.inline.Link: render.md.Render
 ---@field private data render.md.link.Data
 local Render = setmetatable({}, Base)
 Render.__index = Render
@@ -41,6 +41,7 @@ function Render:setup()
     return true
 end
 
+---@protected
 function Render:run()
     self.marks:start('link', self.node, {
         hl_mode = 'combine',
diff --git a/lua/render-markdown/render/inline/shortcut.lua b/lua/render-markdown/render/inline/shortcut.lua
@@ -2,7 +2,7 @@ local Base = require('render-markdown.render.base')
 local Converter = require('render-markdown.lib.converter')
 local Str = require('render-markdown.lib.str')
 
----@class render.md.render.Shortcut: render.md.Render
+---@class render.md.render.inline.Shortcut: render.md.Render
 local Render = setmetatable({}, Base)
 Render.__index = Render
 
@@ -12,6 +12,7 @@ function Render:setup()
     return true
 end
 
+---@protected
 function Render:run()
     local callout = self.config:get_callout(self.node)
     if callout then
diff --git a/lua/render-markdown/render/markdown/bullet.lua b/lua/render-markdown/render/markdown/bullet.lua
@@ -29,6 +29,7 @@ function Render:setup()
     return true
 end
 
+---@protected
 function Render:run()
     if self:has_checkbox() then
         -- Hide the list marker for checkboxes rather than replacing with a bullet point
diff --git a/lua/render-markdown/render/markdown/checkbox.lua b/lua/render-markdown/render/markdown/checkbox.lua
@@ -23,6 +23,7 @@ function Render:setup()
     return true
 end
 
+---@protected
 function Render:run()
     self:check_icon(self.info.icon, self.info.highlight)
     local scope_node = self.node:sibling('paragraph')
diff --git a/lua/render-markdown/render/markdown/code.lua b/lua/render-markdown/render/markdown/code.lua
@@ -66,6 +66,7 @@ function Render:offset(value, used)
     return result
 end
 
+---@protected
 function Render:run()
     local info = self.node:child('info_string')
     local language = info and info:child('language')
diff --git a/lua/render-markdown/render/markdown/dash.lua b/lua/render-markdown/render/markdown/dash.lua
@@ -39,6 +39,7 @@ function Render:get_width(width, used)
     end
 end
 
+---@protected
 function Render:run()
     local line = self.config:line():pad(self.data.margin)
     line:text(self.info.icon:rep(self.data.width), self.info.highlight)
diff --git a/lua/render-markdown/render/markdown/document.lua b/lua/render-markdown/render/markdown/document.lua
@@ -15,6 +15,7 @@ function Render:setup()
     return true
 end
 
+---@protected
 function Render:run()
     for _, pattern in ipairs(self.info.conceal.char_patterns) do
         for _, range in ipairs(self.node:find(pattern)) do
diff --git a/lua/render-markdown/render/markdown/heading.lua b/lua/render-markdown/render/markdown/heading.lua
@@ -97,6 +97,7 @@ function Render:get_string(values, level)
     end
 end
 
+---@protected
 function Render:run()
     self:sign(self.info.sign, self.data.sign, self.data.fg)
     local box = self:box(self:icon())
diff --git a/lua/render-markdown/render/markdown/paragraph.lua b/lua/render-markdown/render/markdown/paragraph.lua
@@ -38,6 +38,7 @@ function Render:get_number(value)
     end
 end
 
+---@protected
 function Render:run()
     local width = math.max(vim.fn.max(self.node:widths()), self.info.min_width)
     local margin = Env.win.percent(self.context.win, self.data.margin, width)
diff --git a/lua/render-markdown/render/markdown/quote.lua b/lua/render-markdown/render/markdown/quote.lua
@@ -41,6 +41,7 @@ function Render:setup()
     return true
 end
 
+---@protected
 function Render:run()
     local root = self.node:get()
     self.context.view:nodes(root, self.data.query, function(capture, node)
diff --git a/lua/render-markdown/render/markdown/section.lua b/lua/render-markdown/render/markdown/section.lua
@@ -30,6 +30,7 @@ function Render:setup()
     return true
 end
 
+---@protected
 function Render:run()
     local start_row = math.max(self.node.start_row + self:start_below(), 0)
     local end_row = self.node.end_row - 1 - self:end_above()
diff --git a/lua/render-markdown/render/markdown/table.lua b/lua/render-markdown/render/markdown/table.lua

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-render-markdown.txt For NVIM v0.11.1 Last change: 2025 May 04`
	`1`	`+render-markdown.txt For NVIM v0.11.1 Last change: 2025 May 05`
`2`	`2`
`3`	`3`	`==============================================================================`
`4`	`4`	`Table of Contents render-markdown-table-of-contents`