fix: Setting custom configuration for vim-plug

## Details

Bug report: #111

After the transition to initialization through the plugin directory we
essentially made the plugin configuration dependent on initialization
order. Whichever thing happens to call the setup function last
determines the configuration.

This works for plugin managers like lazy.nvim since the plugin directory
is run before the user calls setup, so user settings will override the default.

However this is not the case for vim-plug which runs setup before the plugin
directory. Side not, I believe this is the way neovim is meant to work and
lazy.nvim / other managers change this ordering.

To fix this I have modified the main setup function to pick up the last
non empty configuration.

That way if plugin first runs like with lazy.nvim any later calls to setup
by the user will override the configuration, there is no need to re-initialize
if an empty configuration is supplied.

Now if setup runs first it'll initialize the state and since the plugin
directory provides an empty configuration it will be skipped instead of
overwriting the user supplied configuration.

Author: MeanderingProgrammer

CHANGELOG.md

@@ -26,6 +26,14 @@
   [345596b](https://github.com/MeanderingProgrammer/markdown.nvim/commit/345596bb6ef2b0c0a145c59906c2e84dbddfbbd4)
 - Pre-compute concealed data once per parse cycle [fcd908b](https://github.com/MeanderingProgrammer/markdown.nvim/commit/fcd908bafb96e4a30abe7bf8f502790b93ea85ac)
   [3bdae40](https://github.com/MeanderingProgrammer/markdown.nvim/commit/3bdae400e079a834ae12b658bf1115abf206bb4c)
+- Improve table parsing performance by storing state [4d046cd](https://github.com/MeanderingProgrammer/markdown.nvim/commit/4d046cdf65393a62c0eb209e01574b39f28bc01b)
+- Improve performance of showing / hiding marks by storing mark id [ef0c921](https://github.com/MeanderingProgrammer/markdown.nvim/commit/ef0c921858cbe079d40304200af60b6ce0c99429)
+- Hide code block background based on language [#110](https://github.com/MeanderingProgrammer/markdown.nvim/issues/110)
+  [9725df2](https://github.com/MeanderingProgrammer/markdown.nvim/commit/9725df2306409a836a142244c9eabde96268d730)
+- Right aligned code block language hint [#73](https://github.com/MeanderingProgrammer/markdown.nvim/issues/73)
+  [4d8b603](https://github.com/MeanderingProgrammer/markdown.nvim/commit/4d8b6032b659a45582089de8bcd839f8ccc4161d)
+- Obsidian like custom callout titles [#109](https://github.com/MeanderingProgrammer/markdown.nvim/issues/109)
+  [a1bcbf4](https://github.com/MeanderingProgrammer/markdown.nvim/commit/a1bcbf4858d1834f922029b5fc6ae55a7417bd51)
 
 ### Bug Fixes
 

README.md

@@ -75,12 +75,12 @@ Plugin to improve viewing Markdown files in Neovim
 
 ## rocks.nvim
 
+This plugin is available on [LuaRocks](https://luarocks.org/modules/MeanderingProgrammer/markdown.nvim)
+
 ```vim
 :Rocks install markdown.nvim
 ```
 
-- [luarocks.org](https://luarocks.org/modules/MeanderingProgrammer/markdown.nvim)
-
 ## packer.nvim
 
 ```lua

benches/medium_spec.lua

@@ -4,13 +4,14 @@ local util = require('benches.util')
 
 describe('medium.md', function()
     it('default', function()
+        local base_marks = 2998
         util.between(25, 75, util.setup('temp/medium.md'))
-        util.num_marks(2998)
+        util.num_marks(base_marks)
 
         util.between(0, 1, util.move_down(3))
-        util.num_marks(3000)
+        util.num_marks(base_marks + 2)
 
         util.between(25, 50, util.insert_mode())
-        util.num_marks(3000)
+        util.num_marks(base_marks + 2)
     end)
 end)

benches/medium_table_spec.lua

@@ -4,13 +4,14 @@ local util = require('benches.util')
 
 describe('medium-table.md', function()
     it('default', function()
+        local base_marks = 30012
         util.between(450, 600, util.setup('temp/medium-table.md'))
-        util.num_marks(30012)
+        util.num_marks(base_marks)
 
         util.between(1, 5, util.move_down(1))
-        util.num_marks(30014)
+        util.num_marks(base_marks + 2)
 
         util.between(400, 550, util.insert_mode())
-        util.num_marks(30014)
+        util.num_marks(base_marks + 2)
     end)
 end)

benches/readme_spec.lua

@@ -4,13 +4,14 @@ local util = require('benches.util')
 
 describe('README.md', function()
     it('default', function()
+        local base_marks = 441
         util.between(25, 75, util.setup('README.md'))
-        util.num_marks(442)
+        util.num_marks(base_marks)
 
         util.between(0, 1, util.move_down(1))
-        util.num_marks(444)
+        util.num_marks(base_marks + 2)
 
         util.between(20, 40, util.insert_mode())
-        util.num_marks(444)
+        util.num_marks(base_marks + 2)
     end)
 end)

doc/render-markdown.txt

@@ -103,12 +103,13 @@ LAZY.NVIM                                  *render-markdown-install-lazy.nvim*
 
 ROCKS.NVIM                                *render-markdown-install-rocks.nvim*
 
+This plugin is available on LuaRocks
+<https://luarocks.org/modules/MeanderingProgrammer/markdown.nvim>
+
 >vim
     :Rocks install markdown.nvim
 <
 
-- luarocks.org <https://luarocks.org/modules/MeanderingProgrammer/markdown.nvim>
-
 
 PACKER.NVIM                              *render-markdown-install-packer.nvim*
 

lua/render-markdown/init.lua

@@ -460,8 +460,17 @@ M.default_config = {
 
 ---@param opts? render.md.UserConfig
 function M.setup(opts)
-    require('render-markdown.state').setup(M.default_config, opts)
-    require('render-markdown.ui').invalidate_cache()
+    -- This handles discrepancies in initialization order of different plugin managers, some
+    -- run the plugin directory first (lazy.nvim) while others run setup first (vim-plug).
+    -- To support both we want to pickup the last non-empty configuration. This works because
+    -- the plugin directory supplies an empty configuration which will be skipped if state
+    -- has already been initialized by the user.
+    local state = require('render-markdown.state')
+    if not state.initialized() or vim.tbl_count(opts or {}) > 0 then
+        state.setup(M.default_config, opts)
+        state.invalidate_cache()
+        require('render-markdown.ui').invalidate_cache()
+    end
 end
 
 return setmetatable(M, {

lua/render-markdown/state.lua

@@ -16,13 +16,14 @@ local configs = {}
 ---@field inline_query vim.treesitter.Query
 local M = {}
 
+---@return boolean
+function M.initialized()
+    return M.config ~= nil
+end
+
 ---@param default_config render.md.Config
 ---@param user_config? render.md.UserConfig
 function M.setup(default_config, user_config)
-    -- Reset cache to pickup config changes
-    M.invalidate_cache()
-
-    -- Create top level config from default & user
     local config = vim.tbl_deep_extend('force', default_config, user_config or {})
     M.config = config
     M.enabled = config.enabled

plugin/render-markdown.lua

@@ -3,7 +3,7 @@ if vim.g.loaded_render_markdown then
 end
 vim.g.loaded_render_markdown = true
 
-require('render-markdown').setup({})
+require('render-markdown').setup()
 require('render-markdown.colors').setup()
 require('render-markdown.manager').setup()