refactor: use abstract class for renderer

Author: MeanderingProgrammer

CHANGELOG.md

@@ -7,6 +7,8 @@
 - email link icon [74502e5](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/74502e5d34efa68dde051bcc6bf28db9748922c7)
 - deterministic custom link order [#146](https://github.com/MeanderingProgrammer/render-markdown.nvim/issues/146)
   [42dbd09](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/42dbd097d73d8c833f886f35ca3be2065973c628)
+- integrate treesitter injections: [#141](https://github.com/MeanderingProgrammer/render-markdown.nvim/issues/141)
+  [5ff9a59](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/5ff9a598622422100280769147ad5feff411c6da)
 
 ### Bug Fixes
 

README.md

@@ -34,6 +34,7 @@ Plugin to improve viewing Markdown files in Neovim
 - Contained: runs entirely inside Neovim with no external windows
 - Configurable: all components, padding, icons, and colors can be modified
 - File type agnostic: can render `markdown` injected into any file
+- Injections: can directly manipulate treesitter to add logical `markdown` sections
 - Mode based rendering: changes between `rendered` and `raw` view based on mode
 - Anti-conceal: hides virtual text added by this plugin on cursor line
 - Window options: changes option values between `rendered` and `raw` view

doc/render-markdown.txt

@@ -55,6 +55,7 @@ Plugin to improve viewing Markdown files in Neovim
 - Contained: runs entirely inside Neovim with no external windows
 - Configurable: all components, padding, icons, and colors can be modified
 - File type agnostic: can render `markdown` injected into any file
+- Injections: can directly manipulate treesitter to add logical `markdown` sections
 - Mode based rendering: changes between `rendered` and `raw` view based on mode
 - Anti-conceal: hides virtual text added by this plugin on cursor line
 - Window options: changes option values between `rendered` and `raw` view

lua/render-markdown/handler/markdown.lua

@@ -35,7 +35,7 @@ function Handler:parse(root)
     self.context:query(root, state.markdown_query, function(capture, info)
         local renderer = self.renderers[capture]
         if renderer ~= nil then
-            local render = renderer.new(self.marks, self.config, self.context, info)
+            local render = renderer:new(self.marks, self.config, self.context, info)
             if render:setup() then
                 render:render()
             end

lua/render-markdown/health.lua

@@ -5,7 +5,7 @@ local M = {}
 
 ---@private
 ---@type string
-M.version = '6.2.9'
+M.version = '6.2.10'
 
 function M.check()
     vim.health.start('render-markdown.nvim [version]')

lua/render-markdown/render/util.lua renamed to lua/render-markdown/render/base.lua

@@ -6,45 +6,57 @@ local str = require('render-markdown.core.str')
 ---@field protected config render.md.BufferConfig
 ---@field protected context render.md.Context
 ---@field protected info render.md.NodeInfo
----@field new fun(marks: render.md.Marks, config: render.md.BufferConfig, context: render.md.Context, info: render.md.NodeInfo): render.md.Renderer
 ---@field setup fun(self: render.md.Renderer): boolean
 ---@field render fun(self: render.md.Renderer)
+local Base = {}
+Base.__index = Base
 
----@class render.md.render.Util
-local M = {}
-
----@param config render.md.BufferConfig
 ---@param marks render.md.Marks
+---@param config render.md.BufferConfig
+---@param context render.md.Context
+---@param info render.md.NodeInfo
+---@return render.md.Renderer
+function Base:new(marks, config, context, info)
+    local instance = setmetatable({}, self)
+    instance.marks = marks
+    instance.config = config
+    instance.context = context
+    instance.info = info
+    return instance
+end
+
+---@protected
 ---@param info render.md.NodeInfo
 ---@param text? string
 ---@param highlight string
-function M.sign(config, marks, info, text, highlight)
-    if not config.sign.enabled or text == nil then
+function Base:sign(info, text, highlight)
+    local sign = self.config.sign
+    if not sign.enabled or text == nil then
         return
     end
-    marks:add(false, info.start_row, info.start_col, {
+    self.marks:add(false, info.start_row, info.start_col, {
         end_row = info.end_row,
         end_col = info.end_col,
         sign_text = text,
-        sign_hl_group = colors.combine(highlight, config.sign.highlight),
+        sign_hl_group = colors.combine(highlight, sign.highlight),
     })
 end
 
----@param config render.md.BufferConfig
----@param info render.md.NodeInfo
+---@protected
 ---@param line { [1]: string, [2]: string }[]
 ---@return { [1]: string, [2]: string }[]
-function M.indent_virt_line(config, info, line)
-    if not config.indent.enabled then
+function Base:indent_virt_line(line)
+    local indent = self.config.indent
+    if not indent.enabled then
         return line
     end
-    local level = info:level() - 1
+    local level = self.info:level() - 1
     if level <= 0 then
         return line
     end
-    local indent_line = { str.spaces(config.indent.per_level * level), 'Normal' }
+    local indent_line = { str.spaces(indent.per_level * level), 'Normal' }
     table.insert(line, 1, indent_line)
     return line
 end
 
-return M
+return Base

lua/render-markdown/render/code.lua

@@ -1,7 +1,7 @@
+local Base = require('render-markdown.render.base')
 local colors = require('render-markdown.colors')
 local icons = require('render-markdown.core.icons')
 local str = require('render-markdown.core.str')
-local util = require('render-markdown.render.util')
 
 ---@class render.md.data.Code
 ---@field col integer
@@ -16,16 +16,16 @@ local util = require('render-markdown.render.util')
 ---@class render.md.render.Code: render.md.Renderer
 ---@field private code render.md.Code
 ---@field private data render.md.data.Code
-local Render = {}
+local Render = setmetatable({}, Base)
 Render.__index = Render
 
 ---@param marks render.md.Marks
 ---@param config render.md.BufferConfig
 ---@param context render.md.Context
 ---@param info render.md.NodeInfo
 ---@return render.md.Renderer
-function Render.new(marks, config, context, info)
-    return setmetatable({ marks = marks, config = config, context = context, info = info }, Render)
+function Render:new(marks, config, context, info)
+    return Base.new(self, marks, config, context, info)
 end
 
 ---@return boolean
@@ -97,7 +97,7 @@ function Render:language_hint(add_background)
         return false
     end
     if self.code.sign then
-        util.sign(self.config, self.marks, info, icon, icon_highlight)
+        self:sign(info, icon, icon_highlight)
     end
     local highlight = { icon_highlight }
     if add_background then

lua/render-markdown/render/heading.lua

@@ -1,7 +1,7 @@
+local Base = require('render-markdown.render.base')
 local colors = require('render-markdown.colors')
 local list = require('render-markdown.core.list')
 local str = require('render-markdown.core.str')
-local util = require('render-markdown.render.util')
 
 ---@class render.md.data.Heading
 ---@field level integer
@@ -14,16 +14,16 @@ local util = require('render-markdown.render.util')
 ---@class render.md.render.Heading: render.md.Renderer
 ---@field private heading render.md.Heading
 ---@field private data render.md.data.Heading
-local Render = {}
+local Render = setmetatable({}, Base)
 Render.__index = Render
 
 ---@param marks render.md.Marks
 ---@param config render.md.BufferConfig
 ---@param context render.md.Context
 ---@param info render.md.NodeInfo
 ---@return render.md.Renderer
-function Render.new(marks, config, context, info)
-    return setmetatable({ marks = marks, config = config, context = context, info = info }, Render)
+function Render:new(marks, config, context, info)
+    return Base.new(self, marks, config, context, info)
 end
 
 ---@return boolean
@@ -53,7 +53,7 @@ end
 function Render:render()
     local icon_width = self:start_icon()
     if self.heading.sign then
-        util.sign(self.config, self.marks, self.info, self.data.sign, self.data.foreground)
+        self:sign(self.info, self.data.sign, self.data.foreground)
     end
 
     self.marks:add(true, self.info.start_row, 0, {
@@ -152,7 +152,7 @@ function Render:border(width)
         })
     else
         self.marks:add(false, self.info.start_row, 0, {
-            virt_lines = { util.indent_virt_line(self.config, self.info, line_above) },
+            virt_lines = { self:indent_virt_line(line_above) },
             virt_lines_above = true,
         })
     end
@@ -170,7 +170,7 @@ function Render:border(width)
         self.context.last_heading = self.info.end_row + 1
     else
         self.marks:add(false, self.info.end_row, 0, {
-            virt_lines = { util.indent_virt_line(self.config, self.info, line_below) },
+            virt_lines = { self:indent_virt_line(line_below) },
         })
     end
 end

lua/render-markdown/render/quote.lua

@@ -1,20 +1,21 @@
+local Base = require('render-markdown.render.base')
 local component = require('render-markdown.core.component')
 local logger = require('render-markdown.core.logger')
 local state = require('render-markdown.state')
 
 ---@class render.md.render.Quote: render.md.Renderer
 ---@field private quote render.md.Quote
 ---@field private highlight string
-local Render = {}
+local Render = setmetatable({}, Base)
 Render.__index = Render
 
 ---@param marks render.md.Marks
 ---@param config render.md.BufferConfig
 ---@param context render.md.Context
 ---@param info render.md.NodeInfo
 ---@return render.md.Renderer
-function Render.new(marks, config, context, info)
-    return setmetatable({ marks = marks, config = config, context = context, info = info }, Render)
+function Render:new(marks, config, context, info)
+    return Base.new(self, marks, config, context, info)
 end
 
 ---@return boolean

lua/render-markdown/render/table.lua

@@ -1,7 +1,7 @@
+local Base = require('render-markdown.render.base')
 local NodeInfo = require('render-markdown.core.node_info')
 local logger = require('render-markdown.core.logger')
 local str = require('render-markdown.core.str')
-local util = require('render-markdown.render.util')
 
 ---@class render.md.table.Column
 ---@field row integer
@@ -30,16 +30,16 @@ local util = require('render-markdown.render.util')
 ---@class render.md.render.Table: render.md.Renderer
 ---@field private table render.md.PipeTable
 ---@field private data render.md.data.Table
-local Render = {}
+local Render = setmetatable({}, Base)
 Render.__index = Render
 
 ---@param marks render.md.Marks
 ---@param config render.md.BufferConfig
 ---@param context render.md.Context
 ---@param info render.md.NodeInfo
 ---@return render.md.Renderer
-function Render.new(marks, config, context, info)
-    return setmetatable({ marks = marks, config = config, context = context, info = info }, Render)
+function Render:new(marks, config, context, info)
+    return Base.new(self, marks, config, context, info)
 end
 
 ---@return boolean
@@ -320,7 +320,7 @@ function Render:full()
         table.insert(line, { chars[1] .. table.concat(sections, chars[2]) .. chars[3], highlight })
         self.marks:add(false, info.start_row, info.start_col, {
             virt_lines_above = above,
-            virt_lines = { util.indent_virt_line(self.config, self.info, line) },
+            virt_lines = { self:indent_virt_line(line) },
         })
     end