chore(refactor): replace util module with env module

## Details

Mostly a rename of:

- `local util = require('render-markdown.core.util')`
- `local Env = require('render-markdown.lib.env')`

Changes include:

- Use a nested class structure rather than supplying `variant`
  parameters to functions, i.e. `util.get('win', win, 'diff')` ->
  `Env.win.get(win, 'diff')`
    - Consists of `row`, `mode`, `buf`, and `win` nested classes
- Move `file_name` method into `log` module directly since it's the only
  user of it
- Add `conceal_lines` validation in `opts` (currently no rendering uses
  this), update format of associated errors

Author: MeanderingProgrammer

doc/render-markdown.txt

@@ -1,4 +1,4 @@
-*render-markdown.txt*           For 0.10.0          Last change: 2025 March 24
+*render-markdown.txt*           For 0.10.0          Last change: 2025 March 25
 
 ==============================================================================
 Table of Contents                          *render-markdown-table-of-contents*

lua/render-markdown/api.lua

@@ -1,6 +1,6 @@
+local Env = require('render-markdown.lib.env')
 local manager = require('render-markdown.manager')
 local state = require('render-markdown.state')
-local util = require('render-markdown.core.util')
 
 ---@class render.md.Api
 local M = {}
@@ -44,7 +44,7 @@ function M.contract()
 end
 
 function M.debug()
-    local buf, win = util.current('buf'), util.current('win')
+    local buf, win = Env.buf.current(), Env.win.current()
     local row, marks = require('render-markdown.core.ui').get_row_marks(buf, win)
     require('render-markdown.debug.marks').debug(row, marks)
 end

lua/render-markdown/config.lua

@@ -1,5 +1,5 @@
+local Env = require('render-markdown.lib.env')
 local Range = require('render-markdown.core.range')
-local util = require('render-markdown.core.util')
 
 ---@class render.md.component.Config
 ---@field callout table<string, render.md.CustomCallout>
@@ -70,7 +70,7 @@ end
 ---@param mode string
 ---@return boolean
 function Config:render(mode)
-    return util.in_modes(self.modes, mode)
+    return Env.mode.is(mode, self.modes)
 end
 
 ---@param node render.md.Node

lua/render-markdown/core/buffer.lua

@@ -1,3 +1,5 @@
+local Env = require('render-markdown.lib.env')
+
 ---@class render.md.Buffer
 ---@field private buf integer
 ---@field private empty boolean
@@ -13,7 +15,7 @@ function Buffer.new(buf)
     local self = setmetatable({}, Buffer)
     self.buf = buf
     self.empty = true
-    self.timer = (vim.uv or vim.loop).new_timer()
+    self.timer = Env.uv.new_timer()
     self.running = false
     self.marks = nil
     return self

lua/render-markdown/core/conceal.lua

@@ -1,5 +1,5 @@
+local Env = require('render-markdown.lib.env')
 local Str = require('render-markdown.lib.str')
-local util = require('render-markdown.core.util')
 
 ---@class render.md.conceal.Section
 ---@field start_col integer
@@ -82,7 +82,7 @@ end
 ---@return boolean
 function Conceal:hidden(context, node)
     -- conceal lines metadata require neovim >= 0.11.0 to function
-    return util.has_11 and self:line(context, node).hidden
+    return Env.has_11 and self:line(context, node).hidden
 end
 
 ---@param context render.md.Context

lua/render-markdown/core/context.lua

@@ -1,9 +1,9 @@
 local Conceal = require('render-markdown.core.conceal')
+local Env = require('render-markdown.lib.env')
 local Node = require('render-markdown.lib.node')
 local Range = require('render-markdown.core.range')
 local Str = require('render-markdown.lib.str')
 local log = require('render-markdown.core.log')
-local util = require('render-markdown.core.util')
 
 ---@class render.md.context.Props
 ---@field buf integer
@@ -35,7 +35,7 @@ function Context.new(props, offset)
     self.win = props.win
 
     local ranges = {}
-    for _, window in ipairs(util.windows(self.buf)) do
+    for _, window in ipairs(Env.buf.windows(self.buf)) do
         table.insert(ranges, Context.compute_range(self.buf, window, offset))
     end
     self.ranges = Range.coalesce(ranges)
@@ -47,7 +47,7 @@ function Context.new(props, offset)
 
     self.mode = props.mode
     self.top_level_mode = props.top_level_mode
-    self.conceal = Conceal.new(self.buf, util.get('win', self.win, 'conceallevel'))
+    self.conceal = Conceal.new(self.buf, Env.win.get(self.win, 'conceallevel'))
     self.last_heading = nil
 
     return self
@@ -59,14 +59,14 @@ end
 ---@param offset integer
 ---@return render.md.Range
 function Context.compute_range(buf, win, offset)
-    local top = math.max(util.view(win).topline - 1 - offset, 0)
+    local top = math.max(Env.win.view(win).topline - 1 - offset, 0)
 
     local bottom = top
     local lines = vim.api.nvim_buf_line_count(buf)
     local size = vim.api.nvim_win_get_height(win) + (2 * offset)
     while bottom < lines and size > 0 do
         bottom = bottom + 1
-        if util.row_visible(win, bottom) then
+        if Env.row.visible(win, bottom) then
             size = size - 1
         end
     end
@@ -86,7 +86,7 @@ function Context:skip(component)
         return false
     end
     -- Enabled components in component modes should not be skipped
-    return not util.in_modes(component.render_modes, self.mode)
+    return not Env.mode.is(self.mode, component.render_modes)
 end
 
 ---@return integer
@@ -120,7 +120,7 @@ end
 
 ---@return integer
 function Context:tab_size()
-    return util.get('buf', self.buf, 'tabstop')
+    return Env.buf.get(self.buf, 'tabstop')
 end
 
 ---@param node? render.md.Node
@@ -186,7 +186,7 @@ end
 ---@return integer
 function Context:get_width()
     if self.window_width == nil then
-        self.window_width = vim.api.nvim_win_get_width(self.win) - util.textoff(self.win)
+        self.window_width = Env.win.width(self.win)
     end
     return self.window_width
 end

lua/render-markdown/core/log.lua

@@ -1,4 +1,4 @@
-local util = require('render-markdown.core.util')
+local Env = require('render-markdown.lib.env')
 
 ---@class render.md.log.Entry
 ---@field date string
@@ -24,7 +24,7 @@ function M.setup(level)
     -- Typically resolves to ~/.local/state/nvim/render-markdown.log
     M.file = vim.fn.stdpath('state') .. '/render-markdown.log'
     -- Clear the file contents if it is too big
-    if util.file_size_mb(M.file) > 5 then
+    if Env.file_size_mb(M.file) > 5 then
         assert(io.open(M.file, 'w')):close()
     end
 end
@@ -58,7 +58,19 @@ end
 ---@param buf integer
 ---@param ... any
 function M.buf(level, name, buf, ...)
-    M.add(level, string.format('%s|%s|%d', name, util.file_name(buf), buf), ...)
+    M.add(level, string.format('%s|%s|%d', name, M.file_name(buf), buf), ...)
+end
+
+---@private
+---@param buf integer
+---@return string
+function M.file_name(buf)
+    if Env.buf.valid(buf) then
+        local file = vim.api.nvim_buf_get_name(buf)
+        return vim.fn.fnamemodify(file, ':t')
+    else
+        return 'INVALID'
+    end
 end
 
 ---@param level render.md.config.LogLevel

lua/render-markdown/core/ui.lua

@@ -1,10 +1,10 @@
 local Buffer = require('render-markdown.core.buffer')
 local Context = require('render-markdown.core.context')
+local Env = require('render-markdown.lib.env')
 local Extmark = require('render-markdown.core.extmark')
 local Iter = require('render-markdown.lib.iter')
 local log = require('render-markdown.core.log')
 local state = require('render-markdown.state')
-local util = require('render-markdown.core.util')
 
 ---@type table<string, render.md.Handler>
 local builtin_handlers = {
@@ -48,7 +48,7 @@ end
 ---@return integer, render.md.Mark[]
 function M.get_row_marks(buf, win)
     local config, buffer = state.get(buf), Cache.get(buf)
-    local mode, row = util.mode(), util.row(buf, win)
+    local mode, row = Env.mode.get(), Env.row.get(buf, win)
     local hidden = config:hidden(mode, row)
     assert(row ~= nil and hidden ~= nil, 'Row & range must be known to get marks')
 
@@ -76,7 +76,7 @@ end
 ---@param change boolean
 function M.update(buf, win, event, change)
     log.buf('info', 'update', buf, string.format('event %s', event), string.format('change %s', change))
-    if util.invalid(buf, win) then
+    if not Env.valid(buf, win) then
         return
     end
 
@@ -90,7 +90,7 @@ function M.update(buf, win, event, change)
         M.run_update(buf, win, change)
     end
     if parse and state.log_runtime then
-        update = util.wrap_runtime(update)
+        update = Env.runtime(update)
     end
 
     if parse and config.debounce > 0 then
@@ -115,19 +115,19 @@ end
 ---@param win integer
 ---@param change boolean
 function M.run_update(buf, win, change)
-    if util.invalid(buf, win) then
+    if not Env.valid(buf, win) then
         return
     end
 
     local parse = M.parse(buf, win, change)
     local config, buffer = state.get(buf), Cache.get(buf)
-    local mode, row = util.mode(), util.row(buf, win)
+    local mode, row = Env.mode.get(), Env.row.get(buf, win)
     local next_state = M.next_state(config, win, mode)
 
     log.buf('info', 'state', buf, next_state)
-    for _, window in ipairs(util.windows(buf)) do
+    for _, window in ipairs(Env.buf.windows(buf)) do
         for name, value in pairs(config.win_options) do
-            util.set('win', window, name, value[next_state])
+            Env.win.set(window, name, value[next_state])
         end
     end
 
@@ -138,7 +138,7 @@ function M.run_update(buf, win, change)
                 buf = buf,
                 win = win,
                 mode = mode,
-                top_level_mode = util.in_modes(config.render_modes, mode),
+                top_level_mode = Env.mode.is(mode, config.render_modes),
             }))
         end
         local hidden = config:hidden(mode, row)
@@ -172,10 +172,10 @@ function M.next_state(config, win, mode)
     if not config:render(mode) then
         return 'default'
     end
-    if util.get('win', win, 'diff') then
+    if Env.win.get(win, 'diff') then
         return 'default'
     end
-    if util.view(win).leftcol ~= 0 then
+    if Env.win.view(win).leftcol ~= 0 then
         return 'default'
     end
     return 'rendered'