feature! Add more user commands, breaks existing toggle command

MeanderingProgrammer · MeanderingProgrammer · commit 3c36a257e2a5 · 2024-07-18T11:44:06.000-07:00
## Details Rather than the single toggle command add explicit enable, disable, and toggle commands. So as not to pollute the command space nest these under a single top level 'RenderMarkdown' command which takes a subcommand argument. By default run enable if no arugments are passed in. To fix the breaking change modify any user commands: - 'RenderMarkdownToggle' -> 'RenderMarkdown toggle' Related issue: #72 This should enable lazy loading on the RenderMarkdown command. Unrelated change: modify how demos are recorded, slow them down.
diff --git a/README.md b/README.md
@@ -88,9 +88,12 @@ use({
 
 # Commands
 
-`:RenderMarkdownToggle` - Switch between enabling & disabling this plugin
-
-- Function can also be accessed directly through `require('render-markdown').toggle()`
+- `:RenderMarkdown` | `:RenderMarkdown enable` - Enable this plugin
+  - Can also be accessed directly through `require('render-markdown').enable()`
+- `:RenderMarkdown disable` - Disable this plugin
+  - 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()`
 
 # Setup
 
diff --git a/demo/box_dash_quote.gif b/demo/box_dash_quote.gif
diff --git a/demo/callout.gif b/demo/callout.gif
diff --git a/demo/heading_code.gif b/demo/heading_code.gif
diff --git a/demo/latex.gif b/demo/latex.gif
diff --git a/demo/list_table.gif b/demo/list_table.gif
diff --git a/demo/record.py b/demo/record.py
@@ -10,8 +10,8 @@ def main(cols: int, rows: int, file: str, cast: str, content: str) -> None:
     pyautogui.hotkey("`", "c")
     time.sleep(1.0)
 
-    # Get length of file so we can scroll down it
-    num_lines = len(Path(file).read_text().splitlines())
+    # Get lines so we know how to scroll down, account for starting on first line
+    lines: list[str] = Path(file).read_text().splitlines()[1:]
 
     # Start recording demo file
     # https://docs.asciinema.org/manual/cli/usage/
@@ -29,17 +29,18 @@ def main(cols: int, rows: int, file: str, cast: str, content: str) -> None:
         pyautogui.press("o")
         pyautogui.press("enter")
         pyautogui.write(content, interval=0.1)
-
         # Enter normal mode
         pyautogui.press("esc")
         time.sleep(2.0)
 
     insert_normal(1)
 
-    # Slowly scroll down
-    for _ in range(num_lines):
+    # Scroll down
+    for line in lines:
         pyautogui.press("j")
-        time.sleep(0.1)
+        skip = ("    ", "def", "if")
+        duration = 0 if len(line) == 0 or line.startswith(skip) else 0.75
+        time.sleep(duration)
 
     insert_normal(1)
 
@@ -53,11 +54,11 @@ def main(cols: int, rows: int, file: str, cast: str, content: str) -> None:
     pyautogui.press("enter")
 
 
-def insert_normal(seconds: float) -> None:
+def insert_normal(duration: float) -> None:
     pyautogui.press("i")
-    time.sleep(seconds)
+    time.sleep(duration)
     pyautogui.press("esc")
-    time.sleep(seconds)
+    time.sleep(duration)
 
 
 if __name__ == "__main__":
diff --git a/doc/limitations.md b/doc/limitations.md
@@ -6,8 +6,14 @@
 
 `LaTeX` formula evaluations are placed above text rather than overlayed.
 
+# Resolved Limitations
+
 ## Telescope Opening File
 
+[FIX 4ab8359](https://github.com/MeanderingProgrammer/markdown.nvim/commit/4ab835985de62b46b6785ae160f5f709b77a0f92)
+
+Should no longer be an issue on any version of neovim if up to date.
+
 Since `telescope` performs several mode change operations to enable previewing and
 other nice things like setting `marks` when changing buffers there are scenarios
 where a `markdown` file will not render when it is initially opened through `telescope`.
@@ -23,8 +29,6 @@ Something about the way these are done causes the file to appear be opened in `i
 mode despite being in `normal` mode. Additionally there is no `ModeChanged` event
 that occurs after this to go back to `normal` mode.
 
-# Resolved Limitations
-
 ## Text Boundaries
 
 [FIX 5ce3566](https://github.com/MeanderingProgrammer/markdown.nvim/commit/5ce35662725b1024c6dddc8d0bc03befc5abc878)
diff --git a/doc/render-markdown.txt b/doc/render-markdown.txt
@@ -1,4 +1,4 @@
-*render-markdown.txt*           For 0.10.0           Last change: 2024 July 16
+*render-markdown.txt*           For 0.10.0           Last change: 2024 July 18
 
 ==============================================================================
 Table of Contents                          *render-markdown-table-of-contents*
@@ -123,9 +123,12 @@ PACKER.NVIM                              *render-markdown-install-packer.nvim*
 ==============================================================================
 5. Commands                                         *render-markdown-commands*
 
-`:RenderMarkdownToggle` - Switch between enabling & disabling this plugin
-
-- Function can also be accessed directly through `require('render-markdown').toggle()`
+- `:RenderMarkdown` | `:RenderMarkdown enable` - Enable this plugin
+    - Can also be accessed directly through `require('render-markdown').enable()`
+- `:RenderMarkdown disable` - Disable this plugin
+    - 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()`
 
 
 ==============================================================================
diff --git a/justfile b/justfile
@@ -9,24 +9,24 @@ test:
 health:
   nvim -c "checkhealth render-markdown" -- .
 
-demo-all: demo-heading demo-list demo-box demo-latex demo-callout
+demo: demo-heading demo-list demo-box demo-latex demo-callout
 
 demo-heading:
-  just demo "heading_code" "30" "## Heading 2"
+  just demo-file "heading_code" "30" "## Heading 2"
 
 demo-list:
-  just demo "list_table" "30" ""
+  just demo-file "list_table" "30" ""
 
 demo-box:
-  just demo "box_dash_quote" "15" ""
+  just demo-file "box_dash_quote" "15" ""
 
 demo-latex:
-  just demo "latex" "15" ""
+  just demo-file "latex" "15" ""
 
 demo-callout:
-  just demo "callout" "40" ""
+  just demo-file "callout" "40" ""
 
-demo file rows content:
+demo-file file rows content:
   rm -f demo/{{file}}.gif
   python demo/record.py \
     --cols "60" \
diff --git a/lua/render-markdown/handler/markdown.lua b/lua/render-markdown/handler/markdown.lua
@@ -414,7 +414,7 @@ M.render_sign = function(buf, info, text, highlight)
     if not sign.enabled then
         return nil
     end
-    if vim.tbl_contains(sign.exclude.buftypes, util.get_buftype(buf)) then
+    if vim.tbl_contains(sign.exclude.buftypes, util.get_buf(buf, 'buftype')) then
         return nil
     end
     ---@type render.md.Mark
diff --git a/lua/render-markdown/init.lua b/lua/render-markdown/init.lua
@@ -1,6 +1,7 @@
 local manager = require('render-markdown.manager')
 local state = require('render-markdown.state')
 
+---@class render.md.Init
 local M = {}
 
 ---@class render.md.Mark
@@ -405,16 +406,54 @@ function M.setup(opts)
         state.inline_query = vim.treesitter.query.parse('markdown_inline', state.config.inline_query)
         state.inline_link_query = vim.treesitter.query.parse('markdown_inline', state.config.inline_link_query)
     end)
+
     manager.setup()
-    vim.api.nvim_create_user_command(
-        'RenderMarkdownToggle',
-        M.toggle,
-        { desc = 'Switch between enabling & disabling render markdown plugin' }
-    )
+
+    vim.api.nvim_create_user_command('RenderMarkdown', M.command, {
+        nargs = '*',
+        desc = 'markdown.nvim commands',
+        complete = function(_, cmdline)
+            if cmdline:find('RenderMarkdown%s+%S+%s+.*') then
+                return {}
+            elseif cmdline:find('RenderMarkdown%s+') then
+                return { 'enable', 'disable', 'toggle' }
+            else
+                return {}
+            end
+        end,
+    })
+end
+
+---@param opts any
+M.command = function(opts)
+    local args = opts.fargs
+    if #args == 0 then
+        M.enable()
+    elseif #args == 1 then
+        if args[1] == 'enable' then
+            M.enable()
+        elseif args[1] == 'disable' then
+            M.disable()
+        elseif args[1] == 'toggle' then
+            M.toggle()
+        else
+            vim.notify('markdown.nvim: unexpected command: ' .. args[1], vim.log.levels.ERROR)
+        end
+    else
+        vim.notify('markdown.nvim: unexpected # arguments: ' .. #args, vim.log.levels.ERROR)
+    end
+end
+
+M.enable = function()
+    manager.set_all(true)
+end
+
+M.disable = function()
+    manager.set_all(false)
 end
 
 M.toggle = function()
-    manager.toggle()
+    manager.set_all(not state.enabled)
 end
 
 return M
diff --git a/lua/render-markdown/manager.lua b/lua/render-markdown/manager.lua
@@ -13,21 +13,22 @@ local data = {
 ---@class render.md.Manager
 local M = {}
 
+---@private
+---@type integer
+M.group = vim.api.nvim_create_augroup('RenderMarkdown', { clear = true })
+
 function M.setup()
-    local group = vim.api.nvim_create_augroup('RenderMarkdown', { clear = true })
     -- Attach to buffers based on matching filetype, this will add additional events
     vim.api.nvim_create_autocmd({ 'FileType' }, {
-        group = group,
+        group = M.group,
         pattern = state.config.file_types,
         callback = function(event)
-            if not vim.tbl_contains(state.config.exclude.buftypes, util.get_buftype(event.buf)) then
-                M.attach(group, event.buf)
-            end
+            M.attach(event.buf)
         end,
     })
     -- Window resizing is not buffer specific so is managed more globablly
     vim.api.nvim_create_autocmd({ 'WinResized' }, {
-        group = group,
+        group = M.group,
         callback = function()
             for _, win in ipairs(vim.v.event.windows) do
                 local buf = util.win_to_buf(win)
@@ -39,22 +40,38 @@ function M.setup()
     })
 end
 
+---@param enabled boolean
+M.set_all = function(enabled)
+    -- Attempt to attach current buffer in case this is from a lazy load
+    M.attach(vim.api.nvim_get_current_buf())
+    state.enabled = enabled
+    for _, buf in ipairs(data.buffers) do
+        ui.schedule_refresh(buf, true)
+    end
+end
+
 ---@private
----@param group integer
 ---@param buf integer
-M.attach = function(group, buf)
-    if not vim.tbl_contains(data.buffers, buf) then
-        table.insert(data.buffers, buf)
+M.attach = function(buf)
+    if not vim.tbl_contains(state.config.file_types, util.get_buf(buf, 'filetype')) then
+        return
     end
+    if vim.tbl_contains(state.config.exclude.buftypes, util.get_buf(buf, 'buftype')) then
+        return
+    end
+    if vim.tbl_contains(data.buffers, buf) then
+        return
+    end
+    table.insert(data.buffers, buf)
     vim.api.nvim_create_autocmd({ 'BufWinEnter', 'TextChanged' }, {
-        group = group,
+        group = M.group,
         buffer = buf,
         callback = function()
             ui.schedule_refresh(buf, true)
         end,
     })
     vim.api.nvim_create_autocmd({ 'ModeChanged' }, {
-        group = group,
+        group = M.group,
         buffer = buf,
         callback = function()
             local render_modes = state.config.render_modes
@@ -69,7 +86,7 @@ M.attach = function(group, buf)
     })
     if state.config.anti_conceal.enabled then
         vim.api.nvim_create_autocmd({ 'CursorMoved' }, {
-            group = group,
+            group = M.group,
             buffer = buf,
             callback = function()
                 -- Moving cursor should not result in text change, skip parsing
@@ -79,11 +96,4 @@ M.attach = function(group, buf)
     end
 end
 
-M.toggle = function()
-    state.enabled = not state.enabled
-    for _, buf in ipairs(data.buffers) do
-        ui.schedule_refresh(buf, true)
-    end
-end
-
 return M
diff --git a/lua/render-markdown/ts.lua b/lua/render-markdown/ts.lua
@@ -99,7 +99,7 @@ end
 ---@param info render.md.NodeInfo
 ---@return integer
 M.concealed = function(buf, info)
-    if util.get_win_option(util.buf_to_win(buf), 'conceallevel') == 0 then
+    if util.get_win(util.buf_to_win(buf), 'conceallevel') == 0 then
         return 0
     end
     local result = 0
diff --git a/lua/render-markdown/ui.lua b/lua/render-markdown/ui.lua
@@ -54,14 +54,14 @@ M.refresh = function(buf, mode, parse)
     if not M.should_render(buf, win, mode) then
         -- Set window options back to default
         for name, value in pairs(state.config.win_options) do
-            util.set_win_option(win, name, value.default)
+            util.set_win(win, name, value.default)
         end
         return
     end
 
     -- Set window options to rendered & perform render
     for name, value in pairs(state.config.win_options) do
-        util.set_win_option(win, name, value.rendered)
+        util.set_win(win, name, value.rendered)
     end
 
     -- Re-compute marks, needed if missing or between text changes
diff --git a/lua/render-markdown/util.lua b/lua/render-markdown/util.lua
@@ -27,23 +27,24 @@ end
 ---@param win integer
 ---@param name string
 ---@return number|string
-M.get_win_option = function(win, name)
+M.get_win = function(win, name)
     return vim.api.nvim_get_option_value(name, { scope = 'local', win = win })
 end
 
 ---@param win integer
 ---@param name string
 ---@param value number|string
-M.set_win_option = function(win, name, value)
-    local before = M.get_win_option(win, name)
+M.set_win = function(win, name, value)
+    local before = M.get_win(win, name)
     vim.api.nvim_set_option_value(name, value, { scope = 'local', win = win })
     logger.debug({ option = name, win = win, before = before, after = value })
 end
 
 ---@param buf integer
----@return any
-M.get_buftype = function(buf)
-    return vim.api.nvim_get_option_value('buftype', { buf = buf })
+---@param name string
+---@return number|string
+M.get_buf = function(buf, name)
+    return vim.api.nvim_get_option_value(name, { buf = buf })
 end
 
 ---@param win integer
