fix: remove ability to configure treesitter queries

MeanderingProgrammer · MeanderingProgrammer · commit b0fe71f112d0 · 2024-09-30T08:55:19.000-07:00
## Details Issue: #192 Removes `markdown_query`, `markdown_quote_query`, & `inline_query` from user configuration. Instead these are now hard coded. While having these accessible had some convenience it's really more of a foot gun than anything else and users should really not modify it. For development in some instances it was nice to have, but modifying the hard coded value is not much more difficult. Anyone wanting to modify it probably wants to change functionality in which case they are modifying the code already anyway.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -43,18 +43,21 @@ body:
     attributes:
       label: Healthcheck output
       description: Output of :checkhealth render-markdown
+      render: text
     validations:
       required: true
   - type: textarea
     attributes:
       label: Plugin configuration
       description: Your configuration for this plugin.
+      render: lua
     validations:
       required: true
   - type: textarea
     attributes:
       label: Plugin error log
       description: Error log (:RenderMarkdown log) if empty put N/A.
+      render: text
     validations:
       required: true
   - type: checkboxes
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,7 @@
 ### Features
 
 - chechbox scope highlight [cb90caf](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/cb90caf64951b5b7515def7783b32e73883e374c)
+- plus / minus metadata dash rendering [35c37ca](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/35c37ca9f7955f9fa57eaee1c16edb3c80c40462)
 
 ### Bug Fixes
 
diff --git a/README.md b/README.md
@@ -139,63 +139,6 @@ require('render-markdown').setup({
     --  lazy:     will attempt to stay up to date with LazyVim configuration
     --  none:     does nothing
     preset = 'none',
-    -- Capture groups that get pulled from markdown
-    markdown_query = [[
-        (section) @section
-
-        (atx_heading [
-            (atx_h1_marker)
-            (atx_h2_marker)
-            (atx_h3_marker)
-            (atx_h4_marker)
-            (atx_h5_marker)
-            (atx_h6_marker)
-        ] @heading)
-        (setext_heading) @heading
-
-        [
-            (thematic_break)
-            (minus_metadata)
-            (plus_metadata)
-        ] @dash
-
-        (fenced_code_block) @code
-
-        [
-            (list_marker_plus)
-            (list_marker_minus)
-            (list_marker_star)
-        ] @list_marker
-
-        [
-            (task_list_marker_unchecked)
-            (task_list_marker_checked)
-        ] @checkbox
-
-        (block_quote) @quote
-
-        (pipe_table) @table
-    ]],
-    -- Capture groups that get pulled from quote nodes
-    markdown_quote_query = [[
-        [
-            (block_quote_marker)
-            (block_continuation)
-        ] @quote_marker
-    ]],
-    -- Capture groups that get pulled from inline markdown
-    inline_query = [[
-        (code_span) @code
-
-        (shortcut_link) @shortcut
-
-        [
-            (image)
-            (email_autolink)
-            (inline_link)
-            (full_reference_link)
-        ] @link
-    ]],
     -- 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',
diff --git a/doc/render-markdown.txt b/doc/render-markdown.txt
@@ -187,63 +187,6 @@ Default Configuration ~
         --  lazy:     will attempt to stay up to date with LazyVim configuration
         --  none:     does nothing
         preset = 'none',
-        -- Capture groups that get pulled from markdown
-        markdown_query = [[
-            (section) @section
-    
-            (atx_heading [
-                (atx_h1_marker)
-                (atx_h2_marker)
-                (atx_h3_marker)
-                (atx_h4_marker)
-                (atx_h5_marker)
-                (atx_h6_marker)
-            ] @heading)
-            (setext_heading) @heading
-    
-            [
-                (thematic_break)
-                (minus_metadata)
-                (plus_metadata)
-            ] @dash
-    
-            (fenced_code_block) @code
-    
-            [
-                (list_marker_plus)
-                (list_marker_minus)
-                (list_marker_star)
-            ] @list_marker
-    
-            [
-                (task_list_marker_unchecked)
-                (task_list_marker_checked)
-            ] @checkbox
-    
-            (block_quote) @quote
-    
-            (pipe_table) @table
-        ]],
-        -- Capture groups that get pulled from quote nodes
-        markdown_quote_query = [[
-            [
-                (block_quote_marker)
-                (block_continuation)
-            ] @quote_marker
-        ]],
-        -- Capture groups that get pulled from inline markdown
-        inline_query = [[
-            (code_span) @code
-    
-            (shortcut_link) @shortcut
-    
-            [
-                (image)
-                (email_autolink)
-                (inline_link)
-                (full_reference_link)
-            ] @link
-        ]],
         -- 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',
diff --git a/lua/render-markdown/core/treesitter.lua b/lua/render-markdown/core/treesitter.lua
@@ -1,6 +1,64 @@
 ---@class render.md.TreeSitter
 local M = {}
 
+---@class render.md.treesitter.Queries
+M.queries = {
+    markdown = [[
+        (section) @section
+
+        (atx_heading [
+            (atx_h1_marker)
+            (atx_h2_marker)
+            (atx_h3_marker)
+            (atx_h4_marker)
+            (atx_h5_marker)
+            (atx_h6_marker)
+        ] @heading)
+        (setext_heading) @heading
+
+        [
+            (thematic_break)
+            (minus_metadata)
+            (plus_metadata)
+        ] @dash
+
+        (fenced_code_block) @code
+
+        [
+            (list_marker_plus)
+            (list_marker_minus)
+            (list_marker_star)
+        ] @list_marker
+
+        [
+            (task_list_marker_unchecked)
+            (task_list_marker_checked)
+        ] @checkbox
+
+        (block_quote) @quote
+
+        (pipe_table) @table
+    ]],
+    markdown_quote = [[
+        [
+            (block_quote_marker)
+            (block_continuation)
+        ] @quote_marker
+    ]],
+    inline = [[
+        (code_span) @code
+
+        (shortcut_link) @shortcut
+
+        [
+            (image)
+            (email_autolink)
+            (inline_link)
+            (full_reference_link)
+        ] @link
+    ]],
+}
+
 ---@param language string
 ---@param injection render.md.Injection?
 function M.inject(language, injection)
diff --git a/lua/render-markdown/health.lua b/lua/render-markdown/health.lua
@@ -4,7 +4,7 @@ local state = require('render-markdown.state')
 local M = {}
 
 ---@private
-M.version = '7.2.6'
+M.version = '7.2.7'
 
 function M.check()
     M.start('version')
diff --git a/lua/render-markdown/init.lua b/lua/render-markdown/init.lua
@@ -187,9 +187,6 @@ local M = {}
 
 ---@class (exact) render.md.UserConfig: render.md.UserBufferConfig
 ---@field public preset? render.md.config.Preset
----@field public markdown_query? string
----@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[]
@@ -214,63 +211,6 @@ M.default_config = {
     --  lazy:     will attempt to stay up to date with LazyVim configuration
     --  none:     does nothing
     preset = 'none',
-    -- Capture groups that get pulled from markdown
-    markdown_query = [[
-        (section) @section
-
-        (atx_heading [
-            (atx_h1_marker)
-            (atx_h2_marker)
-            (atx_h3_marker)
-            (atx_h4_marker)
-            (atx_h5_marker)
-            (atx_h6_marker)
-        ] @heading)
-        (setext_heading) @heading
-
-        [
-            (thematic_break)
-            (minus_metadata)
-            (plus_metadata)
-        ] @dash
-
-        (fenced_code_block) @code
-
-        [
-            (list_marker_plus)
-            (list_marker_minus)
-            (list_marker_star)
-        ] @list_marker
-
-        [
-            (task_list_marker_unchecked)
-            (task_list_marker_checked)
-        ] @checkbox
-
-        (block_quote) @quote
-
-        (pipe_table) @table
-    ]],
-    -- Capture groups that get pulled from quote nodes
-    markdown_quote_query = [[
-        [
-            (block_quote_marker)
-            (block_continuation)
-        ] @quote_marker
-    ]],
-    -- Capture groups that get pulled from inline markdown
-    inline_query = [[
-        (code_span) @code
-
-        (shortcut_link) @shortcut
-
-        [
-            (image)
-            (email_autolink)
-            (inline_link)
-            (full_reference_link)
-        ] @link
-    ]],
     -- 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',
diff --git a/lua/render-markdown/state.lua b/lua/render-markdown/state.lua
@@ -48,9 +48,9 @@ function M.setup(default_config, user_config)
     M.latex = config.latex
     M.custom_handlers = config.custom_handlers
     vim.schedule(function()
-        M.markdown_query = vim.treesitter.query.parse('markdown', config.markdown_query)
-        M.markdown_quote_query = vim.treesitter.query.parse('markdown', config.markdown_quote_query)
-        M.inline_query = vim.treesitter.query.parse('markdown_inline', config.inline_query)
+        M.markdown_query = vim.treesitter.query.parse('markdown', treesitter.queries.markdown)
+        M.markdown_quote_query = vim.treesitter.query.parse('markdown', treesitter.queries.markdown_quote)
+        M.inline_query = vim.treesitter.query.parse('markdown_inline', treesitter.queries.inline)
     end)
     log.setup(config.log_level)
     for _, language in ipairs(M.file_types) do
@@ -253,7 +253,6 @@ function M.validate()
         :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')
         :one_of('preset', { 'none', 'lazy', 'obsidian' })
diff --git a/lua/render-markdown/types.lua b/lua/render-markdown/types.lua
@@ -157,9 +157,6 @@
 
 ---@class (exact) render.md.Config: render.md.BufferConfig
 ---@field public preset render.md.config.Preset
----@field public markdown_query string
----@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[]
