chore(dev): allow the plugin to work with Lazy reload

## Details

Using `Lazy reload render-markdown.nvim` would be convenient for
development, however how lazy handles the reload results in any created
autocommands being deleted, which basically stops the plugin from
working.

To fix this we essentially need to re-run the plugin directory on
reload, which lazy does do, however the value of
`vim.g.loaded_render_markdown` persists which results in early termination.

To fix this use a lua variable, we'll call it enabled, which does
persist the value locally, but does get reverted back to `false` when
lazy does it's module unloading thing.

This will result in the autocommands being re-created solving the main
problem.

I've renamed the various `setup` functions to `init` to distinguish
better between initialization and configuration. The `log` module now
has an `init` and a `setup` function, with the autocommand being created
in the new `init` function.

Move all cache invalidation logic to `state` module, results in an even
more simplified `init` module and `state` is probably a more fitting
place for it.

Author: MeanderingProgrammer

demo/run.py

@@ -4,7 +4,7 @@
 
 from PIL import Image
 
-INFO: dict[str, tuple[int, str]] = dict(
+DEMOS: dict[str, tuple[int, str]] = dict(
     heading_code=(550, "## Heading 2"),
     list_table=(550, ""),
     box_dash_quote=(250, ""),
@@ -26,7 +26,7 @@ def create_gif(name: str, file: Path) -> None:
     if gif.exists():
         gif.unlink()
 
-    height, content = INFO[name]
+    height, content = DEMOS[name]
 
     tape = Path("demo/demo.tape")
     tape.write_text(tape_content(file, gif, height, content))
@@ -91,6 +91,6 @@ def get_move(file: Path) -> str:
 
 if __name__ == "__main__":
     parser = argparse.ArgumentParser(description="Generate a demo recording using vhs")
-    parser.add_argument("--name", type=str, required=True, choices=INFO.keys())
+    parser.add_argument("--name", type=str, required=True, choices=DEMOS.keys())
     args = parser.parse_args()
     main(args.name)

doc/render-markdown.txt

@@ -1,4 +1,4 @@
-*render-markdown.txt*           For 0.11.0          Last change: 2025 April 22
+*render-markdown.txt*           For 0.11.0          Last change: 2025 April 23
 
 ==============================================================================
 Table of Contents                          *render-markdown-table-of-contents*

lua/render-markdown/colors.lua

@@ -62,19 +62,19 @@ M.colors = {
     Error           = 'DiagnosticError',
 }
 
----Should only be called from plugin directory
-function M.setup()
-    -- Reload generated colors on color scheme change
-    vim.api.nvim_create_autocmd('ColorScheme', {
-        group = vim.api.nvim_create_augroup('RenderMarkdownColors', {}),
-        callback = M.reload,
-    })
+---called from plugin directory
+function M.init()
     for name, link in pairs(M.colors) do
         vim.api.nvim_set_hl(0, M.prefix .. name, {
             link = link,
             default = true,
         })
     end
+    -- reload generated colors on color scheme change
+    vim.api.nvim_create_autocmd('ColorScheme', {
+        group = vim.api.nvim_create_augroup('RenderMarkdownColors', {}),
+        callback = M.reload,
+    })
 end
 
 ---@private

lua/render-markdown/command.lua

@@ -9,8 +9,8 @@ M.name = 'RenderMarkdown'
 ---@private
 M.plugin = 'render-markdown.nvim'
 
----Should only be called from plugin directory
-function M.setup()
+---called from plugin directory
+function M.init()
     vim.api.nvim_create_user_command(M.name, M.command, {
         nargs = '*',
         desc = M.plugin .. ' commands',

lua/render-markdown/core/log.lua

@@ -7,27 +7,31 @@ local Env = require('render-markdown.lib.env')
 ---@field message string
 
 ---@class render.md.Log
+---@field private file string
 ---@field private level render.md.config.LogLevel
 ---@field private entries render.md.log.Entry[]
----@field private file string
 local M = {}
 
----Should only be called from state on setup
----@param level render.md.config.LogLevel
-function M.setup(level)
-    -- Write out any logs before closing
+---called from plugin directory
+function M.init()
+    -- typically resolves to ~/.local/state/nvim/render-markdown.log
+    M.file = vim.fn.stdpath('state') .. '/render-markdown.log'
+    -- clear the file contents if it is too big
+    if Env.file_size_mb(M.file) > 5 then
+        assert(io.open(M.file, 'w')):close()
+    end
+    -- write out any logs before closing
     vim.api.nvim_create_autocmd('VimLeave', {
         group = vim.api.nvim_create_augroup('RenderMarkdownLog', {}),
         callback = M.flush,
     })
+end
+
+---called from state on setup
+---@param level render.md.config.LogLevel
+function M.setup(level)
     M.level = level
     M.entries = {}
-    -- Typically resolves to ~/.local/state/nvim/render-markdown.log
-    M.file = vim.fn.stdpath('state') .. '/render-markdown.log'
-    -- Clear the file contents if it is too big
-    if Env.file_size_mb(M.file) > 5 then
-        assert(io.open(M.file, 'w')):close()
-    end
 end
 
 function M.open()

lua/render-markdown/health.lua

@@ -5,7 +5,7 @@ local state = require('render-markdown.state')
 local M = {}
 
 ---@private
-M.version = '8.3.5'
+M.version = '8.3.6'
 
 function M.check()
     M.start('version')

lua/render-markdown/init.lua

@@ -43,6 +43,7 @@ local M = {}
 ---@field win_options table<string, render.md.window.Config>
 
 ---@private
+---@type boolean
 M.initialized = false
 
 ---@type render.md.Config
@@ -713,10 +714,7 @@ function M.setup(opts)
         return
     end
     M.initialized = true
-
     require('render-markdown.state').setup(opts or {})
-    require('render-markdown.state').invalidate_cache()
-    require('render-markdown.core.ui').invalidate_cache()
 end
 
 return setmetatable(M, {

lua/render-markdown/integ/blink.lua

@@ -40,29 +40,29 @@ function Source:get_completions(context, callback)
 end
 
 ---@class render.md.integ.Blink
----@field private id string
----@field private registered boolean
-local M = {
-    id = 'markdown',
-    registered = false,
-}
+local M = {}
 
----Should only be called from manager on initial buffer attach
+---@private
+---@type boolean
+M.initialized = false
+
+---called from manager on buffer attach
 function Source.setup()
-    if M.registered then
+    if M.initialized then
         return
     end
-    M.registered = true
+    M.initialized = true
     local has_blink, blink = pcall(require, 'blink.cmp')
     if not has_blink or blink == nil then
         return
     end
-    pcall(blink.add_source_provider, M.id, {
+    local id = 'markdown'
+    pcall(blink.add_source_provider, id, {
         name = 'RenderMarkdown',
         module = 'render-markdown.integ.blink',
     })
     for _, file_type in ipairs(state.file_types) do
-        pcall(blink.add_filetype_source, file_type, M.id)
+        pcall(blink.add_filetype_source, file_type, id)
     end
 end
 

lua/render-markdown/integ/cmp.lua

@@ -30,17 +30,18 @@ function Source:complete(params, callback)
 end
 
 ---@class render.md.integ.Cmp
----@field private registered boolean
-local M = {
-    registered = false,
-}
+local M = {}
 
----Should only be called from manager on initial buffer attach
+---@private
+---@type boolean
+M.initialized = false
+
+---called from manager on buffer attach
 function M.setup()
-    if M.registered then
+    if M.initialized then
         return
     end
-    M.registered = true
+    M.initialized = true
     local has_cmp, cmp = pcall(require, 'cmp')
     if not has_cmp or cmp == nil then
         return

lua/render-markdown/integ/coq.lua

@@ -1,18 +1,18 @@
 local source = require('render-markdown.integ.source')
 
 ---@class render.md.cmp.Coq
----@field private registered boolean
-local M = {
-    registered = false,
-}
+local M = {}
 
----Should only be called from manager on initial buffer attach
----or by a user to enable the integration
+---@private
+---@type boolean
+M.initialized = false
+
+---called from manager on buffer attach or directly by user
 function M.setup()
-    if M.registered then
+    if M.initialized then
         return
     end
-    M.registered = true
+    M.initialized = true
     local has_coq = pcall(require, 'coq')
     if not has_coq then
         return