feat: add error log for missing parser, include buffer in logs

Author: MeanderingProgrammer

lua/render-markdown/core/log.lua

@@ -50,6 +50,13 @@ function M.unhandled_type(language, group, value)
     M.error('unhandled type', string.format('%s -> %s -> %s', language, group, value))
 end
 
+---@param name string
+---@param buf integer
+---@param ... any
+function M.debug_buf(name, buf, ...)
+    M.debug(string.format('%s %d', name, buf), ...)
+end
+
 ---@param name string
 ---@param ... any
 function M.debug(name, ...)
@@ -58,6 +65,13 @@ function M.debug(name, ...)
     end
 end
 
+---@param name string
+---@param buf integer
+---@param ... any
+function M.error_buf(name, buf, ...)
+    M.error(string.format('%s %d', name, buf), ...)
+end
+
 ---@param name string
 ---@param ... any
 function M.error(name, ...)

lua/render-markdown/core/ui.lua

@@ -53,8 +53,10 @@ end
 
 ---@param buf integer
 ---@param win integer
+---@param event string
 ---@param change boolean
-function M.debounce_update(buf, win, change)
+function M.debounce_update(buf, win, event, change)
+    log.debug_buf('update', buf, string.format('event %s', event), string.format('change %s', change))
     if not util.valid(buf, win) then
         return
     end
@@ -132,16 +134,15 @@ end
 function M.parse_buffer(buf, win)
     local has_parser, parser = pcall(vim.treesitter.get_parser, buf)
     if not has_parser then
+        log.error_buf('fail', buf, 'no treesitter parser found')
         return {}
     end
     -- Reset buffer context
     Context.reset(buf, win)
     -- Make sure injections are processed
     parser:parse(Context.get(buf):range())
-    -- Parse marks
-    local marks = {}
     -- Parse markdown after all other nodes to take advantage of state
-    local markdown_roots = {}
+    local marks, markdown_roots = {}, {}
     parser:for_each_tree(function(tree, language_tree)
         local language = language_tree:lang()
         if language == 'markdown' then
@@ -166,23 +167,23 @@ end
 ---@param root TSNode
 ---@return render.md.Mark[]
 function M.parse_tree(buf, language, root)
-    log.debug('language', language)
+    log.debug_buf('language', buf, language)
     if not Context.get(buf):contains_node(root) then
         return {}
     end
 
     local marks = {}
     local user = state.custom_handlers[language]
     if user ~= nil then
-        log.debug('running handler', 'user')
+        log.debug_buf('running handler', buf, 'user')
         vim.list_extend(marks, user.parse(root, buf))
         if not user.extends then
             return marks
         end
     end
     local builtin = builtin_handlers[language]
     if builtin ~= nil then
-        log.debug('running handler', 'builtin')
+        log.debug_buf('running handler', buf, 'builtin')
         vim.list_extend(marks, builtin.parse(root, buf))
     end
     return marks

lua/render-markdown/health.lua

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

lua/render-markdown/manager.lua

@@ -24,11 +24,11 @@ function M.setup()
     -- Window resizing is not buffer specific so is managed more globablly
     vim.api.nvim_create_autocmd('WinResized', {
         group = M.group,
-        callback = function()
+        callback = function(args)
             for _, win in ipairs(vim.v.event.windows) do
                 local buf = vim.fn.winbufnr(win)
                 if vim.tbl_contains(buffers, buf) then
-                    ui.debounce_update(buf, win, true)
+                    ui.debounce_update(buf, win, args.event, true)
                 end
             end
         end,
@@ -46,7 +46,7 @@ function M.set_all(enabled)
     M.attach(vim.api.nvim_get_current_buf())
     state.enabled = enabled
     for _, buf in ipairs(buffers) do
-        ui.debounce_update(buf, vim.fn.bufwinid(buf), true)
+        ui.debounce_update(buf, vim.fn.bufwinid(buf), 'UserCommand', true)
     end
 end
 
@@ -67,9 +67,9 @@ function M.attach(buf)
         group = M.group,
         buffer = buf,
         callback = function(args)
-            local win = vim.api.nvim_get_current_win()
+            local event, win = args.event, vim.api.nvim_get_current_win()
             if buf == vim.fn.winbufnr(win) then
-                ui.debounce_update(buf, win, vim.tbl_contains(change_events, args.event))
+                ui.debounce_update(buf, win, event, vim.tbl_contains(change_events, event))
             end
         end,
     })
@@ -80,33 +80,35 @@ end
 ---@return boolean
 function M.should_attach(buf)
     local file = vim.api.nvim_buf_get_name(buf)
-    local log_name = 'attach ' .. vim.fn.fnamemodify(file, ':t')
-    log.debug(log_name, 'start')
+    local log_name = string.format('attach %s', vim.fn.fnamemodify(file, ':t'))
+    log.debug_buf(log_name, buf, 'start')
 
     if vim.tbl_contains(buffers, buf) then
-        log.debug(log_name, 'skip', 'already attached')
+        log.debug_buf(log_name, buf, 'skip', 'already attached')
         return false
     end
 
     local file_type, file_types = util.get_buf(buf, 'filetype'), state.file_types
     if not vim.tbl_contains(file_types, file_type) then
-        log.debug(log_name, 'skip', 'file type', string.format('%s /∈ %s', file_type, vim.inspect(file_types)))
+        local reason = string.format('%s /∈ %s', file_type, vim.inspect(file_types))
+        log.debug_buf(log_name, buf, 'skip', 'file type', reason)
         return false
     end
 
     local config = state.get_config(buf)
     if not config.enabled then
-        log.debug(log_name, 'skip', 'state disabled')
+        log.debug_buf(log_name, buf, 'skip', 'state disabled')
         return false
     end
 
     local file_size, max_file_size = util.file_size_mb(file), config.max_file_size
     if file_size > max_file_size then
-        log.debug(log_name, 'skip', 'file size', string.format('%f > %f', file_size, max_file_size))
+        local reason = string.format('%f > %f', file_size, max_file_size)
+        log.debug_buf(log_name, buf, 'skip', 'file size', reason)
         return false
     end
 
-    log.debug(log_name, 'success')
+    log.debug_buf(log_name, buf, 'success')
     table.insert(buffers, buf)
     return true
 end