Merge pull request #229 from Isrothy/persistent

Persistent

Author: Isrothy

README.md

@@ -184,14 +184,14 @@ vim.g.neominimap = {
   -- Path to the log file
   log_path = vim.fn.stdpath("data") .. "/neominimap.log", ---@type string
 
-  -- Minimap will not be created for buffers of these types
+  -- Minimaps will not be created for buffers of these filetypes
   ---@type string[]
   exclude_filetypes = {
     "help",
     "bigfile", -- For Snacks.nvim
   },
 
-  -- Minimap will not be created for buffers of these types
+  -- Minimaps will not be created for buffers of these buftypes
   ---@type string[]
   exclude_buftypes = {
     "nofile",
@@ -201,38 +201,42 @@ vim.g.neominimap = {
     "prompt",
   },
 
-  -- When false is returned, the minimap will not be created for this buffer
+  -- When this function returns false, the minimap will not be created for this buffer.
   ---@type fun(bufnr: integer): boolean
   buf_filter = function()
     return true
   end,
 
-  -- When false is returned, the minimap will not be created for this window
+  -- When this function returns false, the minimap will not be created for this window.
   ---@type fun(winid: integer): boolean
   win_filter = function()
     return true
   end,
 
-  -- When false is returned, the minimap will not be created for this tab
+  -- When this function returns false, the minimap will not be created for this tab.
   ---@type fun(tabid: integer): boolean
   tab_filter = function()
     return true
   end,
 
-
   -- How many columns a dot should span
   x_multiplier = 4, ---@type integer
 
   -- How many rows a dot should span
   y_multiplier = 1, ---@type integer
 
+  buffer = {
+    -- When true, the minimap will be recreated when you delete the buffer.
+    -- When false, the minimap will be disabled for the current buffer when you delete the minimap buffer.
+    persist = true, ---@type boolean
+  },
+
+
   ---@alias Neominimap.Config.LayoutType "split" | "float"
 
   --- Either `split` or `float`
-  --- When layout is set to `float`,
-  --- the minimap will be created in floating windows attached to all suitable windows
-  --- When layout is set to `split`,
-  --- the minimap will be created in one split window
+  --- When layout is set to `float`, minimaps will be created in floating windows attached to all suitable windows.
+  --- When layout is set to `split`, the minimap will be created in one split window per tab.
   layout = "float", ---@type Neominimap.Config.LayoutType
 
   --- Used when `layout` is set to `split`
@@ -242,17 +246,15 @@ vim.g.neominimap = {
     -- Always fix the width of the split window
     fix_width = false, ---@type boolean
 
-    -- split mode:
-    -- left is an alias for topleft   - leftmost vertical split, full height
-    -- right is an alias for botright - rightmost vertical split, full height
-    -- aboveleft -  left split in current window
-    -- rightbelow - right split in current window
-    ---@alias Neominimap.Config.SplitDirection "left" | "right" |
-    ---       "topleft" | "botright" | "aboveleft" | "rightbelow"
+    ---@alias Neominimap.Config.SplitDirection "left" | "right" | "topleft" | "botright" | "aboveleft" | "rightbelow"
     direction = "right", ---@type Neominimap.Config.SplitDirection
 
-    ---Automatically close the split window when it is the last window
+    --- Automatically close the split window when it is the last window.
     close_if_last_window = false, ---@type boolean
+
+    --- When true, the split window will be recreated when you close it.
+    --- When false, the minimap will be disabled for the current tab when you close the minimap window.
+    persist = true, ---@type boolean
   },
 
   --- Used when `layout` is set to `float`
@@ -274,20 +276,23 @@ vim.g.neominimap = {
     --- Accepts all usual border style options (e.g., "single", "double")
     --- @type string | string[] | [string, string][]
     window_border = "single",
+
+    -- When true, the floating window will be recreated when you close it.
+    -- When false, the minimap will be disabled for the current tab when you close the minimap window.
+    persist = true, ---@type boolean
   },
 
-  -- For performance issue, when text changed,
-  -- minimap is refreshed after a certain delay
+  -- For performance, when text changes, the minimap is refreshed after a certain delay.
   -- Set the delay in milliseconds
   delay = 200, ---@type integer
 
   -- Sync the cursor position with the minimap
   sync_cursor = true, ---@type boolean
 
   click = {
-    -- Enable mouse click on minimap
+    -- Enable mouse click on the minimap
     enabled = false, ---@type boolean
-    -- Automatically switch focus to minimap when clicked
+    -- Automatically switch focus to the minimap when clicked
     auto_switch_focus = true, ---@type boolean
   },
 
@@ -352,18 +357,18 @@ vim.g.neominimap = {
   },
 
   fold = {
-    -- Considering fold when rendering minimap
+    -- Consider folds when rendering the minimap
     enabled = true, ---@type boolean
   },
 
-  ---Overrite the default winopt
+  --- Override the default window options
   ---@param opt vim.wo
-  ---@param winid integer the window id of the source window, NOT minimap window
+  ---@param winid integer the window id of the source window, NOT the minimap window
   winopt = function(opt, winid) end,
 
-  ---Overrite the default bufopt
+  --- Override the default buffer options
   ---@param opt vim.bo
-  ---@param bufnr integer the buffer id of the source buffer, NOT minimap buffer
+  ---@param bufnr integer the buffer id of the source buffer, NOT the minimap buffer
   bufopt = function(opt, bufnr) end,
 
   ---@type Neominimap.Map.Handler[]
@@ -660,18 +665,18 @@ neominimap components:
 ```lua
 local neominimap = require("neominimap.statusline")
 local minimap_extension = {
-  sections = {
-    lualine_c = {
-      neominimap.fullname,
-    },
-    lualine_z = {
-      neominimap.position,
-      "progress",
+    sections = {
+        lualine_c = {
+            neominimap.fullname,
+        },
+        lualine_z = {
+            neominimap.position,
+            "progress",
+        },
     },
-  },
-  filetypes = { "neominimap" },
+    filetypes = { "neominimap" },
 }
-require('lualine').setup { extensions = { minimap_extension } }
+require("lualine").setup({ extensions = { minimap_extension } })
 ```
 
 ### Using the Default Lualine Extension
@@ -680,7 +685,7 @@ Alternatively, you can use the default settings provided by the plugin:
 
 ```lua
 local minimap_extension = require("neominimap.statusline").lualine_default
-require('lualine').setup { extensions = { minimap_extension } }
+require("lualine").setup({ extensions = { minimap_extension } })
 ```
 
 The default Lualine extension provided by the plugin is structured as follows:

lua/neominimap/buffer/autocmds.lua

@@ -23,15 +23,47 @@ M.on_buf_new = function(args)
 end
 
 M.on_buf_unload = function(args)
+    local config = require("neominimap.config")
     local logger = require("neominimap.logger")
     logger.log(string.format("BufUnload event triggered for buffer %d.", args.buf), vim.log.levels.TRACE)
     local bufnr = tonumber(args.buf)
-    vim.schedule(function()
-        logger.log(string.format("Wiping out minimap for buffer %d.", bufnr), vim.log.levels.TRACE)
-        ---@cast bufnr integer
-        require("neominimap.buffer.internal").delete_minimap_buffer(bufnr)
-        logger.log(string.format("Minimap buffer wiped out for buffer %d.", bufnr), vim.log.levels.TRACE)
-    end)
+    if not bufnr then
+        return
+    end
+    local buffer_map = require("neominimap.buffer.buffer_map")
+    local sbufnr = buffer_map.get_source_bufnr(bufnr)
+    if sbufnr then
+        logger.log("This is a minimap buffer", vim.log.levels.TRACE)
+        if config.buffer.persist then
+            logger.log("Not deleting minimap buffer for source buffer.", vim.log.levels.TRACE)
+            vim.schedule(function()
+                logger.log(
+                    string.format("Refreshing minimap buffer for source buffer %d.", sbufnr),
+                    vim.log.levels.TRACE
+                )
+                require("neominimap.buffer.internal").refresh_minimap_buffer(sbufnr)
+                logger.log(
+                    string.format("Minimap buffer refreshed for source buffer %d.", sbufnr),
+                    vim.log.levels.TRACE
+                )
+            end)
+        else
+            logger.log("Deleting minimap buffer for source buffer.", vim.log.levels.TRACE)
+            local var = require("neominimap.variables")
+            var.b[sbufnr].enabled = false
+            vim.schedule(function()
+                logger.log(string.format("Deleting minimap buffer for source buffer %d.", sbufnr), vim.log.levels.TRACE)
+                require("neominimap.buffer.internal").delete_minimap_buffer(sbufnr)
+                logger.log(string.format("Minimap buffer deleted for source buffer %d.", sbufnr), vim.log.levels.TRACE)
+            end)
+        end
+    else
+        vim.schedule(function()
+            logger.log(string.format("Wiping out minimap for buffer %d.", bufnr), vim.log.levels.TRACE)
+            require("neominimap.buffer.internal").delete_minimap_buffer(bufnr)
+            logger.log(string.format("Minimap buffer wiped out for buffer %d.", bufnr), vim.log.levels.TRACE)
+        end)
+    end
 end
 
 M.on_text_change = function(args)

lua/neominimap/buffer/buffer_map.lua

@@ -19,6 +19,13 @@ M.get_source_bufnr = function(mbufnr)
     return nil
 end
 
+--- Check if current buffer is a minimap buffer
+---@param bufnr integer
+---@return boolean
+M.is_minimap_buffer = function(bufnr)
+    return M.get_source_bufnr[bufnr] ~= nil
+end
+
 --- Return the minimap buffer number attached to the given buffer
 ---@param bufnr integer
 ---@return integer?

lua/neominimap/config/internal.lua

@@ -12,14 +12,14 @@ local M = {
     -- Path to the log file
     log_path = vim.fn.stdpath("data") .. "/neominimap.log", ---@type string
 
-    -- Minimap will not be created for buffers of these types
+    -- Minimaps will not be created for buffers of these filetypes
     ---@type string[]
     exclude_filetypes = {
         "help",
         "bigfile", -- For Snacks.nvim
     },
 
-    -- Minimap will not be created for buffers of these types
+    -- Minimaps will not be created for buffers of these buftypes
     ---@type string[]
     exclude_buftypes = {
         "nofile",
@@ -29,19 +29,19 @@ local M = {
         "prompt",
     },
 
-    -- When false is returned, the minimap will not be created for this buffer
+    -- When this function returns false, the minimap will not be created for this buffer.
     ---@type fun(bufnr: integer): boolean
     buf_filter = function()
         return true
     end,
 
-    -- When false is returned, the minimap will not be created for this window
+    -- When this function returns false, the minimap will not be created for this window.
     ---@type fun(winid: integer): boolean
     win_filter = function()
         return true
     end,
 
-    -- When false is returned, the minimap will not be created for this tab
+    -- When this function returns false, the minimap will not be created for this tab.
     ---@type fun(tabid: integer): boolean
     tab_filter = function()
         return true
@@ -53,13 +53,17 @@ local M = {
     -- How many rows a dot should span
     y_multiplier = 1, ---@type integer
 
+    buffer = {
+        -- When true, the minimap will be recreated when you delete the buffer.
+        -- When false, the minimap will be disabled for the current buffer when you delete the minimap buffer.
+        persist = true, ---@type boolean
+    },
+
     ---@alias Neominimap.Config.LayoutType "split" | "float"
 
     --- Either `split` or `float`
-    --- When layout is set to `float`,
-    --- the minimap will be created in floating windows attached to all suitable windows
-    --- When layout is set to `split`,
-    --- the minimap will be created in one split window
+    --- When layout is set to `float`, minimaps will be created in floating windows attached to all suitable windows.
+    --- When layout is set to `split`, the minimap will be created in one split window per tab.
     layout = "float", ---@type Neominimap.Config.LayoutType
 
     --- Used when `layout` is set to `split`
@@ -72,8 +76,12 @@ local M = {
         ---@alias Neominimap.Config.SplitDirection "left" | "right" | "topleft" | "botright" | "aboveleft" | "rightbelow"
         direction = "right", ---@type Neominimap.Config.SplitDirection
 
-        ---Automatically close the split window when it is the last window
+        --- Automatically close the split window when it is the last window.
         close_if_last_window = false, ---@type boolean
+
+        --- When true, the split window will be recreated when you close it.
+        --- When false, the minimap will be disabled for the current tab when you close the minimap window.
+        persist = true, ---@type boolean
     },
 
     --- Used when `layout` is set to `float`
@@ -95,20 +103,23 @@ local M = {
         --- Accepts all usual border style options (e.g., "single", "double")
         --- @type string | string[] | [string, string][]
         window_border = "single",
+
+        -- When true, the floating window will be recreated when you close it.
+        -- When false, the minimap will be disabled for the current window when you close the minimap window.
+        persist = true, ---@type boolean
     },
 
-    -- For performance issue, when text changed,
-    -- minimap is refreshed after a certain delay
+    -- For performance, when text changes, the minimap is refreshed after a certain delay.
     -- Set the delay in milliseconds
     delay = 200, ---@type integer
 
     -- Sync the cursor position with the minimap
     sync_cursor = true, ---@type boolean
 
     click = {
-        -- Enable mouse click on minimap
+        -- Enable mouse click on the minimap
         enabled = false, ---@type boolean
-        -- Automatically switch focus to minimap when clicked
+        -- Automatically switch focus to the minimap when clicked
         auto_switch_focus = true, ---@type boolean
     },
 
@@ -173,18 +184,18 @@ local M = {
     },
 
     fold = {
-        -- Considering fold when rendering minimap
+        -- Consider folds when rendering the minimap
         enabled = true, ---@type boolean
     },
 
-    ---Overrite the default winopt
+    --- Override the default window options
     ---@param opt vim.wo
-    ---@param winid integer the window id of the source window, NOT minimap window
+    ---@param winid integer the window id of the source window, NOT the minimap window
     winopt = function(opt, winid) end,
 
-    ---Overrite the default bufopt
+    --- Override the default buffer options
     ---@param opt vim.bo
-    ---@param bufnr integer the buffer id of the source buffer, NOT minimap buffer
+    ---@param bufnr integer the buffer id of the source buffer, NOT the minimap buffer
     bufopt = function(opt, bufnr) end,
 
     ---@type Neominimap.Map.Handler[]