feat!: Support full buftype options

## Details

Adds support for an `overrides` field that allows for essentially a full
configuration per buftype. If no configuration is specified for a
particular buftype or a partial configuration the logic falls back to
the top level configuration. The top level configuration can be viewed
as the default and then overrides change it for specific buffers.

Because this mechanism is much more powerful it deprecates all other
buftype options as they can now be accomplished via this new mechanism.

The equivalents are as follows:

- `exclude.buftypes.<value>` -> `overrides.buftype.<value>.enabled = false`
- `sign.exclude.buftypes.<value>` -> `overrides.buftype.<value>.sign.enabled = false`

The previous default behavior of not showing signs on LSP floating
docs has been ported over, so anyone using default configurations
should not experience any problems.

Since the configuration is accessed all through the codebase there is a
pretty large code change here, but a lot if it is passing the new
resolved configuration around.

This enables a feature like different code padding by default vs. in LSP
floating windows with:

```lua
require('render-markdown').setup({
    code = { left_pad = 4 },
    overrides = {
        buftype = {
            nofile = {
                code = { left_pad = 0 },
            },
        },
    },
})
```

Author: MeanderingProgrammer

CHANGELOG.md

@@ -9,7 +9,7 @@
   interchangeable. Notice of deprecation has been available for a month since
   [726c85c](https://github.com/MeanderingProgrammer/markdown.nvim/commit/726c85cb9cc6d7d9c85af6ab093e1ee53b5e3c82).
     - Ultimately removed in TODO
-- Remove `profile` field in favor of benches [2f21726](https://github.com/MeanderingProgrammer/markdown.nvim/commit/2f217266c6b416c4948ddb7e88a5db02670c75d5)
+- Remove `profile` field in favor of benches [dcfa033](https://github.com/MeanderingProgrammer/markdown.nvim/commit/dcfa033cb39bc4f30019925aa91d3af5ec049614)
 - In order to fix:
   - Implement `parse` method instead of `render`, no direct translation
   - `profile` field was only meant for development, should not have any users

README.md

@@ -180,10 +180,6 @@ require('render-markdown').setup({
     render_modes = { 'n', 'c' },
     -- Set to avoid seeing warnings for conflicts in health check
     acknowledge_conflicts = false,
-    exclude = {
-        -- Buftypes ignored by this plugin, see :h 'buftype'
-        buftypes = {},
-    },
     anti_conceal = {
         -- This enables hiding any added text on the line the cursor is on
         -- This does have a performance penalty as we must listen to the 'CursorMoved' event
@@ -399,10 +395,6 @@ require('render-markdown').setup({
     sign = {
         -- Turn on / off sign rendering
         enabled = true,
-        -- More granular mechanism, disable signs within specific buftypes
-        exclude = {
-            buftypes = { 'nofile' },
-        },
         -- Applies to background of sign text
         highlight = 'RenderMarkdownSign',
     },
@@ -423,6 +415,19 @@ require('render-markdown').setup({
             rendered = '',
         },
     },
+    -- More granular configuration mechanism, allows different aspects of buffers
+    -- to have their own behavior. Values default to the top level configuration
+    -- if no override is provided. Supports the following fields:
+    --   enabled, max_file_size, render_modes, anti_conceal, heading, code, dash, bullet,
+    --   checkbox, quote, pipe_table, callout, link, sign, win_options
+    overrides = {
+        -- Overrides for different buftypes, see :h 'buftype'
+        buftype = {
+            nofile = {
+                sign = { enabled = false },
+            },
+        },
+    },
     -- Mapping from treesitter language to user defined handlers
     -- See 'Custom Handlers' document for more info
     custom_handlers = {},
@@ -703,10 +708,6 @@ require('render-markdown').setup({
     sign = {
         -- Turn on / off sign rendering
         enabled = true,
-        -- More granular mechanism, disable signs within specific buftypes
-        exclude = {
-            buftypes = { 'nofile' },
-        },
         -- Applies to background of sign text
         highlight = 'RenderMarkdownSign',
     },

doc/custom-handlers.md

@@ -12,13 +12,13 @@ needed, and concealing when the cursor enters.
 Each handler must conform to the following interface:
 
 ```lua
----@class render.md.Mark
+---@class (exact) render.md.Mark
 ---@field public conceal boolean
 ---@field public start_row integer
 ---@field public start_col integer
 ---@field public opts vim.api.keyset.set_extmark
 
----@class render.md.Handler
+---@class (exact) render.md.Handler
 ---@field public parse fun(root: TSNode, buf: integer): render.md.Mark[]
 ---@field public extends? boolean
 ```

doc/render-markdown.txt

@@ -212,10 +212,6 @@ Full Default Configuration ~
         render_modes = { 'n', 'c' },
         -- Set to avoid seeing warnings for conflicts in health check
         acknowledge_conflicts = false,
-        exclude = {
-            -- Buftypes ignored by this plugin, see :h 'buftype'
-            buftypes = {},
-        },
         anti_conceal = {
             -- This enables hiding any added text on the line the cursor is on
             -- This does have a performance penalty as we must listen to the 'CursorMoved' event
@@ -431,10 +427,6 @@ Full Default Configuration ~
         sign = {
             -- Turn on / off sign rendering
             enabled = true,
-            -- More granular mechanism, disable signs within specific buftypes
-            exclude = {
-                buftypes = { 'nofile' },
-            },
             -- Applies to background of sign text
             highlight = 'RenderMarkdownSign',
         },
@@ -455,6 +447,19 @@ Full Default Configuration ~
                 rendered = '',
             },
         },
+        -- More granular configuration mechanism, allows different aspects of buffers
+        -- to have their own behavior. Values default to the top level configuration
+        -- if no override is provided. Supports the following fields:
+        --   enabled, max_file_size, render_modes, anti_conceal, heading, code, dash, bullet,
+        --   checkbox, quote, pipe_table, callout, link, sign, win_options
+        overrides = {
+            -- Overrides for different buftypes, see :h 'buftype'
+            buftype = {
+                nofile = {
+                    sign = { enabled = false },
+                },
+            },
+        },
         -- Mapping from treesitter language to user defined handlers
         -- See 'Custom Handlers' document for more info
         custom_handlers = {},
@@ -743,10 +748,6 @@ SIGNS                                            *render-markdown-setup-signs*
         sign = {
             -- Turn on / off sign rendering
             enabled = true,
-            -- More granular mechanism, disable signs within specific buftypes
-            exclude = {
-                buftypes = { 'nofile' },
-            },
             -- Applies to background of sign text
             highlight = 'RenderMarkdownSign',
         },

lua/render-markdown/component.lua

@@ -1,16 +1,15 @@
-local state = require('render-markdown.state')
-
 ---@class render.md.Component
 ---@field text string
 ---@field highlight string
 
 ---@class render.md.ComponentHelper
 local M = {}
 
+---@param config render.md.BufferConfig
 ---@param text string
 ---@param comparison 'exact'|'contains'
 ---@return render.md.Component?
-function M.callout(text, comparison)
+function M.callout(config, text, comparison)
     ---@param callout render.md.CustomComponent
     ---@return boolean
     local function matches(callout)
@@ -22,18 +21,19 @@ function M.callout(text, comparison)
             error(string.format('Unhandled comparison: %s', comparison))
         end
     end
-    for _, callout in pairs(state.config.callout) do
+    for _, callout in pairs(config.callout) do
         if matches(callout) then
             return { text = callout.rendered, highlight = callout.highlight }
         end
     end
     return nil
 end
 
+---@param config render.md.BufferConfig
 ---@param text string
 ---@param comparison 'exact'|'starts'
 ---@return render.md.Component?
-function M.checkbox(text, comparison)
+function M.checkbox(config, text, comparison)
     ---@param checkbox render.md.CustomComponent
     ---@return boolean
     local function matches(checkbox)
@@ -45,7 +45,7 @@ function M.checkbox(text, comparison)
             error(string.format('Unhandled comparison: %s', comparison))
         end
     end
-    for _, checkbox in pairs(state.config.checkbox.custom) do
+    for _, checkbox in pairs(config.checkbox.custom) do
         if matches(checkbox) then
             return { text = checkbox.rendered, highlight = checkbox.highlight }
         end

lua/render-markdown/handler/latex.lua

@@ -15,7 +15,7 @@ local M = {}
 ---@param buf integer
 ---@return render.md.Mark[]
 function M.parse(root, buf)
-    local latex = state.config.latex
+    local latex = state.latex
     if not latex.enabled then
         return {}
     end