feat(dev): add profiler to get render time data

## Details

Add profiler module that wraps the main `refresh` method where
all rendering logic lives.

This only tracks info if the `profile` field has been set to true,
which should only be the case for myself but I guess others can
if they would like, could help debug performance issues in the
future.

Tracks runtime in milliseconds of the various different kind of
possible refreshes, i.e. movement vs full parse at a buffer level.

Add an api called stats that processes the runtime data and outputs
some basic info (min, max, mean) to `stats.json` in whatever directory
I'm currently in.

May add a benchmark suite to use this in the future, currently it
is to help me get a baseline of where we're at.

Other unrelated change to types to define classes directly on tables
rather than defining a class and adding it to a table.

Author: MeanderingProgrammer

.gitignore

@@ -1,5 +1,6 @@
 *.cast
 *.gif
+*.json
 medium.md
 large.md
 test.md

README.md

@@ -114,6 +114,8 @@ Some of the more useful fields are discussed further down.
 require('render-markdown').setup({
     -- Whether Markdown should be rendered by default or not
     enabled = true,
+    -- Whether to track performance metrics, should only be used for development
+    profile = false,
     -- Maximum file size (in MB) that this plugin will attempt to render
     -- Any file larger than this will effectively be ignored
     max_file_size = 1.5,

doc/render-markdown.txt

@@ -144,6 +144,8 @@ Full Default Configuration ~
     require('render-markdown').setup({
         -- Whether Markdown should be rendered by default or not
         enabled = true,
+        -- Whether to track performance metrics, should only be used for development
+        profile = false,
         -- Maximum file size (in MB) that this plugin will attempt to render
         -- Any file larger than this will effectively be ignored
         max_file_size = 1.5,

lua/render-markdown/api.lua

@@ -1,4 +1,5 @@
 local manager = require('render-markdown.manager')
+local profiler = require('render-markdown.profiler')
 local state = require('render-markdown.state')
 
 ---@class render.md.Api
@@ -16,4 +17,8 @@ function M.toggle()
     manager.set_all(not state.enabled)
 end
 
+function M.stats()
+    profiler.dump_stats()
+end
+
 return M

lua/render-markdown/colors.lua

@@ -1,8 +1,6 @@
 ---@class render.md.ColorCache
----@field highlights string[]
-
----@type render.md.ColorCache
 local cache = {
+    ---@type string[]
     highlights = {},
 }
 

lua/render-markdown/handler/latex.lua

@@ -3,10 +3,8 @@ local state = require('render-markdown.state')
 local ts = require('render-markdown.ts')
 
 ---@class render.md.LatexCache
----@field expressions table<string, string[]>
-
----@type render.md.LatexCache
 local cache = {
+    ---@type table<string, string[]>
     expressions = {},
 }
 

lua/render-markdown/init.lua

@@ -107,6 +107,7 @@ local M = {}
 
 ---@class render.md.UserConfig
 ---@field public enabled? boolean
+---@field public profile? boolean
 ---@field public max_file_size? number
 ---@field public markdown_query? string
 ---@field public markdown_quote_query? string
@@ -136,6 +137,8 @@ local M = {}
 M.default_config = {
     -- Whether Markdown should be rendered by default or not
     enabled = true,
+    -- Whether to track performance metrics, should only be used for development
+    profile = false,
     -- Maximum file size (in MB) that this plugin will attempt to render
     -- Any file larger than this will effectively be ignored
     max_file_size = 1.5,

lua/render-markdown/logger.lua

@@ -20,8 +20,8 @@ end
 ---@field message string
 
 ---@class render.md.Log
----@field entries render.md.LogEntry[]
 local log = {
+    ---@type render.md.LogEntry[]
     entries = {},
 }
 

lua/render-markdown/manager.lua

@@ -3,10 +3,8 @@ local ui = require('render-markdown.ui')
 local util = require('render-markdown.util')
 
 ---@class render.md.manager.Data
----@field buffers integer[]
-
----@type render.md.manager.Data
 local data = {
+    ---@type integer[]
     buffers = {},
 }
 

lua/render-markdown/profiler.lua

@@ -0,0 +1,84 @@
+local util = require('render-markdown.util')
+
+---@class render.md.OutputResultStat
+---@field n integer
+---@field min number
+---@field max number
+---@field sum number
+---@field mean number
+
+---@class render.md.OutputStat
+---@field path string
+---@field size number
+---@field results table<string, render.md.OutputResultStat>
+
+---buffer -> result_state -> times
+---@type table<integer, table<string, number[]>>
+local stats = {}
+
+---@class render.md.Profiler
+local M = {}
+
+---@param buf integer
+---@param f fun(): string
+function M.profile(buf, f)
+    local start_ns = vim.uv.hrtime()
+    local result = f()
+    local time = (vim.uv.hrtime() - start_ns) / 1e+6
+
+    if stats[buf] == nil then
+        stats[buf] = {}
+    end
+    local buf_stats = stats[buf]
+    if buf_stats[result] == nil then
+        buf_stats[result] = {}
+    end
+    local times = buf_stats[result]
+    table.insert(times, time)
+end
+
+function M.dump_stats()
+    local output_stats = {}
+    for buf, buf_stats in pairs(stats) do
+        local results = {}
+        for name, times in pairs(buf_stats) do
+            results[name] = M.compute_stats(times)
+        end
+        ---@type render.md.OutputStat
+        local output_stat = {
+            path = util.file_path(buf),
+            size = util.file_size_mb(buf),
+            results = results,
+        }
+        table.insert(output_stats, output_stat)
+    end
+    if #output_stats > 0 then
+        local file = assert(io.open('stats.json', 'w'))
+        file:write(vim.fn.json_encode(output_stats))
+        file:close()
+    end
+end
+
+---@private
+---@param times number[]
+---@return render.md.OutputResultStat
+function M.compute_stats(times)
+    local min = times[1]
+    local max = 0
+    local sum = 0
+    for _, time in ipairs(times) do
+        min = math.min(min, time)
+        max = math.max(max, time)
+        sum = sum + time
+    end
+    ---@type render.md.OutputResultStat
+    return {
+        n = #times,
+        min = min,
+        max = max,
+        sum = sum,
+        mean = sum / #times,
+    }
+end
+
+return M