feat: change concealcursor value to nvic when user disables anti conceal

MeanderingProgrammer · MeanderingProgrammer · commit c809fc129f84 · 2025-06-27T11:48:54.000-07:00
## Details Have received a few bug reports when users disable the anti conceal feature, then notice that while for some things it works, text that is concealed in any way still becomes visible. For example with checkboxes the original list marker becomes visible as shown here: #463 This is a reasonable expectation given the name of the feature but is a misunderstanding of what is doing what. This plugin is adding decorations using extmarks, when anti conceal is disabled we simply add the marks on all the line, when it's enabled we avoid adding marks on the current line. However conceal behavior on the current line is not controlled by this plugin directly, and is instead controlled by the concealcursor window option. Previously for these issues I would inform users to update their `win_options` configuration to set concealcursor to 'nvic'. At the same time since this is behavior the user is going for we may as well make it function that way out of the box for them, while still allowing them to override the value for more custom experiences. So the behavior now is if `anti_conceal.enabled == false`, the default value for `win_options.concealcursor.rendered` becomes `'nvic'` instead of `''`. This is handled similarly to a `preset`, even though that's not what it is a `preset` is really just a way of setting different default options based on the values of other options. If the user sets any value in their config for `win_options.concealcursor.rendered` that will always take priority and be used over the default.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,8 +5,17 @@
 ### Features
 
 - configurable language border [b8ee8bc](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/b8ee8bcefd6f5319beb7d3df5237c68e5c5376ac)
+- configurable left and right language text [ba50c2f](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/ba50c2fa9178a9b7e35c9410fb7c952bdf6de50e)
 - change code.border to thin instead of hide if version < 0.11.0 [a706be7](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/a706be739257a6203524741da2da540bc190bbe2)
 - allow image links to use custom icons based on destination [ac3e74f](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/ac3e74ffdb0bcf7282445ac12083fb6bd44858a1)
+- better support for reloading with lazy.nvim [24aacee](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/24aacee83544ca113055564ed22be7852067c342)
+
+### Bug Fixes
+
+- handle nil windows on WinResized [#455](https://github.com/MeanderingProgrammer/render-markdown.nvim/issues/455)
+  [ec92f60](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/ec92f60b28be3e63007e62bb4084af5633eaf1d6)
+- correctly order indent & padding [#457](https://github.com/MeanderingProgrammer/render-markdown.nvim/issues/457)
+  [0944ba0](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/0944ba04ea7fc9e9087c1dedc76562d6e0d110cf)
 
 ### Collaborator Shoutouts
 
diff --git a/doc/render-markdown.txt b/doc/render-markdown.txt
@@ -1,4 +1,4 @@
-*render-markdown.txt*        For NVIM v0.11.2        Last change: 2025 June 22
+*render-markdown.txt*        For NVIM v0.11.2        Last change: 2025 June 27
 
 ==============================================================================
 Table of Contents                          *render-markdown-table-of-contents*
diff --git a/lua/render-markdown/config/callout.lua b/lua/render-markdown/config/callout.lua
@@ -1,3 +1,5 @@
+---@alias render.md.callout.Configs table<string, render.md.callout.Config>
+
 ---@class (exact) render.md.callout.Config
 ---@field raw string
 ---@field rendered string
@@ -9,7 +11,7 @@
 local M = {}
 
 -- stylua: ignore
----@type table<string, render.md.callout.Config>
+---@type render.md.callout.Configs
 M.default = {
     -- Callouts are a special instance of a 'block_quote' that start with a 'shortcut_link'.
     -- The key is for healthcheck and to allow users to change its values, value type below.
diff --git a/lua/render-markdown/config/injections.lua b/lua/render-markdown/config/injections.lua
@@ -1,11 +1,13 @@
+---@alias render.md.injection.Configs table<string, render.md.injection.Config>
+
 ---@class (exact) render.md.injection.Config
 ---@field enabled boolean
 ---@field query string
 
 ---@class render.md.injection.Cfg
 local M = {}
 
----@type table<string, render.md.injection.Config>
+---@type render.md.injection.Configs
 M.default = {
     -- Out of the box language injections for known filetypes that allow markdown to be interpreted
     -- in specified locations, see :h treesitter-language-injections.
diff --git a/lua/render-markdown/config/patterns.lua b/lua/render-markdown/config/patterns.lua
@@ -1,3 +1,5 @@
+---@alias render.md.pattern.Configs table<string, render.md.pattern.Config>
+
 ---@class (exact) render.md.pattern.Config
 ---@field disable boolean
 ---@field directives render.md.directive.Config[]
@@ -9,7 +11,7 @@
 ---@class render.md.pattern.Cfg
 local M = {}
 
----@type table<string, render.md.pattern.Config>
+---@type render.md.pattern.Configs
 M.default = {
     -- Highlight patterns to disable for filetypes, i.e. lines concealed around code blocks
 
diff --git a/lua/render-markdown/config/win_options.lua b/lua/render-markdown/config/win_options.lua
@@ -1,3 +1,5 @@
+---@alias render.md.window.Configs table<string, render.md.window.Config>
+
 ---@class (exact) render.md.window.Config
 ---@field default render.md.option.Value
 ---@field rendered render.md.option.Value
@@ -7,7 +9,7 @@
 ---@class render.md.window.Cfg
 local M = {}
 
----@type table<string, render.md.window.Config>
+---@type render.md.window.Configs
 M.default = {
     -- Window options to use that change between rendered and raw view.
 
diff --git a/lua/render-markdown/health.lua b/lua/render-markdown/health.lua
@@ -5,7 +5,7 @@ local state = require('render-markdown.state')
 local M = {}
 
 ---@private
-M.version = '8.5.10'
+M.version = '8.5.11'
 
 function M.check()
     M.start('version')
diff --git a/lua/render-markdown/init.lua b/lua/render-markdown/init.lua
@@ -8,8 +8,8 @@ local M = {}
 ---@field file_types string[]
 ---@field ignore fun(buf: integer): boolean
 ---@field change_events string[]
----@field injections table<string, render.md.injection.Config>
----@field patterns table<string, render.md.pattern.Config>
+---@field injections render.md.injection.Configs
+---@field patterns render.md.pattern.Configs
 ---@field on render.md.on.Config
 ---@field completions render.md.completions.Config
 ---@field overrides render.md.overrides.Config
@@ -20,7 +20,7 @@ local M = {}
 ---@field debounce integer
 ---@field anti_conceal render.md.anti.conceal.Config
 ---@field bullet render.md.bullet.Config
----@field callout table<string, render.md.callout.Config>
+---@field callout render.md.callout.Configs
 ---@field checkbox render.md.checkbox.Config
 ---@field code render.md.code.Config
 ---@field dash render.md.dash.Config
@@ -36,7 +36,7 @@ local M = {}
 ---@field pipe_table render.md.table.Config
 ---@field quote render.md.quote.Config
 ---@field sign render.md.sign.Config
----@field win_options table<string, render.md.window.Config>
+---@field win_options render.md.window.Configs
 
 ---@private
 ---@type boolean
diff --git a/lua/render-markdown/lib/presets.lua b/lua/render-markdown/lib/presets.lua
@@ -11,8 +11,10 @@ local M = {}
 ---@param user render.md.UserConfig
 ---@return render.md.UserConfig
 function M.get(user)
+    -- NOTE: only works while no options overlap
     local config = M.config(user.preset)
     config.pipe_table = M.pipe_table((user.pipe_table or {}).preset)
+    config.win_options = M.win_options((user.anti_conceal or {}).enabled)
     return config
 end
 
@@ -93,4 +95,17 @@ function M.pipe_table(preset)
     end
 end
 
+---@private
+---@param anti_conceal? boolean
+---@return render.md.window.UserConfigs
+function M.win_options(anti_conceal)
+    if anti_conceal == false then
+        ---@type render.md.window.UserConfigs
+        return { concealcursor = { rendered = 'nvic' } }
+    else
+        ---@type render.md.window.UserConfigs
+        return {}
+    end
+end
+
 return M
diff --git a/lua/render-markdown/types.lua b/lua/render-markdown/types.lua
@@ -7,8 +7,8 @@
 ---@field file_types? string[]
 ---@field ignore? fun(buf: integer): boolean
 ---@field change_events? string[]
----@field injections? table<string, render.md.injection.UserConfig>
----@field patterns? table<string, render.md.pattern.UserConfig>
+---@field injections? render.md.injection.UserConfigs
+---@field patterns? render.md.pattern.UserConfigs
 ---@field on? render.md.on.UserConfig
 ---@field completions? render.md.completions.UserConfig
 ---@field overrides? render.md.overrides.UserConfig
@@ -19,7 +19,7 @@
 ---@field debounce? integer
 ---@field anti_conceal? render.md.anti.conceal.UserConfig
 ---@field bullet? render.md.bullet.UserConfig
----@field callout? table<string, render.md.callout.UserConfig>
+---@field callout? render.md.callout.UserConfigs
 ---@field checkbox? render.md.checkbox.UserConfig
 ---@field code? render.md.code.UserConfig
 ---@field dash? render.md.dash.UserConfig
@@ -35,7 +35,7 @@
 ---@field pipe_table? render.md.table.UserConfig
 ---@field quote? render.md.quote.UserConfig
 ---@field sign? render.md.sign.UserConfig
----@field win_options? table<string, render.md.window.UserConfig>
+---@field win_options? render.md.window.UserConfigs
 
 ---@class (exact) render.md.anti.conceal.UserConfig
 ---@field enabled? boolean
@@ -56,6 +56,8 @@
 ---@field highlight? render.md.bullet.String
 ---@field scope_highlight? render.md.bullet.String
 
+---@alias render.md.callout.UserConfigs table<string, render.md.callout.UserConfig>
+
 ---@class (exact) render.md.callout.UserConfig
 ---@field raw? string
 ---@field rendered? string
@@ -174,6 +176,8 @@
 ---@field icon? string
 ---@field highlight? string
 
+---@alias render.md.injection.UserConfigs table<string, render.md.injection.UserConfig>
+
 ---@class (exact) render.md.injection.UserConfig
 ---@field enabled? boolean
 ---@field query? string
@@ -234,6 +238,8 @@
 ---@field indent? render.md.paragraph.Number
 ---@field min_width? integer
 
+---@alias render.md.pattern.UserConfigs table<string, render.md.pattern.UserConfig>
+
 ---@class (exact) render.md.pattern.UserConfig
 ---@field disable? boolean
 ---@field directives? render.md.directive.UserConfig[]
@@ -264,6 +270,8 @@
 ---@field enabled? boolean
 ---@field highlight? string
 
+---@alias render.md.window.UserConfigs table<string, render.md.window.UserConfig>
+
 ---@class (exact) render.md.window.UserConfig
 ---@field default? render.md.option.Value
 ---@field rendered? render.md.option.Value
diff --git a/scripts/update.py b/scripts/update.py
@@ -20,6 +20,22 @@ def name(self) -> str:
         # ---@alias md.mark.Line md.mark.Text[] -> md.mark.Line
         return self.value.split()[1]
 
+    def to_user(self) -> str | None:
+        if not self.config():
+            return None
+
+        def user(s: str) -> str:
+            return s.replace(".Config", ".UserConfig")
+
+        lines: list[str] = [user(self.value)]
+        for s in self.options:
+            option = user(s)
+            lines.append(option)
+        return "\n".join(lines)
+
+    def config(self) -> bool:
+        return self.name().split(".")[-1] == "Configs"
+
     def to_str(self) -> str:
         return "\n".join([self.value] + self.options)
 
@@ -32,31 +48,34 @@ class LuaClass:
     def add(self, value: str) -> None:
         self.fields.append(value)
 
-    def exact(self) -> bool:
-        return self.value.split()[1] == "(exact)"
-
     def name(self) -> str:
         # ---@class md.Init: md.Api                     -> md.Init
         # ---@class (exact) md.buffer.Config            -> md.buffer.Config
         # ---@class (exact) md.Config: md.buffer.Config -> md.Config
         return self.value.split(":")[0].split()[-1]
 
-    def config(self) -> bool:
-        return self.name().split(".")[-1] == "Config"
+    def to_user(self) -> str | None:
+        if not self.exact() or not self.config():
+            return None
 
-    def to_user(self) -> str:
         def user(s: str) -> str:
             return s.replace(".Config", ".UserConfig")
 
         lines: list[str] = [user(self.value)]
-        for field in self.fields:
-            field = user(field)
+        for s in self.fields:
+            field = user(s)
             name = field.split()[1]
             if not name.endswith("?"):
                 field = field.replace(f" {name} ", f" {name}? ")
             lines.append(field)
         return "\n".join(lines)
 
+    def exact(self) -> bool:
+        return self.value.split()[1] == "(exact)"
+
+    def config(self) -> bool:
+        return self.name().split(".")[-1] == "Config"
+
     def to_str(self) -> str:
         return "\n".join([self.value] + self.fields)
 
@@ -74,10 +93,9 @@ def update_types(root: Path) -> None:
 
     classes: list[str] = ["---@meta"]
     for definition in get_definitions(files):
-        if not isinstance(definition, LuaClass):
-            continue
-        if definition.exact() and definition.config():
-            classes.append(definition.to_user())
+        user = definition.to_user()
+        if user is not None:
+            classes.append(user)
 
     types = root.joinpath("types.lua")
     types.write_text("\n\n".join(classes) + "\n")
diff --git a/tests/state_spec.lua b/tests/state_spec.lua
@@ -9,21 +9,42 @@ local function validate(config, expected)
     assert.same(expected, state.validate())
 end
 
+---@param expected any
+---@param path string[]
+local function option(expected, path)
+    local config = state.get(0)
+    assert.same(expected, vim.tbl_get(config, unpack(path)))
+end
+
 describe('state', function()
-    it('override', function()
-        local config = { enabled = true }
+    it('default', function()
+        validate({}, {})
+    end)
+
+    it('buftype override', function()
+        local config = { sign = { enabled = true } }
+        local path = { 'sign', 'enabled' }
 
         vim.bo.buftype = ''
         validate(config, {})
-        assert.same(true, state.get(0).sign.enabled)
+        option(true, path)
 
         vim.bo.buftype = 'nofile'
         validate(config, {})
-        assert.same(false, state.get(0).sign.enabled)
+        option(false, path)
     end)
 
-    it('default', function()
+    it('anti conceal preset', function()
+        local path = { 'win_options', 'concealcursor', 'rendered' }
+
         validate({}, {})
+        option('', path)
+
+        validate({ anti_conceal = { enabled = true } }, {})
+        option('', path)
+
+        validate({ anti_conceal = { enabled = false } }, {})
+        option('nvic', path)
     end)
 
     it('valid', function()

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-render-markdown.txt For NVIM v0.11.2 Last change: 2025 June 22`
	`1`	`+render-markdown.txt For NVIM v0.11.2 Last change: 2025 June 27`
`2`	`2`
`3`	`3`	`==============================================================================`
`4`	`4`	`Table of Contents render-markdown-table-of-contents`