feat: conceal html comments

## Details

Request: #244

Use `html` parser to find and conceal comment nodes.

Author: MeanderingProgrammer

README.md

@@ -53,6 +53,8 @@ Plugin to improve viewing Markdown files in Neovim
     Used to parse `markdown` files
   - [latex](https://github.com/latex-lsp/tree-sitter-latex) (Optional):
     Used to get `LaTeX` blocks from `markdown` files
+  - [html](https://github.com/tree-sitter/tree-sitter-html) (Optional):
+    Used to conceal `HTML` comments
 - Icon provider plugin (Optional): Used for icon above code blocks
   - [mini.icons](https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-icons.md)
   - [nvim-web-devicons](https://github.com/nvim-tree/nvim-web-devicons)
@@ -202,6 +204,12 @@ require('render-markdown').setup({
         -- Amount of empty lines below LaTeX blocks
         bottom_pad = 0,
     },
+    html = {
+        -- Turn on / off all HTML rendering
+        enabled = true,
+        -- Whether HTML comments should be concealed or not
+        conceal_comments = true,
+    },
     on = {
         -- Called when plugin initially attaches to a buffer
         attach = function() end,

benches/readme_spec.lua

@@ -4,7 +4,7 @@ local util = require('benches.util')
 
 describe('README.md', function()
     it('default', function()
-        local base_marks = 114
+        local base_marks = 115
         util.less_than(util.setup('README.md'), 60)
         util.num_marks(base_marks)
 

doc/render-markdown.txt

@@ -1,4 +1,4 @@
-*render-markdown.txt*         For 0.10.0         Last change: 2024 December 03
+*render-markdown.txt*         For 0.10.0         Last change: 2024 December 04
 
 ==============================================================================
 Table of Contents                          *render-markdown-table-of-contents*
@@ -75,6 +75,8 @@ Plugin to improve viewing Markdown files in Neovim
         Used to parse `markdown` files
     - latex <https://github.com/latex-lsp/tree-sitter-latex> (Optional):
         Used to get `LaTeX` blocks from `markdown` files
+    - html <https://github.com/tree-sitter/tree-sitter-html> (Optional):
+        Used to conceal `HTML` comments
 - Icon provider plugin (Optional): Used for icon above code blocks
     - mini.icons <https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-icons.md>
     - nvim-web-devicons <https://github.com/nvim-tree/nvim-web-devicons>
@@ -249,6 +251,12 @@ Default Configuration ~
             -- Amount of empty lines below LaTeX blocks
             bottom_pad = 0,
         },
+        html = {
+            -- Turn on / off all HTML rendering
+            enabled = true,
+            -- Whether HTML comments should be concealed or not
+            conceal_comments = true,
+        },
         on = {
             -- Called when plugin initially attaches to a buffer
             attach = function() end,

lua/render-markdown/core/ui.lua

@@ -8,9 +8,10 @@ local util = require('render-markdown.core.util')
 
 ---@type table<string, render.md.Handler>
 local builtin_handlers = {
+    html = require('render-markdown.handler.html'),
+    latex = require('render-markdown.handler.latex'),
     markdown = require('render-markdown.handler.markdown'),
     markdown_inline = require('render-markdown.handler.markdown_inline'),
-    latex = require('render-markdown.handler.latex'),
 }
 
 ---@class render.md.cache.Ui
@@ -69,6 +70,7 @@ function M.clear(buf, buffer_state)
     buffer_state:set_marks(nil)
 end
 
+---Used directly by fzf-lua: https://github.com/ibhagwan/fzf-lua/blob/main/lua/fzf-lua/previewer/builtin.lua
 ---@param buf integer
 ---@param win integer
 ---@param event string

lua/render-markdown/handler/html.lua

@@ -0,0 +1,49 @@
+local Context = require('render-markdown.core.context')
+local List = require('render-markdown.lib.list')
+local state = require('render-markdown.state')
+local treesitter = require('render-markdown.core.treesitter')
+
+---@class render.md.handler.buf.Html
+---@field private config render.md.Html
+---@field private context render.md.Context
+---@field private marks render.md.Marks
+---@field private query vim.treesitter.Query
+local Handler = {}
+Handler.__index = Handler
+
+---@param buf integer
+---@return render.md.handler.buf.Html
+function Handler.new(buf)
+    local self = setmetatable({}, Handler)
+    self.config = state.html
+    self.context = Context.get(buf)
+    self.marks = List.new_marks(buf, true)
+    self.query = treesitter.parse('html', '(comment) @comment')
+    return self
+end
+
+---@param root TSNode
+---@return render.md.Mark[]
+function Handler:parse(root)
+    if self.config.enabled and self.config.conceal_comments then
+        self.context:query(root, self.query, function(capture, node)
+            assert(capture == 'comment', 'Unhandled html capture: ' .. capture)
+            self.marks:add_over(true, node, {
+                conceal = '',
+            })
+        end)
+    end
+    return self.marks:get()
+end
+
+---@class render.md.handler.Html: render.md.Handler
+local M = {}
+
+---@param root TSNode
+---@param buf integer
+---@return render.md.Mark[]
+function M.parse(root, buf)
+    return Handler.new(buf):parse(root)
+end
+
+return M

lua/render-markdown/health.lua

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

lua/render-markdown/init.lua

@@ -14,6 +14,10 @@ local M = {}
 ---@class (exact) render.md.UserCallback
 ---@field public attach? fun(buf: integer)
 
+---@class (exact) render.md.UserHtml
+---@field public enabled? boolean
+---@field public conceal_comments? boolean
+
 ---@class (exact) render.md.UserLatex
 ---@field public enabled? boolean
 ---@field public converter? string
@@ -248,6 +252,7 @@ local M = {}
 ---@field public file_types? string[]
 ---@field public injections? table<string, render.md.UserInjection>
 ---@field public latex? render.md.UserLatex
+---@field public html? render.md.UserHtml
 ---@field public on? render.md.UserCallback
 ---@field public overrides? render.md.UserConfigOverrides
 ---@field public custom_handlers? table<string, render.md.Handler>
@@ -326,6 +331,12 @@ M.default_config = {
         -- Amount of empty lines below LaTeX blocks
         bottom_pad = 0,
     },
+    html = {
+        -- Turn on / off all HTML rendering
+        enabled = true,
+        -- Whether HTML comments should be concealed or not
+        conceal_comments = true,
+    },
     on = {
         -- Called when plugin initially attaches to a buffer
         attach = function() end,

lua/render-markdown/state.lua

@@ -13,6 +13,7 @@ local configs = {}
 ---@field log_runtime boolean
 ---@field file_types string[]
 ---@field latex render.md.Latex
+---@field html render.md.Html
 ---@field on render.md.Callback
 ---@field custom_handlers table<string, render.md.Handler>
 local M = {}
@@ -45,6 +46,7 @@ function M.setup(default_config, user_config)
     M.log_runtime = config.log_runtime
     M.file_types = config.file_types
     M.latex = config.latex
+    M.html = config.html
     M.on = config.on
     M.custom_handlers = config.custom_handlers
     log.setup(config.log_level)
@@ -294,6 +296,9 @@ function M.validate()
                 :type({ 'converter', 'highlight' }, 'string')
                 :check()
         end)
+        :nested('html', function(html)
+            html:type({ 'enabled', 'conceal_comments' }, 'boolean'):check()
+        end)
         :nested('on', function(on)
             on:type('attach', 'function'):check()
         end)

lua/render-markdown/types.lua

@@ -3,6 +3,10 @@
 ---@class (exact) render.md.Callback
 ---@field public attach fun(buf: integer)
 
+---@class (exact) render.md.Html
+---@field public enabled boolean
+---@field public conceal_comments boolean
+
 ---@class (exact) render.md.Latex
 ---@field public enabled boolean
 ---@field public converter string
@@ -199,6 +203,7 @@
 ---@field public file_types string[]
 ---@field public injections table<string, render.md.Injection>
 ---@field public latex render.md.Latex
+---@field public html render.md.Html
 ---@field public on render.md.Callback
 ---@field public overrides render.md.ConfigOverrides
 ---@field public custom_handlers table<string, render.md.Handler>

tests/ad_hoc_spec.lua

@@ -101,6 +101,7 @@ describe('ad_hoc.md', function()
         vim.list_extend(expected, {
             util.bullet(row:increment(), 0, 1),
             link(row:get(), 16, 25, '¹ ᴵⁿᶠᵒ', 'Link', ''),
+            util.conceal(row:increment(2), 0, 16),
             link(row:increment(2), 0, 9, '¹ ᴵⁿᶠᵒ', 'Link', ''),
         })
 
@@ -119,7 +120,9 @@ describe('ad_hoc.md', function()
             '   12 ● 󰗃 Youtube Link',
             '   13 ● Footnote Link ¹ ᴵⁿᶠᵒ',
             '   14',
-            '   15 ¹ ᴵⁿᶠᵒ: Some Info',
+            '   15',
+            '   16',
+            '   17 ¹ ᴵⁿᶠᵒ: Some Info',
         })
     end)
 end)

tests/data/ad_hoc.md

@@ -12,4 +12,6 @@ Heading 2 Line 2
 - [Youtube Link](https://www.youtube.com/watch?v=dQw4w9WgXcQ)
 - Footnote Link [^1 Info]
 
+<!-- comment -->
+
 [^1 Info]: Some Info