chore: add base component class that all others extend

## Details

Adds a `BaseComponent` class that is inherited by all major components.

Currently only adds the `enabled` flag information, may be extended in
the future to add additional common attributes.

Aligns configuration validation logic with this new type hierarchy
to make any additions easy to validate across all components.

Author: MeanderingProgrammer

lua/render-markdown/health.lua

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

lua/render-markdown/init.lua

@@ -15,8 +15,10 @@ local M = {}
 ---@field public attach? fun(buf: integer)
 ---@field public render? fun(buf: integer)
 
----@class (exact) render.md.UserLatex
+---@class (exact) render.md.UserBaseComponent
 ---@field public enabled? boolean
+
+---@class (exact) render.md.UserLatex: render.md.UserBaseComponent
 ---@field public converter? string
 ---@field public highlight? string
 ---@field public top_pad? integer
@@ -37,22 +39,18 @@ local M = {}
 ---@field public text? string
 ---@field public highlight? string
 
----@class (exact) render.md.UserHtml
----@field public enabled? boolean
+---@class (exact) render.md.UserHtml: render.md.UserBaseComponent
 ---@field public comment? render.md.UserHtmlComment
 
----@class (exact) render.md.UserIndent
----@field public enabled? boolean
+---@class (exact) render.md.UserIndent: render.md.UserBaseComponent
 ---@field public per_level? integer
 ---@field public skip_level? integer
 ---@field public skip_heading? boolean
 
----@class (exact) render.md.UserInlineHighlight
----@field public enabled? boolean
+---@class (exact) render.md.UserInlineHighlight: render.md.UserBaseComponent
 ---@field public highlight? string
 
----@class (exact) render.md.UserSign
----@field public enabled? boolean
+---@class (exact) render.md.UserSign: render.md.UserBaseComponent
 ---@field public highlight? string
 
 ---@class (exact) render.md.UserLinkComponent
@@ -69,8 +67,7 @@ local M = {}
 ---@field public prefix? string
 ---@field public suffix? string
 
----@class (exact) render.md.UserLink
----@field public enabled? boolean
+---@class (exact) render.md.UserLink: render.md.UserBaseComponent
 ---@field public footnote? render.md.UserFootnote
 ---@field public image? string
 ---@field public email? string
@@ -89,8 +86,7 @@ local M = {}
 ---@alias render.md.table.Style 'full'|'normal'|'none'
 ---@alias render.md.table.Cell 'trimmed'|'padded'|'raw'|'overlay'
 
----@class (exact) render.md.UserPipeTable
----@field public enabled? boolean
+---@class (exact) render.md.UserPipeTable: render.md.UserBaseComponent
 ---@field public preset? render.md.table.Preset
 ---@field public style? render.md.table.Style
 ---@field public cell? render.md.table.Cell
@@ -102,8 +98,7 @@ local M = {}
 ---@field public row? string
 ---@field public filler? string
 
----@class (exact) render.md.UserQuote
----@field public enabled? boolean
+---@class (exact) render.md.UserQuote: render.md.UserBaseComponent
 ---@field public icon? string
 ---@field public repeat_linebreak? boolean
 ---@field public highlight? string
@@ -121,8 +116,7 @@ local M = {}
 
 ---@alias render.md.checkbox.Position 'overlay'|'inline'
 
----@class (exact) render.md.UserCheckbox
----@field public enabled? boolean
+---@class (exact) render.md.UserCheckbox: render.md.UserBaseComponent
 ---@field public position? render.md.checkbox.Position
 ---@field public unchecked? render.md.UserCheckboxComponent
 ---@field public checked? render.md.UserCheckboxComponent
@@ -133,16 +127,14 @@ local M = {}
 ---| string[][]
 ---| fun(level: integer, index: integer, value: string): string?
 
----@class (exact) render.md.UserBullet
----@field public enabled? boolean
+---@class (exact) render.md.UserBullet: render.md.UserBaseComponent
 ---@field public icons? render.md.bullet.Icons
 ---@field public ordered_icons? render.md.bullet.Icons
 ---@field public left_pad? integer
 ---@field public right_pad? integer
 ---@field public highlight? string
 
----@class (exact) render.md.UserDash
----@field public enabled? boolean
+---@class (exact) render.md.UserDash: render.md.UserBaseComponent
 ---@field public icon? string
 ---@field public width? 'full'|number
 ---@field public left_margin? number
@@ -153,8 +145,7 @@ local M = {}
 ---@alias render.md.code.Width 'full'|'block'
 ---@alias render.md.code.Border 'thin'|'thick'|'none'
 
----@class (exact) render.md.UserCode
----@field public enabled? boolean
+---@class (exact) render.md.UserCode: render.md.UserBaseComponent
 ---@field public sign? boolean
 ---@field public style? render.md.code.Style
 ---@field public position? render.md.code.Position
@@ -173,16 +164,14 @@ local M = {}
 ---@field public highlight_inline? string
 ---@field public highlight_language? string
 
----@class (exact) render.md.UserParagraph
----@field public enabled? boolean
+---@class (exact) render.md.UserParagraph: render.md.UserBaseComponent
 ---@field public left_margin? number
 ---@field public min_width? integer
 
 ---@alias render.md.heading.Position 'overlay'|'inline'|'right'
 ---@alias render.md.heading.Width 'full'|'block'
 
----@class (exact) render.md.UserHeading
----@field public enabled? boolean
+---@class (exact) render.md.UserHeading: render.md.UserBaseComponent
 ---@field public sign? boolean
 ---@field public position? render.md.heading.Position
 ---@field public icons? string[]

lua/render-markdown/state.lua

@@ -127,9 +127,15 @@ end
 
 ---@return string[]
 function M.validate()
+    ---@param component render.md.debug.ValidatorSpec
+    ---@return render.md.debug.ValidatorSpec
+    local function component_rules(component)
+        return component:type('enabled', 'boolean')
+    end
+
     ---@param buffer render.md.debug.ValidatorSpec
     ---@return render.md.debug.ValidatorSpec
-    local function add_buffer_rules(buffer)
+    local function buffer_rules(buffer)
         return buffer
             :type('enabled', 'boolean')
             :type({ 'max_file_size', 'debounce' }, 'number')
@@ -153,8 +159,8 @@ function M.validate()
                 padding:type('highlight', 'string'):check()
             end)
             :nested('heading', function(heading)
-                heading
-                    :type({ 'enabled', 'sign', 'border_virtual', 'border_prefix' }, 'boolean')
+                component_rules(heading)
+                    :type({ 'sign', 'border_virtual', 'border_prefix' }, 'boolean')
                     :type({ 'above', 'below' }, 'string')
                     :list('border', 'boolean', 'boolean')
                     :list({ 'left_margin', 'left_pad', 'right_pad', 'min_width' }, 'number', 'number')
@@ -164,10 +170,11 @@ function M.validate()
                     :check()
             end)
             :nested('paragraph', function(paragraph)
-                paragraph:type('enabled', 'boolean'):type({ 'left_margin', 'min_width' }, 'number'):check()
+                component_rules(paragraph):type({ 'left_margin', 'min_width' }, 'number'):check()
             end)
             :nested('code', function(code)
-                code:type({ 'enabled', 'sign', 'language_name' }, 'boolean')
+                component_rules(code)
+                    :type({ 'sign', 'language_name' }, 'boolean')
                     :type({ 'language_pad', 'left_margin', 'left_pad', 'right_pad', 'min_width' }, 'number')
                     :type({ 'above', 'below', 'highlight', 'highlight_inline' }, 'string')
                     :type('highlight_language', { 'string', 'nil' })
@@ -179,23 +186,21 @@ function M.validate()
                     :check()
             end)
             :nested('dash', function(dash)
-                dash:type('enabled', 'boolean')
+                component_rules(dash)
                     :type('left_margin', 'number')
                     :type({ 'icon', 'highlight' }, 'string')
                     :one_of('width', { 'full' }, 'number')
                     :check()
             end)
             :nested('bullet', function(bullet)
-                bullet
-                    :type('enabled', 'boolean')
+                component_rules(bullet)
                     :type({ 'left_pad', 'right_pad' }, 'number')
                     :type('highlight', 'string')
                     :list_or_list_of_list({ 'icons', 'ordered_icons' }, 'string', 'function')
                     :check()
             end)
             :nested('checkbox', function(checkbox)
-                checkbox
-                    :type('enabled', 'boolean')
+                component_rules(checkbox)
                     :one_of('position', { 'overlay', 'inline' })
                     :nested({ 'unchecked', 'checked' }, function(box)
                         box:type({ 'icon', 'highlight' }, 'string'):type('scope_highlight', { 'string', 'nil' }):check()
@@ -210,11 +215,13 @@ function M.validate()
                     :check()
             end)
             :nested('quote', function(quote)
-                quote:type({ 'enabled', 'repeat_linebreak' }, 'boolean'):type({ 'icon', 'highlight' }, 'string'):check()
+                component_rules(quote)
+                    :type('repeat_linebreak', 'boolean')
+                    :type({ 'icon', 'highlight' }, 'string')
+                    :check()
             end)
             :nested('pipe_table', function(pipe_table)
-                pipe_table
-                    :type('enabled', 'boolean')
+                component_rules(pipe_table)
                     :type({ 'padding', 'min_width' }, 'number')
                     :type({ 'alignment_indicator', 'head', 'row', 'filler' }, 'string')
                     :list('border', 'string')
@@ -234,7 +241,7 @@ function M.validate()
                     :check()
             end)
             :nested('link', function(link)
-                link:type('enabled', 'boolean')
+                component_rules(link)
                     :type({ 'image', 'email', 'hyperlink', 'highlight' }, 'string')
                     :nested('footnote', function(footnote)
                         footnote:type('superscript', 'boolean'):type({ 'prefix', 'suffix' }, 'string'):check()
@@ -255,19 +262,19 @@ function M.validate()
                     :check()
             end)
             :nested('sign', function(sign)
-                sign:type('enabled', 'boolean'):type('highlight', 'string'):check()
+                component_rules(sign):type('highlight', 'string'):check()
             end)
-            :nested('inline_highlight', function(sign)
-                sign:type('enabled', 'boolean'):type('highlight', 'string'):check()
+            :nested('inline_highlight', function(inline_highlight)
+                component_rules(inline_highlight):type('highlight', 'string'):check()
             end)
             :nested('indent', function(indent)
-                indent
-                    :type({ 'enabled', 'skip_heading' }, 'boolean')
+                component_rules(indent)
+                    :type('skip_heading', 'boolean')
                     :type({ 'per_level', 'skip_level' }, 'number')
                     :check()
             end)
             :nested('html', function(html)
-                html:type('enabled', 'boolean')
+                component_rules(html)
                     :nested('comment', function(comment)
                         comment
                             :type('conceal', 'boolean')
@@ -288,7 +295,7 @@ function M.validate()
 
     local validator = require('render-markdown.debug.validator').new()
 
-    add_buffer_rules(validator:spec(M.config, false))
+    buffer_rules(validator:spec(M.config, false))
         :type('log_runtime', 'boolean')
         :list('file_types', 'string')
         :one_of('preset', { 'none', 'lazy', 'obsidian' })
@@ -301,8 +308,7 @@ function M.validate()
                 :check()
         end)
         :nested('latex', function(latex)
-            latex
-                :type('enabled', 'boolean')
+            component_rules(latex)
                 :type({ 'top_pad', 'bottom_pad' }, 'number')
                 :type({ 'converter', 'highlight' }, 'string')
                 :check()
@@ -315,7 +321,7 @@ function M.validate()
                 :nested({ 'buftype', 'filetype' }, function(override)
                     override
                         :nested('ALL', function(buffer)
-                            add_buffer_rules(buffer):check()
+                            buffer_rules(buffer):check()
                         end, true)
                         :check()
                 end)