fix: update window options on alternate buffer switch

## Details

Issue: #177

Reported as an issue when using telescope but is a general problem when
opening a different file in the current window then switching back using
the alternate buffer `<C-6>` keymap.

This occurs because changing the buffer in the current window resets the
local window options. However we have logic to only set window options
on a state change. Essentially we were not capturing the idea that
options are reset when opening a different buffer in the current window.

To fix this remove the logic that gates setting window options on a
state change and instead always update the window options based on the
current state. This shouldn't have much performance impact to users.

Minor other changes:

- Add distribtion input to issue templates
- Add `info` log level which provides some more high level information
  than `error` but not as much noise as `debug`
- Remove level specific methods from `log` and instead take level as an
  input argument and compare levels as integers to decide whether to log

Author: MeanderingProgrammer

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -9,6 +9,12 @@ body:
       placeholder: 0.10.0
     validations:
       required: true
+  - type: input
+    attributes:
+      label: Neovim distribution
+      placeholder: N/A, LazyVim, NvChad
+    validations:
+      required: true
   - type: input
     attributes:
       label: Operating system

.github/ISSUE_TEMPLATE/help.yml

@@ -3,6 +3,18 @@ description: Advice on how to do something
 title: "help: "
 labels: [question]
 body:
+  - type: input
+    attributes:
+      label: Neovim version (nvim -v)
+      placeholder: 0.10.0
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Neovim distribution
+      placeholder: N/A, LazyVim, NvChad
+    validations:
+      required: true
   - type: textarea
     attributes:
       label: Description

doc/render-markdown.txt

@@ -1,4 +1,4 @@
-*render-markdown.txt*         For 0.10.0        Last change: 2024 September 21
+*render-markdown.txt*         For 0.10.0        Last change: 2024 September 22
 
 ==============================================================================
 Table of Contents                          *render-markdown-table-of-contents*

lua/render-markdown/core/buffer_state.lua

@@ -2,7 +2,6 @@
 ---@field private buf integer
 ---@field private timer uv_timer_t
 ---@field private running boolean
----@field state? 'default'|'rendered'
 ---@field marks? render.md.Extmark[]
 local BufferState = {}
 BufferState.__index = BufferState
@@ -14,7 +13,6 @@ function BufferState.new(buf)
     self.buf = buf
     self.timer = (vim.uv or vim.loop).new_timer()
     self.running = false
-    self.state = nil
     self.marks = nil
     return self
 end

lua/render-markdown/core/context.lua

@@ -133,7 +133,7 @@ function Context:query(root, query, callback)
     for id, node in query:iter_captures(root, self.buf, self.top, self.bottom) do
         local capture = query.captures[id]
         local info = NodeInfo.new(self.buf, node)
-        log.debug_node_info(capture, info)
+        log.node_info(capture, info)
         callback(capture, info)
     end
 end

lua/render-markdown/core/list.lua

@@ -32,14 +32,14 @@ function Marks:add(conceal, start_row, start_col, opts)
         opts = opts,
     }
     if opts.virt_text_pos == 'inline' and not util.has_10 then
-        log.error('inline marks require neovim >= 0.10.0', mark)
+        log.add('error', 'inline marks require neovim >= 0.10.0', mark)
         return false
     end
     if opts.virt_text_repeat_linebreak ~= nil and not util.has_10 then
-        log.error('repeat linebreak marks require neovim >= 0.10.0', mark)
+        log.add('error', 'repeat linebreak marks require neovim >= 0.10.0', mark)
         return false
     end
-    log.debug('mark', mark)
+    log.add('debug', 'mark', mark)
     table.insert(self.marks, mark)
     return true
 end

lua/render-markdown/core/log.lua

@@ -31,8 +31,8 @@ end
 
 ---@param capture string
 ---@param info render.md.NodeInfo
-function M.debug_node_info(capture, info)
-    M.debug('node info', {
+function M.node_info(capture, info)
+    M.add('debug', 'node info', {
         capture = capture,
         text = info.text,
         rows = { info.start_row, info.end_row },
@@ -44,52 +44,32 @@ end
 ---@param group string
 ---@param capture string
 function M.unhandled_capture(group, capture)
-    M.error('unhandled capture', string.format('%s -> %s', group, capture))
+    M.add('error', 'unhandled capture', string.format('%s -> %s', group, capture))
 end
 
 ---Encountered if new type is seen for a particular group
 ---@param language string
 ---@param group string
 ---@param value string
 function M.unhandled_type(language, group, value)
-    M.error('unhandled type', string.format('%s -> %s -> %s', language, group, value))
-end
-
----@param name string
----@param buf integer
----@param ... any
-function M.debug_buf(name, buf, ...)
-    M.debug(string.format('%s %d', name, buf), ...)
-end
-
----@param name string
----@param ... any
-function M.debug(name, ...)
-    if vim.tbl_contains({ 'debug' }, M.level) then
-        M.add('debug', name, ...)
-    end
+    M.add('error', 'unhandled type', string.format('%s -> %s -> %s', language, group, value))
 end
 
+---@param level render.md.config.LogLevel
 ---@param name string
 ---@param buf integer
 ---@param ... any
-function M.error_buf(name, buf, ...)
-    M.error(string.format('%s %d', name, buf), ...)
-end
-
----@param name string
----@param ... any
-function M.error(name, ...)
-    if vim.tbl_contains({ 'debug', 'error' }, M.level) then
-        M.add('error', name, ...)
-    end
+function M.buf(level, name, buf, ...)
+    M.add(level, string.format('%s %d', name, buf), ...)
 end
 
----@private
 ---@param level render.md.config.LogLevel
 ---@param name string
 ---@param ... any
 function M.add(level, name, ...)
+    if M.level_value(level) < M.level_value(M.level) then
+        return
+    end
     local messages = {}
     local args = vim.F.pack_len(...)
     for i = 1, args.n do
@@ -110,6 +90,21 @@ function M.add(level, name, ...)
     end
 end
 
+---@private
+---@param level render.md.config.LogLevel
+---@return integer
+function M.level_value(level)
+    if level == 'debug' then
+        return 1
+    elseif level == 'info' then
+        return 2
+    elseif level == 'error' then
+        return 3
+    else
+        return 0
+    end
+end
+
 function M.flush()
     if #M.entries == 0 then
         return

lua/render-markdown/core/ui.lua

@@ -72,7 +72,7 @@ end
 ---@param event string
 ---@param change boolean
 function M.debounce_update(buf, win, event, change)
-    log.debug_buf('update', buf, string.format('event %s', event), string.format('change %s', change))
+    log.buf('info', 'update', buf, string.format('event %s', event), string.format('change %s', change))
     if not util.valid(buf, win) then
         return
     end
@@ -101,14 +101,12 @@ function M.update(buf, win, parse)
 
     local config, buffer_state = state.get(buf), Cache.get(buf)
     local mode, row = util.mode(), util.row(buf, win)
-
     local next_state = M.next_state(config, win, mode)
-    if next_state ~= buffer_state.state then
-        for name, value in pairs(config.win_options) do
-            util.set_win(win, name, value[next_state])
-        end
+
+    log.buf('info', 'state', buf, next_state)
+    for name, value in pairs(config.win_options) do
+        util.set_win(win, name, value[next_state])
     end
-    buffer_state.state = next_state
 
     if next_state == 'rendered' then
         if buffer_state.marks == nil or parse then
@@ -156,7 +154,7 @@ end
 function M.parse_buffer(buf, win)
     local has_parser, parser = pcall(vim.treesitter.get_parser, buf)
     if not has_parser then
-        log.error_buf('fail', buf, 'no treesitter parser found')
+        log.buf('error', 'fail', buf, 'no treesitter parser found')
         return {}
     end
     -- Reset buffer context
@@ -187,23 +185,23 @@ end
 ---@param root TSNode
 ---@return render.md.Mark[]
 function M.parse_tree(buf, language, root)
-    log.debug_buf('language', buf, language)
+    log.buf('debug', 'language', buf, language)
     if not Context.get(buf):contains_node(root) then
         return {}
     end
 
     local marks = {}
     local user = state.custom_handlers[language]
     if user ~= nil then
-        log.debug_buf('running handler', buf, 'user')
+        log.buf('debug', 'running handler', buf, 'user')
         vim.list_extend(marks, user.parse(root, buf))
         if not user.extends then
             return marks
         end
     end
     local builtin = builtin_handlers[language]
     if builtin ~= nil then
-        log.debug_buf('running handler', buf, 'builtin')
+        log.buf('debug', 'running handler', buf, 'builtin')
         vim.list_extend(marks, builtin.parse(root, buf))
     end
     return marks

lua/render-markdown/handler/latex.lua

@@ -19,12 +19,12 @@ function M.parse(root, buf)
         return {}
     end
     if vim.fn.executable(latex.converter) ~= 1 then
-        log.debug('executable not found', latex.converter)
+        log.add('debug', 'executable not found', latex.converter)
         return {}
     end
 
     local info = NodeInfo.new(buf, root)
-    log.debug_node_info('latex', info)
+    log.node_info('latex', info)
 
     local expressions = cache[info.text]
     if expressions == nil then

lua/render-markdown/health.lua

@@ -4,7 +4,7 @@ local state = require('render-markdown.state')
 local M = {}
 
 ---@private
-M.version = '7.1.3'
+M.version = '7.1.4'
 
 function M.check()
     M.start('version')