chore: add default implementations for base render

## Details

Rather than having `setup` and `run` be type annotated methods on the
Base render module, add actual methods for them. Both implementations
throw exceptions, which should make catching any extensions that don't
have their own implementations easier, though not by much. Mostly just a
preference thing.

Author: MeanderingProgrammer

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## Pre-release
 
+### Features
+
+- allow checkbox to render bullet [#423](https://github.com/MeanderingProgrammer/render-markdown.nvim/issues/423)
+  [a1b0988](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/a1b0988f5ab26698afb56b9c2f0525a4de1195c1)
+- include highlight query files in checkhealth [4f05de7](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/4f05de7536571e231b66dd0363af347b162b5fd7)
+
 ## 8.4.0 (2025-05-08)
 
 ### Features

lua/render-markdown/debug/validator.lua

@@ -13,28 +13,28 @@ local Kind = {
 
 ---@class render.md.debug.ValidatorSpec
 ---@field private validator render.md.debug.Validator
----@field private data? table<string, any>
+---@field private config? table<string, any>
 ---@field private nilable boolean
 ---@field private path string[]
 ---@field private specs table<string, render.md.debug.Spec>
 local Spec = {}
 Spec.__index = Spec
 
 ---@param validator render.md.debug.Validator
----@param data? table<string, any>
+---@param config? table<string, any>
 ---@param nilable boolean
 ---@param path? string[]
 ---@param key any
 ---@return render.md.debug.ValidatorSpec
-function Spec.new(validator, data, nilable, path, key)
+function Spec.new(validator, config, nilable, path, key)
     local self = setmetatable({}, Spec)
     self.validator = validator
-    self.data = data
+    self.config = config
     self.nilable = nilable
     self.path = vim.list_extend({}, path or {})
-    if self.data and key then
-        self.data = self.data[key]
-        self.data = type(self.data) == 'table' and self.data or nil
+    if self.config and key then
+        self.config = self.config[key]
+        self.config = type(self.config) == 'table' and self.config or nil
         self.path[#self.path + 1] = tostring(key)
     end
     self.specs = {}
@@ -44,7 +44,7 @@ end
 ---@param f fun(spec: render.md.debug.ValidatorSpec)
 ---@param nilable? boolean
 function Spec:each(f, nilable)
-    local keys = self.data and vim.tbl_keys(self.data) or {}
+    local keys = self.config and vim.tbl_keys(self.config) or {}
     self:nested(keys, f, nilable)
 end
 
@@ -58,7 +58,7 @@ function Spec:nested(keys, f, nilable)
     end
     for _, key in ipairs(keys) do
         self:type(key, 'table')
-        f(Spec.new(self.validator, self.data, nilable, self.path, key))
+        f(Spec.new(self.validator, self.config, nilable, self.path, key))
     end
 end
 
@@ -187,7 +187,7 @@ end
 ---@param message string
 ---@param validation fun(v: any): boolean, string?
 function Spec:add(keys, kind, message, validation)
-    if self.data then
+    if self.config then
         keys = type(keys) == 'table' and keys or { keys }
         for _, key in ipairs(keys) do
             self.specs[key] = {
@@ -200,10 +200,10 @@ function Spec:add(keys, kind, message, validation)
 end
 
 function Spec:check()
-    if not self.data or vim.tbl_count(self.specs) == 0 then
+    if not self.config or vim.tbl_count(self.specs) == 0 then
         return
     end
-    self.validator:check(self.path, self.data, self.specs)
+    self.validator:check(self.path, self.config, self.specs)
 end
 
 ---@class render.md.debug.Validator
@@ -221,13 +221,13 @@ end
 Validator.spec = Spec.new
 
 ---@param path string[]
----@param data table<string, any>
+---@param config table<string, any>
 ---@param specs table<string, render.md.debug.Spec>
-function Validator:check(path, data, specs)
+function Validator:check(path, config, specs)
     for key, spec in pairs(specs) do
         local root = vim.list_extend({}, path)
         root[#root + 1] = tostring(key)
-        local value = data[key]
+        local value = config[key]
         local ok, info = spec.validation(value)
         if not ok then
             local actual
@@ -246,7 +246,7 @@ function Validator:check(path, data, specs)
             self.errors[#self.errors + 1] = message
         end
     end
-    for key in pairs(data) do
+    for key in pairs(config) do
         local root = vim.list_extend({}, path)
         root[#root + 1] = tostring(key)
         if not specs[key] then

lua/render-markdown/health.lua

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

lua/render-markdown/render/base.lua

@@ -5,8 +5,6 @@ local colors = require('render-markdown.core.colors')
 ---@field protected context render.md.request.Context
 ---@field protected marks render.md.Marks
 ---@field protected node render.md.Node
----@field protected setup fun(self: render.md.Render): boolean
----@field protected run fun(self: render.md.Render)
 local Base = {}
 Base.__index = Base
 
@@ -27,6 +25,17 @@ function Base:execute(context, marks, node)
     end
 end
 
+---@protected
+---@return boolean
+function Base:setup()
+    error('unimplemented', 2)
+end
+
+---@protected
+function Base:run()
+    error('unimplemented', 2)
+end
+
 ---@protected
 ---@return render.md.Line
 function Base:line()
@@ -45,7 +54,7 @@ end
 ---@param highlight? string
 function Base:sign(enabled, text, highlight)
     local config = self.context.config.sign
-    if not config.enabled or not enabled or not text then
+    if not enabled or not text or not config.enabled then
         return
     end
     local sign_highlight = config.highlight

lua/render-markdown/render/markdown/code.lua

@@ -59,7 +59,7 @@ function Render:offset(value, used)
     end
     local result = Env.win.percent(self.context.win, value, used)
     if self.node.text:find('\t') then
-        -- rounds to the next multiple of tab
+        -- round to the next multiple of tab
         local tab = Env.buf.get(self.context.buf, 'tabstop')
         result = math.ceil(result / tab) * tab
     end
@@ -73,17 +73,17 @@ function Render:run()
     self.marks:over(true, language, { conceal = '' })
 
     local start_row = self.node.start_row
-    local top = self.node:child('fenced_code_block_delimiter', start_row)
-    self.marks:over(true, top, { conceal = '' })
+    local above = self.node:child('fenced_code_block_delimiter', start_row)
+    self.marks:over(true, above, { conceal = '' })
 
     local end_row = self.node.end_row - 1
-    local bottom = self.node:child('fenced_code_block_delimiter', end_row)
-    self.marks:over(true, bottom, { conceal = '' })
+    local below = self.node:child('fenced_code_block_delimiter', end_row)
+    self.marks:over(true, below, { conceal = '' })
 
-    local icon = self:language(language, top)
+    local icon = self:language(language, above)
     local has_more = info and language and info.end_col > language.end_col
-    self:border(top, true, not icon and not has_more)
-    self:border(bottom, false, true)
+    self:border(above, self.config.above, not icon and not has_more)
+    self:border(below, self.config.below, true)
 
     local background = self:background_enabled(language)
     if background then
@@ -158,29 +158,31 @@ end
 
 ---@private
 ---@param node? render.md.Node
----@param above boolean
+---@param icon string
 ---@param empty boolean
-function Render:border(node, above, empty)
+function Render:border(node, icon, empty)
     local kind = self.config.border
     local highlight = self.config.highlight_border
-    if kind == 'none' or type(highlight) == 'boolean' or not node then
-        -- skip
-    elseif kind == 'thick' or not empty then
-        self:background(node.start_row, node.start_row, highlight)
-    elseif
-        kind == 'hide' and self.marks:over(true, node, { conceal_lines = '' })
-    then
-        -- successfully added
-    else
-        local row, col = node.start_row, self.node.start_col
-        local border = above and self.config.above or self.config.below
-        local width = self.config.width == 'block' and self.data.body - col
-            or vim.o.columns
-        self.marks:add('code_border', row, col, {
-            virt_text = { { border:rep(width), colors.bg_as_fg(highlight) } },
-            virt_text_pos = 'overlay',
-        })
+    if not node or kind == 'none' or type(highlight) == 'boolean' then
+        return
+    end
+    local row = node.start_row
+    if kind == 'thick' or not empty then
+        self:background(row, row, highlight)
+        return
+    end
+    if kind == 'hide' then
+        if self.marks:over(true, node, { conceal_lines = '' }) then
+            return
+        end
     end
+    local col = self.node.start_col
+    local block = self.config.width == 'block'
+    local width = block and self.data.body - col or vim.o.columns
+    self.marks:add('code_border', row, col, {
+        virt_text = { { icon:rep(width), colors.bg_as_fg(highlight) } },
+        virt_text_pos = 'overlay',
+    })
 end
 
 ---@private
@@ -241,8 +243,8 @@ function Render:padding(background)
         return
     end
 
-    -- use lowest priority (0) to include all other marks in padding when code block is at edge
-    -- use medium priority (1000) to include border marks while likely avoiding other plugins
+    -- 0    | low    | includes other marks in padding when code block is at edge
+    -- 1000 | medium | includes border marks while likely avoiding other plugins
     local priority = col == 0 and 0 or 1000
     local highlight = background and self.config.highlight or nil