chore(refactor): improve encapsulation, create validator class for config validation

Author: MeanderingProgrammer

CHANGELOG.md

@@ -8,6 +8,9 @@
   [c686970](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/c68697085441d03a20eee15d4d78e2e5a771569a)
 - configurable padding highlight [#176](https://github.com/MeanderingProgrammer/render-markdown.nvim/issues/176)
   [095078d](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/095078d931ce23b544face8ca7b845adf7fad7e9)
+- pad setext header lines [75a0a95](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/75a0a9596a91130fae43d3b7c0d6c651645ef1df)
+- center headings and code blocks [#179](https://github.com/MeanderingProgrammer/render-markdown.nvim/issues/179)
+  [0986638](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/0986638b381a4b01eb108bb946f3a67a9eb3d0ec)
 
 ### Bug Fixes
 

lua/render-markdown/api.lua

@@ -17,9 +17,7 @@ function M.toggle()
 end
 
 function M.log()
-    local log = require('render-markdown.core.log')
-    log.flush()
-    vim.cmd.tabnew(log.file)
+    require('render-markdown.core.log').open()
 end
 
 function M.expand()

lua/render-markdown/core/buffer_state.lua

@@ -2,7 +2,7 @@
 ---@field private buf integer
 ---@field private timer uv_timer_t
 ---@field private running boolean
----@field marks? render.md.Extmark[]
+---@field private marks? render.md.Extmark[]
 local BufferState = {}
 BufferState.__index = BufferState
 
@@ -29,4 +29,19 @@ function BufferState:debounce(ms, callback)
     end
 end
 
+---@return boolean
+function BufferState:has_marks()
+    return self.marks ~= nil
+end
+
+---@return render.md.Extmark[]
+function BufferState:get_marks()
+    return self.marks or {}
+end
+
+---@param marks? render.md.Extmark[]
+function BufferState:set_marks(marks)
+    self.marks = marks
+end
+
 return BufferState

lua/render-markdown/core/extmark.lua

@@ -1,6 +1,6 @@
 ---@class render.md.Extmark
 ---@field private id? integer
----@field mark render.md.Mark
+---@field private mark render.md.Mark
 local Extmark = {}
 Extmark.__index = Extmark
 
@@ -13,6 +13,11 @@ function Extmark.new(mark)
     return self
 end
 
+---@return render.md.Mark
+function Extmark:get_mark()
+    return self.mark
+end
+
 ---@param hidden Range2?
 ---@return boolean
 function Extmark:overlaps(hidden)

lua/render-markdown/core/log.lua

@@ -9,7 +9,7 @@ local util = require('render-markdown.core.util')
 ---@class render.md.Log
 ---@field private level render.md.config.LogLevel
 ---@field private entries render.md.log.Entry[]
----@field file string
+---@field private file string
 local M = {}
 
 ---@param level render.md.config.LogLevel
@@ -29,6 +29,11 @@ function M.setup(level)
     end
 end
 
+function M.open()
+    M.flush()
+    vim.cmd.tabnew(M.file)
+end
+
 ---@param capture string
 ---@param info render.md.NodeInfo
 function M.node_info(capture, info)
@@ -105,6 +110,7 @@ function M.level_value(level)
     end
 end
 
+---@private
 function M.flush()
     if #M.entries == 0 then
         return

lua/render-markdown/core/node_info.lua

@@ -1,6 +1,6 @@
 ---@class render.md.NodeInfo
 ---@field private buf integer
----@field node TSNode
+---@field private node TSNode
 ---@field type string
 ---@field text string
 ---@field start_row integer
@@ -38,6 +38,11 @@ function NodeInfo.__lt(a, b)
     end
 end
 
+---@return TSNode
+function NodeInfo:get_node()
+    return self.node
+end
+
 ---@return boolean
 function NodeInfo:has_error()
     return self.node:has_error()

lua/render-markdown/core/ui.lua

@@ -51,9 +51,9 @@ function M.get_row_marks(buf, win)
     assert(row ~= nil and hidden ~= nil, 'Row & range must be known to get marks')
 
     local marks = {}
-    for _, extmark in ipairs(buffer_state.marks or {}) do
+    for _, extmark in ipairs(buffer_state:get_marks()) do
         if extmark:overlaps(hidden) then
-            table.insert(marks, extmark.mark)
+            table.insert(marks, extmark:get_mark())
         end
     end
     return row, marks
@@ -64,7 +64,7 @@ end
 ---@param buffer_state render.md.BufferState
 function M.clear(buf, buffer_state)
     vim.api.nvim_buf_clear_namespace(buf, M.namespace, 0, -1)
-    buffer_state.marks = nil
+    buffer_state:set_marks(nil)
 end
 
 ---@param buf integer
@@ -109,13 +109,13 @@ function M.update(buf, win, parse)
     end
 
     if next_state == 'rendered' then
-        if buffer_state.marks == nil or parse then
+        if not buffer_state:has_marks() or parse then
             M.clear(buf, buffer_state)
-            buffer_state.marks = M.parse_buffer(buf, win)
+            buffer_state:set_marks(M.parse_buffer(buf, win))
         end
         local hidden = config:hidden(mode, row)
-        for _, extmark in ipairs(buffer_state.marks) do
-            if extmark.mark.conceal and extmark:overlaps(hidden) then
+        for _, extmark in ipairs(buffer_state:get_marks()) do
+            if extmark:get_mark().conceal and extmark:overlaps(hidden) then
                 extmark:hide(M.namespace, buf)
             else
                 extmark:show(M.namespace, buf)

lua/render-markdown/debug/validator.lua

@@ -0,0 +1,197 @@
+---@class render.md.debug.ValidatorSpec
+---@field private validator render.md.debug.Validator
+---@field private nilable? boolean
+---@field private suffix string
+---@field private input? table<string, any>
+---@field private opts table<string, vim.validate.Spec>
+local Spec = {}
+Spec.__index = Spec
+
+---@param validator render.md.debug.Validator
+---@param path string
+---@param input table<string, any>
+---@param key? string|string[]
+---@param nilable? boolean
+---@return render.md.debug.ValidatorSpec
+function Spec.new(validator, path, input, key, nilable)
+    local self = setmetatable({}, Spec)
+    self.validator = validator
+    self.nilable = nilable
+    self.suffix = path
+    self.input = input
+    self.opts = {}
+    if key ~= nil then
+        key = type(key) == 'table' and key or { key }
+        self.suffix = self.suffix .. '.' .. table.concat(key, '.')
+        self.input = vim.tbl_get(self.input, unpack(key))
+        assert(self.input ~= nil or self.nilable == true)
+    end
+    return self
+end
+
+---@return string
+function Spec:get_suffix()
+    return self.suffix
+end
+
+---@return table<string, any>
+function Spec:get_input()
+    return self.input
+end
+
+---@param f fun(spec: render.md.debug.ValidatorSpec)
+---@param nilable? boolean
+function Spec:for_each(f, nilable)
+    for name in pairs(self.input or {}) do
+        f(Spec.new(self.validator, self.suffix, self.input, name, nilable))
+    end
+end
+
+---@param keys string|string[]
+---@param types type|type[]
+---@return render.md.debug.ValidatorSpec
+function Spec:type(keys, types)
+    return self:add(keys, types, nil)
+end
+
+---@param keys string|string[]
+---@param values string[]
+---@param input_types? type|type[]
+---@return render.md.debug.ValidatorSpec
+function Spec:one_of(keys, values, input_types)
+    local types, suffix = self:handle_types(input_types)
+    return self:add(keys, function(v)
+        return vim.tbl_contains(values, v) or vim.tbl_contains(types, type(v))
+    end, 'one of ' .. vim.inspect(values) .. suffix)
+end
+
+---@param keys string|string[]
+---@param input_types? type|type[]
+---@return render.md.debug.ValidatorSpec
+function Spec:string_array(keys, input_types)
+    local types, suffix = self:handle_types(input_types)
+    return self:add(keys, function(v)
+        if vim.tbl_contains(types, type(v)) then
+            return true
+        elseif type(v) == 'table' then
+            for i, item in ipairs(v) do
+                if type(item) ~= 'string' then
+                    return false, string.format('Index %d is %s', i, type(item))
+                end
+            end
+            return true
+        else
+            return false
+        end
+    end, 'string array' .. suffix)
+end
+
+---@param keys string|string[]
+---@param values string[]
+---@param input_types? type|type[]
+---@return render.md.debug.ValidatorSpec
+function Spec:one_or_array_of(keys, values, input_types)
+    local types, suffix = self:handle_types(input_types)
+    return self:add(keys, function(v)
+        if vim.tbl_contains(types, type(v)) then
+            return true
+        elseif type(v) == 'string' then
+            return vim.tbl_contains(values, v)
+        elseif type(v) == 'table' then
+            for i, item in ipairs(v) do
+                if not vim.tbl_contains(values, item) then
+                    return false, string.format('Index %d is %s', i, item)
+                end
+            end
+            return true
+        else
+            return false
+        end
+    end, 'one or array of ' .. vim.inspect(values) .. suffix)
+end
+
+---@private
+---@param input_types? type|type[]
+---@return type[], string
+function Spec:handle_types(input_types)
+    local types = nil
+    if input_types == nil then
+        types = {}
+    elseif type(input_types) == 'string' then
+        types = { input_types }
+    else
+        types = input_types
+    end
+    if self.nilable then
+        table.insert(types, 'nil')
+    end
+    return types, #types == 0 and '' or (' or type ' .. vim.inspect(types))
+end
+
+---@private
+---@param keys string|string[]
+---@param logic type|type[]|fun(v: any): boolean, any?
+---@param message string?
+---@return render.md.debug.ValidatorSpec
+function Spec:add(keys, logic, message)
+    if self.input ~= nil then
+        keys = type(keys) == 'table' and keys or { keys }
+        for _, key in ipairs(keys) do
+            ---@diagnostic disable-next-line: assign-type-mismatch
+            self.opts[key] = { self.input[key], logic, message or self.nilable }
+        end
+    end
+    return self
+end
+
+function Spec:check()
+    if self.input ~= nil then
+        self.validator:check(self.suffix, self.input, self.opts)
+    end
+end
+
+---@class render.md.debug.Validator
+---@field private prefix string
+---@field private errors string[]
+local Validator = {}
+Validator.__index = Validator
+
+---@return render.md.debug.Validator
+function Validator.new()
+    local self = setmetatable({}, Validator)
+    self.prefix = 'render-markdown'
+    self.errors = {}
+    return self
+end
+
+---@param path string
+---@param input table<string, any>
+---@param key? string|string[]
+---@param nilable? boolean
+---@return render.md.debug.ValidatorSpec
+function Validator:spec(path, input, key, nilable)
+    return Spec.new(self, path, input, key, nilable)
+end
+
+---@param suffix string
+---@param input table<string, any>
+---@param opts table<string, vim.validate.Spec>
+function Validator:check(suffix, input, opts)
+    local path = self.prefix .. suffix
+    local ok, err = pcall(vim.validate, opts)
+    if not ok then
+        table.insert(self.errors, path .. '.' .. err)
+    end
+    for key, _ in pairs(input) do
+        if opts[key] == nil then
+            table.insert(self.errors, string.format('%s.%s: is not a valid key', path, key))
+        end
+    end
+end
+
+---@return string[]
+function Validator:get_errors()
+    return self.errors
+end
+
+return Validator

lua/render-markdown/health.lua

@@ -4,7 +4,7 @@ local state = require('render-markdown.state')
 local M = {}
 
 ---@private
-M.version = '7.1.6'
+M.version = '7.1.7'
 
 function M.check()
     M.start('version')

lua/render-markdown/render/quote.lua

@@ -31,7 +31,7 @@ function Render:setup()
 end
 
 function Render:render()
-    self.context:query(self.info.node, state.markdown_quote_query, function(capture, info)
+    self.context:query(self.info:get_node(), state.markdown_quote_query, function(capture, info)
         if capture == 'quote_marker' then
             self:quote_marker(info)
         else