feat: add log_level off

## Details

Request: #235

Adds option to set "off" as value for log_level.

This should prevent any logs from being written to the log file.

The default value is kept as "error".

Minor changes to how buffer level locking works to include file name in
all cases to ease debugging.

Author: MeanderingProgrammer

doc/render-markdown.txt

@@ -1,4 +1,4 @@
-*render-markdown.txt*         For 0.10.0         Last change: 2024 November 13
+*render-markdown.txt*         For 0.10.0         Last change: 2024 November 17
 
 ==============================================================================
 Table of Contents                          *render-markdown-table-of-contents*

lua/render-markdown/core/log.lua

@@ -58,7 +58,7 @@ end
 ---@param buf integer
 ---@param ... any
 function M.buf(level, name, buf, ...)
-    M.add(level, string.format('%s %d', name, buf), ...)
+    M.add(level, string.format('%s|%s|%d', name, util.file_name(buf), buf), ...)
 end
 
 ---@param level render.md.config.LogLevel
@@ -98,6 +98,8 @@ function M.level_value(level)
         return 2
     elseif level == 'error' then
         return 3
+    elseif level == 'off' then
+        return 4
     else
         return 0
     end

lua/render-markdown/core/util.lua

@@ -125,9 +125,20 @@ function M.textoff(win)
     return #infos == 1 and infos[1].textoff or 0
 end
 
----@param file string
+---@param buf integer
+---@return string
+function M.file_name(buf)
+    local file = vim.api.nvim_buf_get_name(buf)
+    return vim.fn.fnamemodify(file, ':t')
+end
+
+---@param source string|integer
 ---@return number
-function M.file_size_mb(file)
+function M.file_size_mb(source)
+    local file = source
+    if type(file) == 'number' then
+        file = vim.api.nvim_buf_get_name(file)
+    end
     local ok, stats = pcall(function()
         return (vim.uv or vim.loop).fs_stat(file)
     end)

lua/render-markdown/health.lua

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

lua/render-markdown/init.lua

@@ -228,7 +228,7 @@ local M = {}
 ---@field public win_options? table<string, render.md.UserWindowOption>
 
 ---@alias render.md.config.Preset 'none'|'lazy'|'obsidian'
----@alias render.md.config.LogLevel 'debug'|'info'|'error'
+---@alias render.md.config.LogLevel 'off'|'debug'|'info'|'error'
 
 ---@class (exact) render.md.UserConfig: render.md.UserBufferConfig
 ---@field public preset? render.md.config.Preset

lua/render-markdown/manager.lua

@@ -83,36 +83,34 @@ end
 ---@param buf integer
 ---@return boolean
 function M.should_attach(buf)
-    local file = vim.api.nvim_buf_get_name(buf)
-    local log_name = string.format('attach %s', vim.fn.fnamemodify(file, ':t'))
-    log.buf('info', log_name, buf, 'start')
+    log.buf('info', 'attach', buf, 'start')
 
     if vim.tbl_contains(buffers, buf) then
-        log.buf('info', log_name, buf, 'skip', 'already attached')
+        log.buf('info', 'attach', buf, 'skip', 'already attached')
         return false
     end
 
     local file_type, file_types = util.get('buf', buf, 'filetype'), state.file_types
     if not vim.tbl_contains(file_types, file_type) then
         local reason = string.format('%s /∈ %s', file_type, vim.inspect(file_types))
-        log.buf('info', log_name, buf, 'skip', 'file type', reason)
+        log.buf('info', 'attach', buf, 'skip', 'file type', reason)
         return false
     end
 
     local config = state.get(buf)
     if not config.enabled then
-        log.buf('info', log_name, buf, 'skip', 'state disabled')
+        log.buf('info', 'attach', buf, 'skip', 'state disabled')
         return false
     end
 
-    local file_size, max_file_size = util.file_size_mb(file), config.max_file_size
+    local file_size, max_file_size = util.file_size_mb(buf), config.max_file_size
     if file_size > max_file_size then
         local reason = string.format('%f > %f', file_size, max_file_size)
-        log.buf('info', log_name, buf, 'skip', 'file size', reason)
+        log.buf('info', 'attach', buf, 'skip', 'file size', reason)
         return false
     end
 
-    log.buf('info', log_name, buf, 'success')
+    log.buf('info', 'attach', buf, 'success')
     table.insert(buffers, buf)
     return true
 end

lua/render-markdown/state.lua

@@ -269,7 +269,7 @@ function M.validate()
         :type('log_runtime', 'boolean')
         :list('file_types', 'string')
         :one_of('preset', { 'none', 'lazy', 'obsidian' })
-        :one_of('log_level', { 'debug', 'info', 'error' })
+        :one_of('log_level', { 'off', 'debug', 'info', 'error' })
         :nested('injections', function(injections)
             injections
                 :nested('ALL', function(injection)

tests/state_spec.lua

@@ -82,7 +82,7 @@ describe('state', function()
                 'render-markdown.debounce: expected type number, got table',
                 'render-markdown.enabled: expected type boolean, got string',
                 'render-markdown.heading.enabled: expected type boolean, got string',
-                'render-markdown.log_level: expected one of { "debug", "info", "error" }, got string',
+                'render-markdown.log_level: expected one of { "off", "debug", "info", "error" }, got string',
                 'render-markdown.log_runtime: expected type boolean, got string',
                 'render-markdown.max_file_size: expected type number, got boolean',
                 'render-markdown.overrides.buftype.nofile.sign.highlight: expected type string or nil, got boolean',