feat: support override based on buflisted value

## Details

Discussion: #285

`lspsaga` creates a buffer than iterates through a list of buffer
options to update the buffer. This makes sense however depending on the
iteration order of the options different things can happen.

- `filetype = markdown` then `buftype = nofile`: this will trigger the
  `FileType` autocommand and at the time it runs the `buftype` will be
  the empty string, which means overrides for `nofile` will not work.
- `buftype = nofile` then `filetype = markdown`: will also trigger the
  `FileType` autocommand but now at the time it runs the `buftype` will
  be correctly set to `nofile` and overrides will work.

To avoid this inconsistent behavior we need some property of the buffer
that will always hold. The solution to this is to use the `buflisted`
property, which gets set at the moment the buffer is created when
`nvim_create_buf` is called. Users can than disable this plugin in
`lspsaga` buffers by setting:

```lua
require('render-markdown').setup({
    overrides = {
        buflisted = { [false] = { enabled = false } },
    },
})
```

Author: MeanderingProgrammer

CHANGELOG.md

@@ -2,6 +2,18 @@
 
 ## Pre-release
 
+### Features
+
+- improve wiki link rendering [#284](https://github.com/MeanderingProgrammer/render-markdown.nvim/discussions/284)
+  [7b1b15f](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/7b1b15fc8891a62aeb3a0f75d0f7b1ec7fb98090)
+- heading icons function value [#286](https://github.com/MeanderingProgrammer/render-markdown.nvim/issues/286)
+  [bab0663](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/bab0663ecdb06b0ff846969764d6c67719ab0fcb)
+
+### Bug Fixes
+
+- ensure space for table cell padding [#287](https://github.com/MeanderingProgrammer/render-markdown.nvim/issues/287)
+  [786d643](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/786d643ac7a691515d401930b8850f596992725d)
+
 ## 7.8.0 (2025-01-04)
 
 ### Features

README.md

@@ -693,14 +693,16 @@ require('render-markdown').setup({
     --   heading, paragraph, code, dash, bullet, checkbox, quote, pipe_table,
     --   callout, link, sign, indent, latex, html, win_options
     overrides = {
-        -- Overrides for different buftypes, see :h 'buftype'
+        -- Override for different buflisted values, see :h 'buflisted'
+        buflisted = {},
+        -- Override for different buftype values, see :h 'buftype'
         buftype = {
             nofile = {
                 padding = { highlight = 'NormalFloat' },
                 sign = { enabled = false },
             },
         },
-        -- Overrides for different filetypes, see :h 'filetype'
+        -- Override for different filetype values, see :h 'filetype'
         filetype = {},
     },
     -- Mapping from treesitter language to user defined handlers

doc/render-markdown.txt

@@ -1,4 +1,4 @@
-*render-markdown.txt*          For 0.10.0         Last change: 2025 January 07
+*render-markdown.txt*          For 0.10.0         Last change: 2025 January 09
 
 ==============================================================================
 Table of Contents                          *render-markdown-table-of-contents*
@@ -749,14 +749,16 @@ Default Configuration ~
         --   heading, paragraph, code, dash, bullet, checkbox, quote, pipe_table,
         --   callout, link, sign, indent, latex, html, win_options
         overrides = {
-            -- Overrides for different buftypes, see :h 'buftype'
+            -- Override for different buflisted values, see :h 'buflisted'
+            buflisted = {},
+            -- Override for different buftype values, see :h 'buftype'
             buftype = {
                 nofile = {
                     padding = { highlight = 'NormalFloat' },
                     sign = { enabled = false },
                 },
             },
-            -- Overrides for different filetypes, see :h 'filetype'
+            -- Override for different filetype values, see :h 'filetype'
             filetype = {},
         },
         -- Mapping from treesitter language to user defined handlers

lua/render-markdown/debug/validator.lua

@@ -1,3 +1,5 @@
+local Iter = require('render-markdown.lib.iter')
+
 ---@class render.md.debug.Spec
 ---@field message string
 ---@field validation fun(value: any): boolean, string?
@@ -14,22 +16,22 @@ Spec.__index = Spec
 ---@param validator render.md.debug.Validator
 ---@param config? table<string, any>
 ---@param nilable boolean
----@param key? string|string[]
 ---@param path? string
+---@param key any
 ---@return render.md.debug.ValidatorSpec
-function Spec.new(validator, config, nilable, key, path)
+function Spec.new(validator, config, nilable, path, key)
     local self = setmetatable({}, Spec)
     self.validator = validator
     self.config = config
     self.nilable = nilable
     self.path = path or ''
-    self.specs = {}
     if self.config ~= nil and key ~= nil then
-        key = type(key) == 'table' and key or { key }
-        self.path = self.path .. '.' .. table.concat(key, '.')
-        self.config = vim.tbl_get(self.config, unpack(key))
+        local keys = type(key) == 'table' and key or { key }
+        self.config = vim.tbl_get(self.config, unpack(keys))
         self.config = type(self.config) == 'table' and self.config or nil
+        self.path = self.path .. '.' .. table.concat(Iter.list.map(keys, tostring), '.')
     end
+    self.specs = {}
     return self
 end
 
@@ -48,7 +50,7 @@ function Spec:nested(keys, f, nilable)
     end
     for _, key in ipairs(keys) do
         self:type(key, 'table')
-        f(Spec.new(self.validator, self.config, nilable, key, self.path))
+        f(Spec.new(self.validator, self.config, nilable, self.path, key))
     end
     return self
 end

lua/render-markdown/health.lua

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

lua/render-markdown/init.lua

@@ -224,6 +224,7 @@ local M = {}
 ---@field public below? integer
 
 ---@class (exact) render.md.UserConfigOverrides
+---@field public buflisted? table<boolean, render.md.UserBufferConfig>
 ---@field public buftype? table<string, render.md.UserBufferConfig>
 ---@field public filetype? table<string, render.md.UserBufferConfig>
 
@@ -790,14 +791,16 @@ M.default_config = {
     --   heading, paragraph, code, dash, bullet, checkbox, quote, pipe_table,
     --   callout, link, sign, indent, latex, html, win_options
     overrides = {
-        -- Overrides for different buftypes, see :h 'buftype'
+        -- Override for different buflisted values, see :h 'buflisted'
+        buflisted = {},
+        -- Override for different buftype values, see :h 'buftype'
         buftype = {
             nofile = {
                 padding = { highlight = 'NormalFloat' },
                 sign = { enabled = false },
             },
         },
-        -- Overrides for different filetypes, see :h 'filetype'
+        -- Override for different filetype values, see :h 'filetype'
         filetype = {},
     },
     -- Mapping from treesitter language to user defined handlers

lua/render-markdown/state.lua

@@ -80,8 +80,9 @@ function M.get(buf)
     local config = configs[buf]
     if config == nil then
         local buf_config = M.default_buffer_config()
-        for _, name in ipairs({ 'buftype', 'filetype' }) do
-            local override = M.config.overrides[name][util.get('buf', buf, name)]
+        for _, name in ipairs({ 'buflisted', 'buftype', 'filetype' }) do
+            local value = util.get('buf', buf, name)
+            local override = M.config.overrides[name][value]
             if override ~= nil then
                 buf_config = vim.tbl_deep_extend('force', buf_config, override)
             end
@@ -319,7 +320,7 @@ function M.validate()
         end)
         :nested('overrides', function(overrides)
             overrides
-                :nested({ 'buftype', 'filetype' }, function(override)
+                :nested({ 'buflisted', 'buftype', 'filetype' }, function(override)
                     override
                         :nested('ALL', function(buffer)
                             buffer_rules(buffer):check()

lua/render-markdown/types.lua

@@ -170,6 +170,7 @@
 ---@field public below integer
 
 ---@class (exact) render.md.ConfigOverrides
+---@field public buflisted table<boolean, render.md.UserBufferConfig>
 ---@field public buftype table<string, render.md.UserBufferConfig>
 ---@field public filetype table<string, render.md.UserBufferConfig>