Skip debounce when <= 0

## Details

Main functional change is to directly skip debounce when it is set to 0.
This should be the behavior when using timers anyway but this makes it a
more obvious behavior.

Also adds a check for vim.uv and falls back to vim.loop when checking
file size.

Minor other change, add a `log_runtime` option to allow us to print
runtime of update function. Easier to see performance changes when
developing if they just get printed. Users are welcome to it as well if
they are curious.

Author: MeanderingProgrammer

README.md

@@ -193,6 +193,9 @@ require('render-markdown').setup({
     -- The level of logs to write to file: vim.fn.stdpath('state') .. '/render-markdown.log'
     -- Only intended to be used for plugin development / debugging
     log_level = 'error',
+    -- Print runtime of main update method
+    -- Only intended to be used for plugin development / debugging
+    log_runtime = false,
     -- Filetypes this plugin will run on
     file_types = { 'markdown' },
     -- Out of the box language injections for known filetypes that allow markdown to be

benches/util.lua

@@ -34,11 +34,11 @@ function M.insert_mode()
 end
 
 ---@private
----@param f fun()
+---@param callback fun()
 ---@return number
-function M.time(f)
+function M.time(callback)
     local start = vim.uv.hrtime()
-    f()
+    callback()
     vim.wait(0)
     return (vim.uv.hrtime() - start) / 1e+6
 end

doc/render-markdown.txt

@@ -1,4 +1,4 @@
-*render-markdown.txt*         For 0.10.0        Last change: 2024 September 26
+*render-markdown.txt*         For 0.10.0        Last change: 2024 September 27
 
 ==============================================================================
 Table of Contents                          *render-markdown-table-of-contents*
@@ -241,6 +241,9 @@ Default Configuration ~
         -- The level of logs to write to file: vim.fn.stdpath('state') .. '/render-markdown.log'
         -- Only intended to be used for plugin development / debugging
         log_level = 'error',
+        -- Print runtime of main update method
+        -- Only intended to be used for plugin development / debugging
+        log_runtime = false,
         -- Filetypes this plugin will run on
         file_types = { 'markdown' },
         -- Out of the box language injections for known filetypes that allow markdown to be

lua/render-markdown/core/ui.lua

@@ -81,14 +81,20 @@ function M.debounce_update(buf, win, event, change)
 
     local config, buffer_state = state.get(buf), Cache.get(buf)
 
-    if not change and Context.contains_range(buf, win) then
-        vim.schedule(function()
-            M.update(buf, win, false)
-        end)
+    -- Need to parse when things change or we have not parsed the visible range yet
+    local parse = change or not Context.contains_range(buf, win)
+
+    local update = function()
+        M.update(buf, win, parse)
+    end
+    if parse and state.log_runtime then
+        update = util.wrap_runtime(update)
+    end
+
+    if parse and config.debounce > 0 then
+        buffer_state:debounce(config.debounce, update)
     else
-        buffer_state:debounce(config.debounce, function()
-            M.update(buf, win, true)
-        end)
+        vim.schedule(update)
     end
 end
 

lua/render-markdown/core/util.lua

@@ -90,12 +90,23 @@ end
 ---@return number
 function M.file_size_mb(file)
     local ok, stats = pcall(function()
-        return vim.uv.fs_stat(file)
+        return (vim.uv or vim.loop).fs_stat(file)
     end)
     if not (ok and stats) then
         return 0
     end
     return stats.size / (1024 * 1024)
 end
 
+---@param callback fun()
+---@return fun()
+function M.wrap_runtime(callback)
+    return function()
+        local start_time = (vim.uv or vim.loop).hrtime()
+        callback()
+        local end_time = (vim.uv or vim.loop).hrtime()
+        vim.print(string.format('Runtime (ms): %.1f', (end_time - start_time) / 1e+6))
+    end
+end
+
 return M

lua/render-markdown/health.lua

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

lua/render-markdown/init.lua

@@ -188,6 +188,7 @@ local M = {}
 ---@field public markdown_quote_query? string
 ---@field public inline_query? string
 ---@field public log_level? render.md.config.LogLevel
+---@field public log_runtime? boolean
 ---@field public file_types? string[]
 ---@field public injections? table<string, render.md.UserInjection>
 ---@field public latex? render.md.UserLatex
@@ -264,6 +265,9 @@ M.default_config = {
     -- The level of logs to write to file: vim.fn.stdpath('state') .. '/render-markdown.log'
     -- Only intended to be used for plugin development / debugging
     log_level = 'error',
+    -- Print runtime of main update method
+    -- Only intended to be used for plugin development / debugging
+    log_runtime = false,
     -- Filetypes this plugin will run on
     file_types = { 'markdown' },
     -- Out of the box language injections for known filetypes that allow markdown to be

lua/render-markdown/state.lua

@@ -10,6 +10,7 @@ local configs = {}
 ---@class render.md.State
 ---@field private config render.md.Config
 ---@field enabled boolean
+---@field log_runtime boolean
 ---@field file_types string[]
 ---@field latex render.md.Latex
 ---@field custom_handlers table<string, render.md.Handler>
@@ -42,6 +43,7 @@ function M.setup(default_config, user_config)
 
     M.config = config
     M.enabled = config.enabled
+    M.log_runtime = config.log_runtime
     M.file_types = config.file_types
     M.latex = config.latex
     M.custom_handlers = config.custom_handlers
@@ -245,6 +247,7 @@ function M.validate()
         :type({ 'anti_conceal', 'padding', 'heading', 'code', 'dash', 'bullet', 'checkbox' }, 'table')
         :type({ 'quote', 'pipe_table', 'callout', 'link', 'sign', 'indent', 'win_options' }, 'table')
         :list('render_modes', 'string', 'boolean')
+        :type('log_runtime', 'boolean')
         :type({ 'markdown_query', 'markdown_quote_query', 'inline_query' }, 'string')
         :type({ 'injections', 'latex', 'overrides', 'custom_handlers' }, 'table')
         :list('file_types', 'string')

lua/render-markdown/types.lua

@@ -160,6 +160,7 @@
 ---@field public markdown_quote_query string
 ---@field public inline_query string
 ---@field public log_level render.md.config.LogLevel
+---@field public log_runtime boolean
 ---@field public file_types string[]
 ---@field public injections table<string, render.md.Injection>
 ---@field public latex render.md.Latex