feat: include hightlight query files in checkhealth

## Details

Hightlight query files are now provided in output of the checkhealth
command, only really helpful to improve debugging issues for users.

Common issues around content not being concealed as expected arise from
users or plugins overwriting rather than extending.

Author: MeanderingProgrammer

doc/render-markdown.txt

@@ -1,4 +1,4 @@
-*render-markdown.txt*         For NVIM v0.11.1        Last change: 2025 May 12
+*render-markdown.txt*         For NVIM v0.11.1        Last change: 2025 May 19
 
 ==============================================================================
 Table of Contents                          *render-markdown-table-of-contents*

lua/render-markdown/health.lua

@@ -5,7 +5,7 @@ local state = require('render-markdown.state')
 local M = {}
 
 ---@private
-M.version = '8.4.1'
+M.version = '8.4.2'
 
 function M.check()
     M.start('version')
@@ -22,15 +22,21 @@ function M.check()
     end
 
     local config = state.get(0)
-    local latex, latex_advice = config.latex, M.disable_advice('latex')
-    local html, html_advice = config.html, M.disable_advice('html')
+    local latex = config.latex
+    local html = config.html
 
     M.start('treesitter')
-    M.check_parser('markdown', true)
-    M.check_parser('markdown_inline', true)
-    M.check_parser('latex', latex.enabled, latex_advice)
-    M.check_parser('html', html.enabled, html_advice)
-    M.check_highlight('markdown')
+    M.parser('markdown', true)
+    M.highlights('markdown')
+    M.highlighter('markdown')
+    M.parser('markdown_inline', true)
+    M.highlights('markdown_inline')
+    if latex.enabled then
+        M.parser('latex', false)
+    end
+    if html.enabled then
+        M.parser('html', false)
+    end
 
     M.start('icons')
     local provider = Icons.name()
@@ -41,12 +47,14 @@ function M.check()
     end
 
     M.start('executables')
-    M.check_executable(latex.converter, latex.enabled, latex_advice)
+    if latex.enabled then
+        M.executable(latex.converter, M.disable('latex'))
+    end
 
     M.start('conflicts')
-    M.check_plugin('headlines')
-    M.check_plugin('markview')
-    M.check_plugin('obsidian', function(obsidian)
+    M.plugin('headlines')
+    M.plugin('markview')
+    M.plugin('obsidian', function(obsidian)
         if obsidian.get_client().opts.ui.enable == false then
             return nil
         else
@@ -77,69 +85,66 @@ function M.neovim(min, rec)
     end
 end
 
----@private
----@param language string
----@return string[]
-function M.disable_advice(language)
-    local setup = "require('render-markdown').setup"
-    return {
-        ('disable %s support to avoid this warning'):format(language),
-        ('%s({ %s = { enabled = false } })'):format(setup, language),
-    }
-end
-
 ---@private
 ---@param language string
 ---@param required boolean
----@param advice? string[]
-function M.check_parser(language, required, advice)
-    local has_parser = pcall(vim.treesitter.get_parser, 0, language)
-    if has_parser then
+function M.parser(language, required)
+    local ok = pcall(vim.treesitter.get_parser, 0, language)
+    if ok then
         vim.health.ok(language .. ': parser installed')
     else
         local message = language .. ': parser not installed'
         if not required then
-            vim.health.ok(message)
-        elseif advice then
-            vim.health.warn(message, advice)
+            vim.health.warn(message, M.disable(language))
         else
             vim.health.error(message)
         end
     end
 end
 
 ---@private
----@param filetype string
-function M.check_highlight(filetype)
-    -- As nvim-treesitter is removing module support it cannot be used to check
+---@param language string
+function M.highlights(language)
+    local files = vim.treesitter.query.get_files(language, 'highlights')
+    if #files > 0 then
+        for _, file in ipairs(files) do
+            local path = vim.fn.fnamemodify(file, ':~')
+            vim.health.ok(language .. ': highlights ' .. path)
+        end
+    else
+        vim.health.error(language .. ': highlights missing')
+    end
+end
+
+---@private
+---@param language string
+function M.highlighter(language)
+    -- nvim-treesitter is removing module support so cannot be used to check
     -- if highlights are enabled, so we create a buffer and check the state
-    local bufnr = vim.api.nvim_create_buf(false, true)
-    vim.bo[bufnr].filetype = filetype
-    local has_highlighter = vim.treesitter.highlighter.active[bufnr] ~= nil
-    vim.api.nvim_buf_delete(bufnr, { force = true })
-    if has_highlighter then
-        vim.health.ok(filetype .. ': highlight enabled')
+    local buf = vim.api.nvim_create_buf(false, true)
+    vim.bo[buf].filetype = language
+    local ok = vim.treesitter.highlighter.active[buf] ~= nil
+    vim.api.nvim_buf_delete(buf, { force = true })
+    if ok then
+        vim.health.ok(language .. ': highlighter enabled')
     else
         -- TODO(1.0): update advice once module support is removed
-        vim.health.error(filetype .. ': highlight not enabled', {
-            'Enable the highlight module in your nvim-treesitter config',
+        vim.health.error(language .. ': highlighter not enabled', {
+            'enable the highlight module in your nvim-treesitter config',
             "require('nvim-treesitter.configs').setup({ highlight = { enable = true } })",
         })
     end
 end
 
 ---@private
 ---@param name string
----@param required boolean
 ---@param advice? string[]
-function M.check_executable(name, required, advice)
+function M.executable(name, advice)
     if vim.fn.executable(name) == 1 then
         vim.health.ok(name .. ': installed')
     else
         local message = name .. ': not installed'
-        if not required then
-            vim.health.ok(message)
-        elseif advice then
+        if advice then
             vim.health.warn(message, advice)
         else
             vim.health.error(message)
@@ -150,7 +155,7 @@ end
 ---@private
 ---@param name string
 ---@param validate? fun(plugin: any): string[]?
-function M.check_plugin(name, validate)
+function M.plugin(name, validate)
     local has_plugin, plugin = pcall(require, name)
     if not has_plugin then
         vim.health.ok(name .. ': not installed')
@@ -166,4 +171,15 @@ function M.check_plugin(name, validate)
     end
 end
 
+---@private
+---@param language string
+---@return string[]
+function M.disable(language)
+    local setup = "require('render-markdown').setup"
+    return {
+        ('disable %s support to avoid this warning'):format(language),
+        ('%s({ %s = { enabled = false } })'):format(setup, language),
+    }
+end
+
 return M

lua/render-markdown/render/markdown/checkbox.lua

@@ -79,39 +79,45 @@ end
 ---@private
 function Render:checkbox()
     local node = self.data.checkbox
+    local right = self.config.right_pad
+
+    -- add 1 to account for space after checkbox
+    local width = self.context:width(node) + 1
+    local space = width - Str.width(self.data.icon)
+
     local line = self:line():text(self.data.icon, self.data.highlight)
-    local space = self.context:width(node) + 1 - Str.width(self.data.icon)
-    local right_pad = self.config.right_pad
     if space < 0 then
         -- not enough space to fit the icon in-place
         self.marks:over('check_icon', node, {
-            virt_text = line:pad(right_pad):get(),
+            virt_text = line:pad(right):get(),
             virt_text_pos = 'inline',
             conceal = '',
         }, { 0, 0, 0, 1 })
     else
-        local fits = math.min(space, right_pad)
+        local fits = math.min(space, right)
         space = space - fits
-        right_pad = right_pad - fits
+        right = right - fits
+
         local row = node.start_row
         local start_col = node.start_col
         local end_col = node.end_col + 1
+
         self.marks:add('check_icon', row, start_col, {
             end_col = end_col - space,
             virt_text = line:pad(fits):get(),
             virt_text_pos = 'overlay',
         })
         if space > 0 then
-            -- hide extra space after the icon
+            -- remove extra space after the icon
             self.marks:add('check_icon', row, end_col - space, {
                 end_col = end_col,
                 conceal = '',
             })
         end
-        if right_pad > 0 then
+        if right > 0 then
             -- add padding
             self.marks:add('check_icon', row, end_col, {
-                virt_text = self:line():pad(right_pad):get(),
+                virt_text = self:line():pad(right):get(),
                 virt_text_pos = 'inline',
             })
         end

lua/render-markdown/render/markdown/heading.lua

@@ -115,23 +115,24 @@ end
 ---@private
 ---@return integer
 function Render:marker()
-    local icon, highlight = self.data.icon, {}
+    local icon = self.data.icon
+    local highlight = {} ---@type string[]
     if self.data.fg then
         highlight[#highlight + 1] = self.data.fg
     end
     if self.data.bg then
         highlight[#highlight + 1] = self.data.bg
     end
     if self.data.atx then
-        local marker = self.data.marker
-        -- add 1 to account for space after last `#`
-        local width = self.context:width(marker) + 1
+        local node = self.data.marker
+        -- add 1 to account for space after last '#'
+        local width = self.context:width(node) + 1
         if not icon or #highlight == 0 then
             return width
         end
         if self.config.position == 'right' then
-            self.marks:over(true, marker, { conceal = '' }, { 0, 0, 0, 1 })
-            self.marks:start('head_icon', marker, {
+            self.marks:over(true, node, { conceal = '' }, { 0, 0, 0, 1 })
+            self.marks:start('head_icon', node, {
                 priority = 1000,
                 virt_text = { { icon, highlight } },
                 virt_text_pos = 'eol',
@@ -140,14 +141,14 @@ function Render:marker()
         else
             local padding = width - Str.width(icon)
             if self.config.position == 'inline' or padding < 0 then
-                local added = self.marks:over('head_icon', marker, {
+                local added = self.marks:over('head_icon', node, {
                     virt_text = { { icon, highlight } },
                     virt_text_pos = 'inline',
                     conceal = '',
                 }, { 0, 0, 0, 1 })
                 return added and Str.width(icon) or width
             else
-                self.marks:over('head_icon', marker, {
+                self.marks:over('head_icon', node, {
                     virt_text = { { Str.pad(padding) .. icon, highlight } },
                     virt_text_pos = 'overlay',
                 })