fix: add option to restart treesitter highlighter to clear invalid state

## Details

Issue: #488

Adds top level `restart_highlighter` option that when set to `true` will
restart the neovim highlighter by calling `vim.treesitter.stop()` and
`vim.treesitter.start()`.

This will happen once only, after this plugin attaches to its first
buffer for the first time, after modifying treesitter queries. Currently
this plugin may modify `injections` to insert markdown and `highlights`
to disable specific patterns.

In order for this to be a problem the following all need to be true for the user:

- They are using a version of neovim >= `0.11.0`
- They are lazy loading this plugin using `lazy.nvim` based on filetype.
- Their default `conceallevel` is > 0.
- They are using the `main` branch of `nvim-treesitter` and their custom
  `FileType` autocommand to enable highlighting does not handle
  duplicate events for the same buffer. The `master` branch handles
  duplicate events by restarting the highlighter already.

When all of these are true what can sometimes happen is any
`conceal_lines` directives in the highlighter will be activated before
this plugin has a chance to disable them. By default this is the case
for the delimiters around fenced code blocks. These concealed lines will
only reappear after a modification is made to the buffer.

Author: MeanderingProgrammer

CHANGELOG.md

@@ -4,8 +4,12 @@
 
 ### Features
 
-- render list item bullet points in yaml [#496](https://github.com/MeanderingProgrammer/render-markdown.nvim/issues/496)
+- yaml render list item bullet points [#496](https://github.com/MeanderingProgrammer/render-markdown.nvim/issues/496)
   [d7be79b](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/d7be79b1a006a2afd9945b5d48d3f1f3ce41ce69)
+- yaml render wiki style links [#496](https://github.com/MeanderingProgrammer/render-markdown.nvim/issues/496)
+  [146d4ff](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/146d4ff582017f1a1a16ada841aa08175a87aaea)
+- add scope_highlight to wiki config [ca86b59](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/ca86b5941a56b04ac140837ee7a366cf3fa5cd88)
+- add cell_offset function to pipe_table configuration [e5c3c50](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/e5c3c500d66e9aaf04c116cdfdb0b040d56a1521)
 
 ### Bug Fixes
 

README.md

@@ -215,6 +215,10 @@ require('render-markdown').setup({
     end,
     -- Additional events that will trigger this plugin's render loop.
     change_events = {},
+    -- Whether the treesitter highlighter should be restarted after this plugin attaches to its
+    -- first buffer for the first time. May be necessary if this plugin is lazy loaded to clear
+    -- highlights that have been dynamically disabled.
+    restart_highlighter = false,
     injections = {
         -- Out of the box language injections for known filetypes that allow markdown to be interpreted
         -- in specified locations, see :h treesitter-language-injections.

doc/render-markdown.txt

@@ -1,4 +1,4 @@
-*render-markdown.txt*       For NVIM v0.11.3       Last change: 2025 August 17
+*render-markdown.txt*       For NVIM v0.11.3       Last change: 2025 August 18
 
 ==============================================================================
 Table of Contents                          *render-markdown-table-of-contents*
@@ -281,6 +281,10 @@ Default Configuration ~
         end,
         -- Additional events that will trigger this plugin's render loop.
         change_events = {},
+        -- Whether the treesitter highlighter should be restarted after this plugin attaches to its
+        -- first buffer for the first time. May be necessary if this plugin is lazy loaded to clear
+        -- highlights that have been dynamically disabled.
+        restart_highlighter = false,
         injections = {
             -- Out of the box language injections for known filetypes that allow markdown to be interpreted
             -- in specified locations, see :h treesitter-language-injections.

lua/render-markdown/core/ts.lua

@@ -2,6 +2,7 @@ local compat = require('render-markdown.lib.compat')
 
 ---@class render.md.ts.Config
 ---@field file_types string[]
+---@field restart_highlighter boolean
 ---@field injections table<string, render.md.injection.Config>
 ---@field patterns table<string, render.md.pattern.Config>
 
@@ -35,6 +36,10 @@ function M.init()
     for _, language in ipairs(M.config.file_types) do
         M.disable(language)
     end
+    if M.config.restart_highlighter then
+        vim.treesitter.stop()
+        vim.treesitter.start()
+    end
 end
 
 ---@param language string

lua/render-markdown/health.lua

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

lua/render-markdown/init.lua

@@ -8,6 +8,7 @@ local M = {}
 ---@field file_types string[]
 ---@field ignore fun(buf: integer): boolean
 ---@field change_events string[]
+---@field restart_highlighter boolean
 ---@field injections render.md.injection.Configs
 ---@field patterns render.md.pattern.Configs
 ---@field on render.md.on.Config
@@ -77,6 +78,10 @@ M.default = {
     end,
     -- Additional events that will trigger this plugin's render loop.
     change_events = {},
+    -- Whether the treesitter highlighter should be restarted after this plugin attaches to its
+    -- first buffer for the first time. May be necessary if this plugin is lazy loaded to clear
+    -- highlights that have been dynamically disabled.
+    restart_highlighter = false,
     injections = require('render-markdown.config.injections').default,
     patterns = require('render-markdown.config.patterns').default,
     anti_conceal = require('render-markdown.config.anti_conceal').default,

lua/render-markdown/request/conceal.lua

@@ -2,16 +2,16 @@ local compat = require('render-markdown.lib.compat')
 local env = require('render-markdown.lib.env')
 local str = require('render-markdown.lib.str')
 
+---@class render.md.request.conceal.Line
+---@field hidden boolean
+---@field sections render.md.request.conceal.Section[]
+
 ---@class render.md.request.conceal.Section
 ---@field start_col integer
 ---@field end_col integer
 ---@field width integer
 ---@field character? string
 
----@class render.md.request.conceal.Line
----@field hidden boolean
----@field sections render.md.request.conceal.Section[]
-
 ---@class render.md.request.Conceal
 ---@field private buf integer
 ---@field private level integer
@@ -53,8 +53,7 @@ function Conceal:add(row, entry)
     if type(entry) == 'boolean' then
         line.hidden = entry
     else
-        -- If the section is covered by an existing one don't add it
-        if entry.width > 0 and not self:has(line, entry) then
+        if entry.width > 0 and not Conceal.contains(line, entry) then
             line.sections[#line.sections + 1] = entry
         end
     end
@@ -64,7 +63,7 @@ end
 ---@param line render.md.request.conceal.Line
 ---@param entry render.md.request.conceal.Section
 ---@return boolean
-function Conceal:has(line, entry)
+function Conceal.contains(line, entry)
     for _, section in ipairs(line.sections) do
         local starts_before = section.start_col <= entry.start_col
         local ends_after = section.end_col >= entry.end_col

lua/render-markdown/state.lua

@@ -31,6 +31,7 @@ function M.setup(config)
     })
     require('render-markdown.core.ts').setup({
         file_types = config.file_types,
+        restart_highlighter = config.restart_highlighter,
         injections = config.injections,
         patterns = config.patterns,
     })
@@ -89,6 +90,7 @@ function M.validate()
     spec:list('file_types', 'string')
     spec:type('ignore', 'function')
     spec:list('change_events', 'string')
+    spec:type('restart_highlighter', 'boolean')
     spec:nested('injections', require('render-markdown.config.injections').validate)
     spec:nested('patterns', require('render-markdown.config.patterns').validate)
     spec:nested('on', require('render-markdown.config.on').validate)

lua/render-markdown/types.lua

@@ -7,6 +7,7 @@
 ---@field file_types? string[]
 ---@field ignore? fun(buf: integer): boolean
 ---@field change_events? string[]
+---@field restart_highlighter? boolean
 ---@field injections? render.md.injection.UserConfigs
 ---@field patterns? render.md.pattern.UserConfigs
 ---@field on? render.md.on.UserConfig