Use a string parameter rather than a query parameter, that way tbl_deep_extend does not remove the metatable

## Details

Input parameter is currently expected to be a query object.

However this does not work when we join the configs as metatables
are ignored: neovim/neovim#23811.

Use a string instead and parse as part of the setup function.

Author: MeanderingProgrammer

README.md

@@ -41,29 +41,26 @@ by the user.
 
 ```lua
 require('render-markdown').setup({
-    -- Capture groups that get pulled from the markdown file, these are later
-    -- used to modify how the file gets rendered
-    query = vim.treesitter.query.parse(
-        'markdown',
-        [[
-            (atx_heading [
-                (atx_h1_marker)
-                (atx_h2_marker)
-                (atx_h3_marker)
-                (atx_h4_marker)
-                (atx_h5_marker)
-                (atx_h6_marker)
-            ] @heading)
-
-            (fenced_code_block) @code
-
-            (list_item) @item
-
-            (pipe_table_header) @table_head
-            (pipe_table_delimiter_row) @table_delim
-            (pipe_table_row) @table_row
-        ]]
-    ),
+    -- Capture groups that get pulled from markdown, these are later used to
+    -- modify how the file gets rendered
+    markdown_query = [[
+        (atx_heading [
+            (atx_h1_marker)
+            (atx_h2_marker)
+            (atx_h3_marker)
+            (atx_h4_marker)
+            (atx_h5_marker)
+            (atx_h6_marker)
+        ] @heading)
+
+        (fenced_code_block) @code
+
+        (list_item) @item
+
+        (pipe_table_header) @table_head
+        (pipe_table_delimiter_row) @table_delim
+        (pipe_table_row) @table_row
+    ]],
     -- Filetypes this plugin will run on
     file_types = { 'markdown' },
     -- vim modes that will show a rendered view of the markdown file, all other

demo/sample.md

@@ -26,6 +26,10 @@ if __name__ == "__main__":
     * Nested List Item 2
 * List Item 3
 
+1. Item 1
+2. Item 2
+3. Item 3
+
 | Heading 1    | Heading 2    |
 | ------------ | ------------ |
 | Row 1 Item 1 | Row 1 Item 2 |

lua/render-markdown/init.lua

@@ -18,7 +18,7 @@ local M = {}
 ---@field public table? UserTableHighlights
 
 ---@class UserConfig
----@field public query? Query
+---@field public markdown_query? string
 ---@field public file_types? string[]
 ---@field public render_modes? string[]
 ---@field public headings? string[]
@@ -29,27 +29,24 @@ local M = {}
 function M.setup(opts)
     ---@type Config
     local default_config = {
-        query = vim.treesitter.query.parse(
-            'markdown',
-            [[
-                (atx_heading [
-                    (atx_h1_marker)
-                    (atx_h2_marker)
-                    (atx_h3_marker)
-                    (atx_h4_marker)
-                    (atx_h5_marker)
-                    (atx_h6_marker)
-                ] @heading)
-
-                (fenced_code_block) @code
-
-                (list_item) @item
-
-                (pipe_table_header) @table_head
-                (pipe_table_delimiter_row) @table_delim
-                (pipe_table_row) @table_row
-            ]]
-        ),
+        markdown_query = [[
+            (atx_heading [
+                (atx_h1_marker)
+                (atx_h2_marker)
+                (atx_h3_marker)
+                (atx_h4_marker)
+                (atx_h5_marker)
+                (atx_h6_marker)
+            ] @heading)
+
+            (fenced_code_block) @code
+
+            (list_item) @item
+
+            (pipe_table_header) @table_head
+            (pipe_table_delimiter_row) @table_delim
+            (pipe_table_row) @table_row
+        ]],
         file_types = { 'markdown' },
         render_modes = { 'n', 'c' },
         headings = { '󰲡', '󰲣', '󰲥', '󰲧', '󰲩', '󰲫' },
@@ -74,8 +71,9 @@ function M.setup(opts)
             },
         },
     }
-    state.config = vim.tbl_deep_extend('force', default_config, opts or {})
     state.enabled = true
+    state.config = vim.tbl_deep_extend('force', default_config, opts or {})
+    state.markdown_query = vim.treesitter.query.parse('markdown', state.config.markdown_query)
 
     -- Call immediately to re-render on LazyReload
     vim.schedule(M.refresh)
@@ -143,8 +141,8 @@ end
 M.handle_markdown = function(tree)
     local highlights = state.config.highlights
     ---@diagnostic disable-next-line: missing-parameter
-    for id, node in state.config.query:iter_captures(tree:root(), 0) do
-        local capture = state.config.query.captures[id]
+    for id, node in state.markdown_query:iter_captures(tree:root(), 0) do
+        local capture = state.markdown_query.captures[id]
         local value = vim.treesitter.get_node_text(node, 0)
         local start_row, start_col, end_row, end_col = node:range()
 

lua/render-markdown/state.lua

@@ -13,7 +13,7 @@
 ---@field public table TableHighlights
 
 ---@class Config
----@field public query Query
+---@field public markdown_query string
 ---@field public file_types string[]
 ---@field public render_modes string[]
 ---@field public headings string[]
@@ -23,5 +23,6 @@
 ---@class State
 ---@field enabled boolean
 ---@field config Config
+---@field markdown_query Query
 local state = {}
 return state