fix: support for code border for 0.11, disable conceal_lines highlights

## Details

Related issues:

- #351
- #352

This change adds back the code border that currently gets removed by the
default `conceal_lines` highlight that ships with `nvim-treesitter`.

I tried to make this work using virtual lines at first but ran into
quite a few issues with screen offset behavior and was unable to fix the
fact that LSP hover docs are now truncated based on concealed lines
leading to windows that did not take our virtual lines into account.

Ultimately to get around this I've added a new option called `patterns`
which takes a list of directive names & ids and runs the
`disable_pattern` API to turn these off. The default value:

```lua
{
    patterns = {
        markdown = {
            disable = true,
            directives = {
                { id = 17, name = 'conceal_lines' },
                { id = 18, name = 'conceal_lines' },
            },
        },
    },
}
```

Will disable markdown highlight patterns 17 & 18 if they correspond to
a `conceal_lines` directive. There is not any guarantee that the ids
will remain constant and users can override the highlights with their
own which we do not want to break. Hopefully ensuring the ids & names
match will work for most people and I can keep the default value working
with the most common case going forward. This behavior can be disabled
by users by setting `disable = false`.

Since removing these highlight patterns also removes the regular
character level concealing this plugin has been updated to add these for
the delimiter and language nodes itself, rather than relying on the
`nvim-treesitter` behavior.

Disabling patterns can take a while at startup so this instead runs on
just before this plugin actually attaches to a buffer rather than as
part of the startup sequence.

This behavior is specific to `0.11.0` so the logic is appropriately
gated to prevent any older versions from running into errors, we should
still be compatible down to `0.9.0`.

There's also a new `code.border` value called `hide` which is the new
default and applies the `conceal_lines` value to empty fenced code
delimiters. Older versions of neovim will continue to use the `thin`
border style as a fallback. This largely hides the bottom border, but
will also hide the top one if no language icon / name is added or
available.

Author: MeanderingProgrammer

README.md

@@ -220,6 +220,16 @@ require('render-markdown').setup({
             ]],
         },
     },
+    -- Highlight patterns to disable for filetypes, i.e. lines concealed around code blocks
+    patterns = {
+        markdown = {
+            disable = true,
+            directives = {
+                { id = 17, name = 'conceal_lines' },
+                { id = 18, name = 'conceal_lines' },
+            },
+        },
+    },
     anti_conceal = {
         -- This enables hiding any added text on the line the cursor is on.
         enabled = true,
@@ -427,7 +437,8 @@ require('render-markdown').setup({
         -- | none  | do not render a border                               |
         -- | thick | use the same highlight as the code body              |
         -- | thin  | when lines are empty overlay the above & below icons |
-        border = 'thin',
+        -- | hide  | conceal lines unless language name or icon is added  |
+        border = 'hide',
         -- Used above code blocks for thin border.
         above = '▄',
         -- Used below code blocks for thin border.
@@ -978,7 +989,8 @@ require('render-markdown').setup({
         -- | none  | do not render a border                               |
         -- | thick | use the same highlight as the code body              |
         -- | thin  | when lines are empty overlay the above & below icons |
-        border = 'thin',
+        -- | hide  | conceal lines unless language name or icon is added  |
+        border = 'hide',
         -- Used above code blocks for thin border.
         above = '▄',
         -- Used below code blocks for thin border.

doc/render-markdown.txt

@@ -285,6 +285,16 @@ Default Configuration ~
                 ]],
             },
         },
+        -- Highlight patterns to disable for filetypes, i.e. lines concealed around code blocks
+        patterns = {
+            markdown = {
+                disable = true,
+                directives = {
+                    { id = 17, name = 'conceal_lines' },
+                    { id = 18, name = 'conceal_lines' },
+                },
+            },
+        },
         anti_conceal = {
             -- This enables hiding any added text on the line the cursor is on.
             enabled = true,
@@ -492,7 +502,8 @@ Default Configuration ~
             -- | none  | do not render a border                               |
             -- | thick | use the same highlight as the code body              |
             -- | thin  | when lines are empty overlay the above & below icons |
-            border = 'thin',
+            -- | hide  | conceal lines unless language name or icon is added  |
+            border = 'hide',
             -- Used above code blocks for thin border.
             above = '▄',
             -- Used below code blocks for thin border.
@@ -1037,7 +1048,8 @@ Code Block Configuration ~
             -- | none  | do not render a border                               |
             -- | thick | use the same highlight as the code body              |
             -- | thin  | when lines are empty overlay the above & below icons |
-            border = 'thin',
+            -- | hide  | conceal lines unless language name or icon is added  |
+            border = 'hide',
             -- Used above code blocks for thin border.
             above = '▄',
             -- Used below code blocks for thin border.

lua/render-markdown/core/conceal.lua

@@ -72,18 +72,18 @@ function Conceal:has(line, entry)
     return false
 end
 
----@param width integer
 ---@param character? string
 ---@return integer
-function Conceal:adjust(width, character)
+function Conceal:width(character)
     if self.level == 1 then
         -- each block is replaced with one character
-        return width - 1
+        return 1
     elseif self.level == 2 then
         -- replacement character width is used
-        return width - Str.width(character)
+        return Str.width(character)
     else
-        return width
+        -- text is completely hidden
+        return 0
     end
 end
 
@@ -100,7 +100,7 @@ function Conceal:get(node)
     local result = 0
     for _, section in ipairs(self:line(node).sections) do
         if node.start_col < section.end_col and node.end_col > section.start_col then
-            local width = self:adjust(section.width, section.character)
+            local width = section.width - self:width(section.character)
             result = result + width
         end
     end

lua/render-markdown/core/treesitter.lua

@@ -1,7 +1,7 @@
 local Context = require('render-markdown.core.context')
 local Marks = require('render-markdown.lib.marks')
 local state = require('render-markdown.state')
-local treesitter = require('render-markdown.core.treesitter')
+local ts = require('render-markdown.integ.ts')
 
 ---@class render.md.handler.buf.Html
 ---@field private config render.md.buffer.Config
@@ -19,7 +19,7 @@ function Handler.new(buf)
     self.config = state.get(buf)
     self.context = Context.get(buf)
     self.marks = Marks.new(buf, true)
-    self.query = treesitter.parse(
+    self.query = ts.parse(
         'html',
         [[
             (comment) @comment

lua/render-markdown/handler/html.lua

@@ -1,7 +1,7 @@
 local Context = require('render-markdown.core.context')
 local Marks = require('render-markdown.lib.marks')
 local state = require('render-markdown.state')
-local treesitter = require('render-markdown.core.treesitter')
+local ts = require('render-markdown.integ.ts')
 
 ---@class render.md.handler.buf.Markdown
 ---@field private config render.md.buffer.Config
@@ -19,7 +19,7 @@ function Handler.new(buf)
     self.config = state.get(buf)
     self.context = Context.get(buf)
     self.marks = Marks.new(buf, false)
-    self.query = treesitter.parse(
+    self.query = ts.parse(
         'markdown',
         [[
             (section) @section

lua/render-markdown/handler/markdown.lua

@@ -1,7 +1,7 @@
 local Context = require('render-markdown.core.context')
 local Marks = require('render-markdown.lib.marks')
 local state = require('render-markdown.state')
-local treesitter = require('render-markdown.core.treesitter')
+local ts = require('render-markdown.integ.ts')
 
 ---@class render.md.handler.buf.MarkdownInline
 ---@field private config render.md.buffer.Config
@@ -19,7 +19,7 @@ function Handler.new(buf)
     self.config = state.get(buf)
     self.context = Context.get(buf)
     self.marks = Marks.new(buf, true)
-    self.query = treesitter.parse(
+    self.query = ts.parse(
         'markdown_inline',
         [[
             (code_span) @code_inline

lua/render-markdown/handler/markdown_inline.lua

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

lua/render-markdown/health.lua

@@ -47,6 +47,14 @@ local M = {}
 ---@field render? fun(ctx: render.md.CallbackContext)
 ---@field clear? fun(ctx: render.md.CallbackContext)
 
+---@class (exact) render.md.UserDirective
+---@field id? integer
+---@field name? string
+
+---@class (exact) render.md.UserPattern
+---@field disable? boolean
+---@field directives? render.md.UserDirective[]
+
 ---@class (exact) render.md.UserInjection
 ---@field enabled? boolean
 ---@field query? string
@@ -207,7 +215,7 @@ local M = {}
 ---@alias render.md.code.Style 'full'|'normal'|'language'|'none'
 ---@alias render.md.code.Position 'left'|'right'
 ---@alias render.md.code.Width 'full'|'block'
----@alias render.md.code.Border 'thin'|'thick'|'none'
+---@alias render.md.code.Border 'hide'|'thin'|'thick'|'none'
 
 ---@class (exact) render.md.UserCode: render.md.UserBaseComponent
 ---@field sign? boolean
@@ -340,6 +348,7 @@ local M = {}
 ---@field file_types? string[]
 ---@field change_events? string[]
 ---@field injections? table<string, render.md.UserInjection>
+---@field patterns? table<string, render.md.UserPattern>
 ---@field on? render.md.UserCallback
 ---@field completions? render.md.UserCompletions
 ---@field overrides? render.md.UserConfigOverrides
@@ -389,6 +398,16 @@ M.default_config = {
             ]],
         },
     },
+    -- Highlight patterns to disable for filetypes, i.e. lines concealed around code blocks
+    patterns = {
+        markdown = {
+            disable = true,
+            directives = {
+                { id = 17, name = 'conceal_lines' },
+                { id = 18, name = 'conceal_lines' },
+            },
+        },
+    },
     anti_conceal = {
         -- This enables hiding any added text on the line the cursor is on.
         enabled = true,
@@ -596,7 +615,8 @@ M.default_config = {
         -- | none  | do not render a border                               |
         -- | thick | use the same highlight as the code body              |
         -- | thin  | when lines are empty overlay the above & below icons |
-        border = 'thin',
+        -- | hide  | conceal lines unless language name or icon is added  |
+        border = 'hide',
         -- Used above code blocks for thin border.
         above = '▄',
         -- Used below code blocks for thin border.

lua/render-markdown/init.lua

@@ -0,0 +1,98 @@
+local Env = require('render-markdown.lib.env')
+
+---@class render.md.integ.TreeSitter
+---@field private initialized boolean
+---@field private queries table<string, vim.treesitter.Query>
+local M = {
+    initialized = false,
+    queries = {},
+}
+
+---Should only be called from manager on initial buffer attach
+function M.setup()
+    if M.initialized then
+        return
+    end
+    M.initialized = true
+    local state = require('render-markdown.state')
+    for _, language in ipairs(state.file_types) do
+        M.disable(language, state.patterns[language])
+    end
+end
+
+---@param language string
+---@param query string
+---@return vim.treesitter.Query
+function M.parse(language, query)
+    local result = M.queries[query]
+    if result == nil then
+        result = vim.treesitter.query.parse(language, query)
+        M.queries[query] = result
+    end
+    return result
+end
+
+---@param language string
+---@param injection? render.md.Injection
+function M.inject(language, injection)
+    if injection == nil or not injection.enabled then
+        return
+    end
+
+    local query = ''
+    if Env.has_11 then
+        query = query .. ';; extends' .. '\n'
+    else
+        local files = vim.treesitter.query.get_files(language, 'injections')
+        for _, file in ipairs(files) do
+            local f = io.open(file, 'r')
+            if f ~= nil then
+                query = query .. f:read('*all') .. '\n'
+                f:close()
+            end
+        end
+    end
+    query = query .. injection.query
+    pcall(vim.treesitter.query.set, language, 'injections', query)
+end
+
+---@private
+---@param language string
+---@param pattern? render.md.Pattern
+function M.disable(language, pattern)
+    if not Env.has_11 then
+        return
+    end
+    if pattern == nil or not pattern.disable then
+        return
+    end
+    local query = vim.treesitter.query.get(language, 'highlights')
+    if query == nil then
+        return
+    end
+    local query_directives = query.info.patterns
+    for _, directive in ipairs(pattern.directives) do
+        local query_directive = query_directives[directive.id]
+        if M.has_directive(directive.name, query_directive) then
+            query.query:disable_pattern(directive.id)
+        end
+    end
+end
+
+---@private
+---@param name string
+---@param directives? (string|integer)[][]
+---@return boolean
+function M.has_directive(name, directives)
+    if directives == nil then
+        return false
+    end
+    for _, directive in ipairs(directives) do
+        if directive[1] == 'set!' and directive[2] == name then
+            return true
+        end
+    end
+    return false
+end
+
+return M