feat(options)! allow all window options to be configured, set concealcursor

# Details

Make the `conceal` behavior more generic by wrapping it in a table
of options. All options set a value to use when rendered and when
not rendered. This plugin will handle switching between them.

This is a breaking change for anyone currently setting a custom
`conceal` value like this:

```lua
require('render-markdown').setup({
    conceal = {
        default = <value_1>,
        rendered = <value_2>,
    },
})
```

Should instead now do:

```lua
require('render-markdown').setup({
    win_options = {
        conceallevel = {
            default = <value_1>,
            rendered = <value_2>,
        },
    },
})
```

Along with this change have added a default value for `concealcursor`
to continue concealing text in all modes when rendered, otherwise
use the user setting. This way text only changes on mode change
rather than mode change + when your cursor enters a line, though
not everyone prefers this, it is something that can be disabled in config.

With concealed text now being more consistent change the list marker
before checkmarks to be concealed rather than overlayed with spaces.

This resolves: #31.

Author: MeanderingProgrammer

README.md

@@ -138,12 +138,22 @@ require('render-markdown').setup({
         warning = '  Warning',
         caution = '󰳦  Caution',
     },
-    -- See :h 'conceallevel' for more information about meaning of values
-    conceal = {
-        -- conceallevel used for buffer when not being rendered, get user setting
-        default = vim.opt.conceallevel:get(),
-        -- conceallevel used for buffer when being rendered
-        rendered = 3,
+    -- Window options to use that change between rendered and raw view
+    win_options = {
+        -- See :h 'conceallevel'
+        conceallevel = {
+            -- Used when not being rendered, get user setting
+            default = vim.api.nvim_get_option_value('conceallevel', {}),
+            -- Used when being rendered, concealed text is completely hidden
+            rendered = 3,
+        },
+        -- See :h 'concealcursor'
+        concealcursor = {
+            -- Used when not being rendered, get user setting
+            default = vim.api.nvim_get_option_value('concealcursor', {}),
+            -- Used when being rendered, conceal text in all modes
+            rendered = 'nvic',
+        },
     },
     -- Determines how tables are rendered
     --  full: adds a line above and below tables + normal behavior

demo/demo.gif

@@ -169,12 +169,22 @@ modified by the user.
             warning = '  Warning',
             caution = '󰳦  Caution',
         },
-        -- See :h 'conceallevel' for more information about meaning of values
-        conceal = {
-            -- conceallevel used for buffer when not being rendered, get user setting
-            default = vim.opt.conceallevel:get(),
-            -- conceallevel used for buffer when being rendered
-            rendered = 3,
+        -- Window options to use that change between rendered and raw view
+        win_options = {
+            -- See :h 'conceallevel'
+            conceallevel = {
+                -- Used when not being rendered, get user setting
+                default = vim.api.nvim_get_option_value('conceallevel', {}),
+                -- Used when being rendered, concealed text is completely hidden
+                rendered = 3,
+            },
+            -- See :h 'concealcursor'
+            concealcursor = {
+                -- Used when not being rendered, get user setting
+                default = vim.api.nvim_get_option_value('concealcursor', {}),
+                -- Used when being rendered, conceal text in all modes
+                rendered = 'nvic',
+            },
         },
         -- Determines how tables are rendered
         --  full: adds a line above and below tables + normal behavior

doc/render-markdown.txt

@@ -1,5 +1,5 @@
 init := "tests/minimal.lua"
-default_zoom := "-2"
+default_zoom := "0"
 
 test:
   nvim --headless --noplugin -u {{init}} \

justfile

@@ -51,27 +51,29 @@ M.render = function(namespace, root, buf)
                 hl_eol = true,
             })
         elseif capture == 'list_marker' then
-            local list_marker_overlay = ''
             if M.is_sibling_checkbox(node) then
                 -- Hide the list marker for checkboxes rather than replacing with a bullet point
-                list_marker_overlay = string.rep(' ', vim.fn.strdisplaywidth(value))
+                vim.api.nvim_buf_set_extmark(buf, namespace, start_row, start_col, {
+                    end_row = end_row,
+                    end_col = end_col,
+                    conceal = '',
+                })
             else
                 -- List markers from tree-sitter should have leading spaces removed, however there are known
                 -- edge cases in the parser: https://github.com/tree-sitter-grammars/tree-sitter-markdown/issues/127
                 -- As a result we handle leading spaces here, can remove if this gets fixed upstream
                 local _, leading_spaces = value:find('^%s*')
                 local level = M.calculate_list_level(node)
                 local bullet = list.cycle(state.config.bullets, level)
-                list_marker_overlay = string.rep(' ', leading_spaces or 0) .. bullet
-            end
 
-            local virt_text = { list_marker_overlay, highlights.bullet }
-            vim.api.nvim_buf_set_extmark(buf, namespace, start_row, start_col, {
-                end_row = end_row,
-                end_col = end_col,
-                virt_text = { virt_text },
-                virt_text_pos = 'overlay',
-            })
+                local virt_text = { string.rep(' ', leading_spaces or 0) .. bullet, highlights.bullet }
+                vim.api.nvim_buf_set_extmark(buf, namespace, start_row, start_col, {
+                    end_row = end_row,
+                    end_col = end_col,
+                    virt_text = { virt_text },
+                    virt_text_pos = 'overlay',
+                })
+            end
         elseif capture == 'quote_marker' then
             local virt_text = { value:gsub('>', state.config.quote), highlights.quote }
             vim.api.nvim_buf_set_extmark(buf, namespace, start_row, start_col, {

lua/render-markdown/handler/markdown.lua

@@ -41,7 +41,7 @@ local function check_keys(t1, t2, path)
             table.insert(errors, string.format('Invalid type: %s, expected %s but found %s', key, type(v1), type(v2)))
         elseif type(v1) == 'table' and type(v2) == 'table' then
             -- Some tables are meant to have unrestricted keys
-            if k ~= 'custom_handlers' then
+            if not vim.list_contains({ 'win_options', 'custom_handlers' }, k) then
                 vim.list_extend(errors, check_keys(v1, v2, key_path))
             end
         end

lua/render-markdown/health.lua

@@ -37,9 +37,9 @@ local M = {}
 ---@class render.md.Handler
 ---@field public render fun(namespace: integer, root: TSNode, buf: integer)
 
----@class render.md.UserConceal
----@field public default? integer
----@field public rendered? integer
+---@class render.md.WindowOption
+---@field public default any
+---@field public rendered any
 
 ---@class render.md.UserCheckbox
 ---@field public unchecked? string
@@ -59,7 +59,7 @@ local M = {}
 ---@field public checkbox? render.md.UserCheckbox
 ---@field public quote? string
 ---@field public callout? render.md.UserCallout
----@field public conceal? render.md.UserConceal
+---@field public win_options? table<string, render.md.WindowOption>
 ---@field public table_style? 'full'|'normal'|'none'
 ---@field public custom_handlers? table<string, render.md.Handler>
 ---@field public highlights? render.md.UserHighlights
@@ -139,12 +139,22 @@ M.default_config = {
         warning = '  Warning',
         caution = '󰳦  Caution',
     },
-    -- See :h 'conceallevel' for more information about meaning of values
-    conceal = {
-        -- conceallevel used for buffer when not being rendered, get user setting
-        default = vim.opt.conceallevel:get(),
-        -- conceallevel used for buffer when being rendered
-        rendered = 3,
+    -- Window options to use that change between rendered and raw view
+    win_options = {
+        -- See :h 'conceallevel'
+        conceallevel = {
+            -- Used when not being rendered, get user setting
+            default = vim.api.nvim_get_option_value('conceallevel', {}),
+            -- Used when being rendered, concealed text is completely hidden
+            rendered = 3,
+        },
+        -- See :h 'concealcursor'
+        concealcursor = {
+            -- Used when not being rendered, get user setting
+            default = vim.api.nvim_get_option_value('concealcursor', {}),
+            -- Used when being rendered, conceal text in all modes
+            rendered = 'nvic',
+        },
     },
     -- Determines how tables are rendered
     --  full: adds a line above and below tables + normal behavior

lua/render-markdown/init.lua

@@ -28,10 +28,6 @@
 ---@field public quote string
 ---@field public callout render.md.Callout
 
----@class render.md.Conceal
----@field public default integer
----@field public rendered integer
-
 ---@class render.md.Checkbox
 ---@field public unchecked string
 ---@field public checked string
@@ -50,7 +46,7 @@
 ---@field public checkbox render.md.Checkbox
 ---@field public quote string
 ---@field public callout render.md.Callout
----@field public conceal render.md.Conceal
+---@field public win_options table<string, render.md.WindowOption>
 ---@field public table_style 'full'|'normal'|'none'
 ---@field public custom_handlers table<string, render.md.Handler>
 ---@field public highlights render.md.Highlights

lua/render-markdown/types.lua

@@ -25,8 +25,9 @@ M.refresh = function(buf)
     end
 
     logger.start()
-    util.set_conceal(buf, state.config.conceal.rendered)
-
+    for name, value in pairs(state.config.win_options) do
+        util.set_win_option(buf, name, value.rendered)
+    end
     -- Make sure injections are processed
     local parser = vim.treesitter.get_parser(buf)
     parser:parse(true)
@@ -67,7 +68,9 @@ M.clear_valid = function(buf)
     if not vim.api.nvim_win_is_valid(win) then
         return false
     end
-    util.set_conceal(buf, state.config.conceal.default)
+    for name, value in pairs(state.config.win_options) do
+        util.set_win_option(buf, name, value.default)
+    end
     local leftcol = vim.api.nvim_win_call(win, function()
         return vim.fn.winsaveview().leftcol
     end)

lua/render-markdown/ui.lua

@@ -15,9 +15,9 @@ M.buf_to_win = function(buf)
 end
 
 ---@param buf integer
----@param value integer
-M.set_conceal = function(buf, value)
-    local name = 'conceallevel'
+---@param name string
+---@param value any
+M.set_win_option = function(buf, name, value)
     local opts = { scope = 'local', win = M.buf_to_win(buf) }
     local before = vim.api.nvim_get_option_value(name, opts)
     vim.api.nvim_set_option_value(name, value, opts)