feat: allow anti-conceal margin to be specified and modified with user commands

## Details

Adds anti_conceal.above and anti_conceal.below which function as a
margin to disable marks added by this plugin when moving cursor.

Useful to see more context, more useful in certain files than others.

Added 2 new subcommands to RenderMarkdown, expand & contract.

These increment and decrement the margin values making sure to never go
below 0.

Author: MeanderingProgrammer

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Pre-release
 
+### Features
+
+- handle imperfectly spaced tables using max width [166a254](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/166a254aaf5b4333fe015a29a66ad99c276538ea)
+
 ## 6.1.0 (2024-08-11)
 
 ### Features

README.md

@@ -28,11 +28,11 @@ Plugin to improve viewing Markdown files in Neovim
 
 <!-- panvimdoc-ignore-start -->
 
-|                                                                                                    |                                                                                                |
-| -------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
-| ![Heading Code](https://github.com/user-attachments/assets/663a34c5-0438-4688-8204-332065f65835)   | ![List Table](https://github.com/user-attachments/assets/162986e1-91f0-4e13-a83f-6183d58b0fcb) |
-| ![Box Dash Quote](https://github.com/user-attachments/assets/3f76e73e-b3a0-4cd8-90c1-208c5070659c) | ![LaTeX](https://github.com/user-attachments/assets/9e8909e4-7256-45fc-b481-4aba8850ebc3)      |
-| ![Callout](https://github.com/user-attachments/assets/4324ea72-a017-4175-9f9d-363da5e5f6ba)        |                                                                                                |
+|           |         |
+| --------- | ------- |
+| ![Heading](https://github.com/user-attachments/assets/663a34c5-0438-4688-8204-332065f65835) | ![Table](https://github.com/user-attachments/assets/162986e1-91f0-4e13-a83f-6183d58b0fcb) |
+| ![Quote](https://github.com/user-attachments/assets/3f76e73e-b3a0-4cd8-90c1-208c5070659c)   | ![LaTeX](https://github.com/user-attachments/assets/9e8909e4-7256-45fc-b481-4aba8850ebc3) |
+| ![Callout](https://github.com/user-attachments/assets/4324ea72-a017-4175-9f9d-363da5e5f6ba) | |
 
 <!-- panvimdoc-ignore-end -->
 
@@ -127,6 +127,10 @@ use({
   - Can also be accessed directly through `require('render-markdown').disable()`
 - `:RenderMarkdown toggle` - Switch between enabling & disabling this plugin
   - Can also be accessed directly through `require('render-markdown').toggle()`
+- `:RenderMarkdown expand` - Increase anti-conceal margin above and below by 1
+  - Can also be accessed directly through `require('render-markdown').expand()`
+- `:RenderMarkdown contract` - Decrease anti-conceal margin above and below by 1
+  - Can also be accessed directly through `require('render-markdown').contract()`
 
 # Setup
 
@@ -214,8 +218,11 @@ require('render-markdown').setup({
     acknowledge_conflicts = false,
     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
         enabled = true,
+        -- Number of lines above cursor to show
+        above = 0,
+        -- Number of lines below cursor to show
+        below = 0,
     },
     latex = {
         -- Whether LaTeX should be rendered, mainly used for health check

doc/render-markdown.txt

@@ -154,6 +154,10 @@ PACKER.NVIM                              *render-markdown-install-packer.nvim*
     - Can also be accessed directly through `require('render-markdown').disable()`
 - `:RenderMarkdown toggle` - Switch between enabling & disabling this plugin
     - Can also be accessed directly through `require('render-markdown').toggle()`
+- `:RenderMarkdown expand` - Increase anti-conceal margin above and below by 1
+    - Can also be accessed directly through `require('render-markdown').expand()`
+- `:RenderMarkdown contract` - Decrease anti-conceal margin above and below by 1
+    - Can also be accessed directly through `require('render-markdown').contract()`
 
 
 ==============================================================================
@@ -243,8 +247,11 @@ Full Default Configuration ~
         acknowledge_conflicts = false,
         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
             enabled = true,
+            -- Number of lines above cursor to show
+            above = 0,
+            -- Number of lines below cursor to show
+            below = 0,
         },
         latex = {
             -- Whether LaTeX should be rendered, mainly used for health check

lua/render-markdown/api.lua

@@ -16,4 +16,14 @@ function M.toggle()
     manager.set_all(not state.enabled)
 end
 
+function M.expand()
+    state.modify_anti_conceal(1)
+    M.enable()
+end
+
+function M.contract()
+    state.modify_anti_conceal(-1)
+    M.enable()
+end
+
 return M

lua/render-markdown/extmark.lua

@@ -22,7 +22,7 @@ end
 ---@param config render.md.BufferConfig
 ---@param row? integer
 function Extmark:render(config, row)
-    if self:should_show(config, row) then
+    if self:should_show(config.anti_conceal, row) then
         self:show()
     else
         self:hide()
@@ -53,12 +53,12 @@ end
 
 ---Render marks based on anti-conceal behavior and current row
 ---@private
----@param config render.md.BufferConfig
+---@param anti_conceal render.md.AntiConceal
 ---@param row? integer
 ---@return boolean
-function Extmark:should_show(config, row)
+function Extmark:should_show(anti_conceal, row)
     -- Anti-conceal is not enabled -> all marks should be shown
-    if not config.anti_conceal.enabled then
+    if not anti_conceal.enabled then
         return true
     end
     -- Row is not known means buffer is not active -> all marks should be shown
@@ -69,8 +69,9 @@ function Extmark:should_show(config, row)
     if not self.mark.conceal then
         return true
     end
-    -- Show mark if it is not on the current row
-    return self.mark.start_row ~= row
+    -- Show mark if it is outside current row range
+    local mark_row = self.mark.start_row
+    return mark_row < row - anti_conceal.above or mark_row > row + anti_conceal.below
 end
 
 return Extmark

lua/render-markdown/health.lua

@@ -5,7 +5,7 @@ local M = {}
 
 ---@private
 ---@type string
-M.version = '6.1.1'
+M.version = '6.1.2'
 
 function M.check()
     vim.health.start('render-markdown.nvim [version]')

lua/render-markdown/init.lua

@@ -130,6 +130,8 @@ local M = {}
 
 ---@class (exact) render.md.UserAntiConceal
 ---@field public enabled? boolean
+---@field public above? integer
+---@field public below? integer
 
 ---@class (exact) render.md.UserConfigOverrides
 ---@field public buftype? table<string, render.md.UserBufferConfig>
@@ -239,8 +241,11 @@ M.default_config = {
     acknowledge_conflicts = false,
     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
         enabled = true,
+        -- Number of lines above cursor to show
+        above = 0,
+        -- Number of lines below cursor to show
+        below = 0,
     },
     latex = {
         -- Whether LaTeX should be rendered, mainly used for health check

lua/render-markdown/state.lua

@@ -44,6 +44,19 @@ function M.invalidate_cache()
     configs = {}
 end
 
+---@param amount integer
+function M.modify_anti_conceal(amount)
+    ---@param anti_conceal render.md.AntiConceal
+    local function modify(anti_conceal)
+        anti_conceal.above = math.max(anti_conceal.above + amount, 0)
+        anti_conceal.below = math.max(anti_conceal.below + amount, 0)
+    end
+    modify(M.config.anti_conceal)
+    for _, config in pairs(configs) do
+        modify(config.anti_conceal)
+    end
+end
+
 ---@param buf integer
 ---@return render.md.BufferConfig
 M.get_config = function(buf)
@@ -64,7 +77,7 @@ end
 function M.default_buffer_config()
     local config = M.config
     ---@type render.md.BufferConfig
-    return {
+    return vim.deepcopy({
         enabled = true,
         max_file_size = config.max_file_size,
         debounce = config.debounce,
@@ -81,7 +94,7 @@ function M.default_buffer_config()
         link = config.link,
         sign = config.sign,
         win_options = config.win_options,
-    }
+    }, true)
 end
 
 ---@return string[]
@@ -188,6 +201,8 @@ function M.validate()
         if anti_conceal ~= nil then
             append_errors(path .. '.anti_conceal', anti_conceal, {
                 enabled = { anti_conceal.enabled, 'boolean', nilable },
+                above = { anti_conceal.above, 'number', nilable },
+                below = { anti_conceal.below, 'number', nilable },
             })
         end
 

lua/render-markdown/types.lua

@@ -107,6 +107,8 @@
 
 ---@class (exact) render.md.AntiConceal
 ---@field public enabled boolean
+---@field public above integer
+---@field public below integer
 
 ---@class (exact) render.md.ConfigOverrides
 ---@field public buftype table<string, render.md.UserBufferConfig>