feat: default buffer opts

Author: shortcuts

doc/search-and-replace.txt

@@ -11,24 +11,34 @@ Default values:
   SearchAndReplace.options = {
       -- Prints useful logs about what event are triggered, and reasons actions are executed.
       debug = false,
+      -- When true, the opened replace prompt will be in 'normal' mode instead of 'insert' mode.
+      default_replace_prompt_to_normal_mode = false,
+      -- When true, the value being replaced is set as the default prompt buffer value.
+      default_replace_prompt_to_selection = false,
       -- Creates mappings for you to easily interact with the exposed commands.
       ---@type table
       mappings = {
           -- When `true`, creates all the mappings that are not set to `false`.
           ---@type boolean
           enabled = false,
-          -- Sets a global mapping to Neovim, which will trigger the "by pattern" replace function.
+          -- Sets a global mapping to Neovim, which will trigger the "by reference" replace function.
           -- When `false`, the mapping is not created.
           ---@type string
-          search_and_replace_by_pattern = "<Leader>srp",
-          -- Sets a global mapping to Neovim, which will trigger the "by reference" replace function.
+          search_and_replace_by_pattern = "<Leader>srr",
+          -- Sets a global mapping to Neovim, which will trigger the "by pattern" replace function
+          -- for the word under the cursor or the current visual selection.
+          -- When `false`, the mapping is not created.
+          ---@type string
+          replace_by_pattern = "<Leader>rp",
+          -- Sets a global mapping to Neovim, which will trigger the "by reference" replace function
+          -- for the word under the cursor or the current visual selection.
           -- When `false`, the mapping is not created.
           ---@type string
-          search_and_replace_by_reference = "<Leader>srr",
+          replace_by_reference = "<Leader>rr",
           -- Sets a global mapping to Neovim, which will trigger the "undo" function.
           -- When `false`, the mapping is not created.
           ---@type string
-          undo = "<Leader>sru",
+          replace_undo = "<Leader>ru",
       },
   }
 

lua/search-and-replace/config.lua

@@ -8,24 +8,34 @@ local SearchAndReplace = {}
 SearchAndReplace.options = {
     -- Prints useful logs about what event are triggered, and reasons actions are executed.
     debug = false,
+    -- When true, the opened replace prompt will be in 'normal' mode instead of 'insert' mode.
+    default_replace_prompt_to_normal_mode = false,
+    -- When true, the value being replaced is set as the default prompt buffer value.
+    default_replace_prompt_to_selection = false,
     -- Creates mappings for you to easily interact with the exposed commands.
     ---@type table
     mappings = {
         -- When `true`, creates all the mappings that are not set to `false`.
         ---@type boolean
         enabled = false,
-        -- Sets a global mapping to Neovim, which will trigger the "by pattern" replace function.
+        -- Sets a global mapping to Neovim, which will trigger the "by reference" replace function.
         -- When `false`, the mapping is not created.
         ---@type string
-        search_and_replace_by_pattern = "<Leader>srp",
-        -- Sets a global mapping to Neovim, which will trigger the "by reference" replace function.
+        search_and_replace_by_pattern = "<Leader>srr",
+        -- Sets a global mapping to Neovim, which will trigger the "by pattern" replace function
+        -- for the word under the cursor or the current visual selection.
+        -- When `false`, the mapping is not created.
+        ---@type string
+        replace_by_pattern = "<Leader>rp",
+        -- Sets a global mapping to Neovim, which will trigger the "by reference" replace function
+        -- for the word under the cursor or the current visual selection.
         -- When `false`, the mapping is not created.
         ---@type string
-        search_and_replace_by_reference = "<Leader>srr",
+        replace_by_reference = "<Leader>rr",
         -- Sets a global mapping to Neovim, which will trigger the "undo" function.
         -- When `false`, the mapping is not created.
         ---@type string
-        undo = "<Leader>sru",
+        replace_undo = "<Leader>ru",
     },
 }
 
@@ -83,9 +93,10 @@ function SearchAndReplace.setup(options)
     SearchAndReplace.options = SearchAndReplace.defaults(options or {})
 
     register_mappings(SearchAndReplace.options.mappings, {
-        search_and_replace_by_pattern = ":SearchAndReplaceByPattern<CR>",
         search_and_replace_by_reference = ":SearchAndReplaceByReference<CR>",
-        undo = ":SearchAndReplaceUndo<CR>",
+        replace_by_pattern = ":ReplaceByPattern<CR>",
+        replace_by_reference = ":ReplaceByReference<CR>",
+        replace_undo = ":ReplaceUndo<CR>",
     })
 
     return SearchAndReplace.options

lua/search-and-replace/init.lua

@@ -3,6 +3,10 @@ local config = require("search-and-replace.config")
 
 local SearchAndReplace = {}
 
+function SearchAndReplace.search_and_replace_by_pattern()
+    main.search_and_replace_by_pattern("search and replace by pattern")
+end
+
 function SearchAndReplace.replace_by_pattern()
     main.replace_by_pattern("by pattern")
 end
@@ -11,8 +15,8 @@ function SearchAndReplace.replace_by_references()
     main.replace_by_references("by reference")
 end
 
-function SearchAndReplace.undo()
-    main.undo("undo")
+function SearchAndReplace.replace_undo()
+    main.undo("replace undo")
 end
 
 function SearchAndReplace.setup(opts)

lua/search-and-replace/main.lua

@@ -4,9 +4,28 @@ local state = require("search-and-replace.state")
 -- o methods
 local main = {}
 
---- Replace the word under cursor in the current project.
+--- Opens the prompt for a vimgrep term to apply in the current project, then an other
+--- prompt to replace by pattern.
 ---
---- @param scope string: o identifier for logging purposes.
+--- @param scope string: identifier for logging purposes.
+---@private
+function main.search_and_replace_by_pattern(scope)
+    state.init(state)
+
+    state.create_buffer(state, scope, function(selection, replace)
+        selection = selection or ""
+        vim.cmd("vimgrep /" .. selection .. "/g **")
+        if state.backup_qflist(state, scope) then
+            api.replace(selection, replace)
+        end
+    end)
+
+    state.create_window(state, scope)
+end
+
+--- Replaces the word under cursor or current visual selection in the current project.
+---
+--- @param scope string: identifier for logging purposes.
 ---@private
 function main.replace_by_pattern(scope)
     state.init(state)
@@ -22,9 +41,9 @@ function main.replace_by_pattern(scope)
     state.create_window(state, scope)
 end
 
---- Replace the word under cursor by references using vim.lsp.buf.references().
+--- Replaces the word under cursor or current visual selection using vim.lsp.buf.references().
 ---
---- @param scope string: o identifier for logging purposes.
+--- @param scope string: identifier for logging purposes.
 ---@private
 function main.replace_by_references(scope)
     state.init(state)
@@ -46,11 +65,11 @@ function main.replace_by_references(scope)
     state.create_window(state, scope)
 end
 
---- Undoes the last `replace_*` operation by restoring the saved backup.
+--- Restores the backup files of the last `replace_*` operation.
 ---
---- @param scope string: o identifier for logging purposes.
+--- @param scope string: identifier for logging purposes.
 ---@private
-function main.undo(scope)
+function main.replace_undo(scope)
     state.restore_backup(state, scope)
 end
 

lua/search-and-replace/state.lua

@@ -70,14 +70,15 @@ function state:backup_qflist(scope)
                 vim.cmd("silent! wundo " .. vim.fn.fnameescape(tmpfile))
 
                 self.backup[name] = { bufnr = bufnr, tmp = tmpfile, seq = seq }
-                log.debug(scope, "saved undo for %s -> %s (seq=%d)", name, tmpfile, seq)
+                -- keep for debug but way too spammy
+                -- log.debug(scope, "saved undo for '%s' -> '%s' with seq '%d'", name, tmpfile, seq)
 
                 total = total + 1
             end
         end
     end
 
-    log.debug(scope, "stored %d items in backup", total)
+    log.debug(scope, "stored '%d' items in backup", total)
 
     return true
 end
@@ -92,10 +93,10 @@ function state:restore_backup(scope)
         return
     end
 
-    log.debug(scope, "restoring %d items", vim.fn.len(self.backup))
+    log.debug(scope, "restoring '%d' items", vim.fn.len(self.backup))
 
     for name, data in pairs(self.backup) do
-        log.debug(scope, "restoring %s", name)
+        log.debug(scope, "restoring '%s'", name)
 
         if vim.api.nvim_buf_is_valid(data.bufnr) then
             vim.api.nvim_set_current_buf(data.bufnr)
@@ -104,12 +105,12 @@ function state:restore_backup(scope)
             vim.cmd("update")
             log.debug(
                 scope,
-                "restored undo for %s (seq=%d)",
+                "restored undo for '%s'",
                 vim.api.nvim_buf_get_name(data.bufnr),
                 data.seq
             )
         else
-            log.debug(scope, "skipped %s (invalid buffer or missing file)", name)
+            log.debug(scope, "skipped '%s' (invalid buffer or missing file)", name)
         end
     end
 
@@ -138,7 +139,16 @@ function state:create_buffer(scope, cb)
                 end
             end)
 
-            vim.api.nvim_command("startinsert!")
+            if not _G.SearchAndReplace.config.default_replace_prompt_to_normal_mode then
+                vim.api.nvim_command("startinsert!")
+            end
+
+            if
+                _G.SearchAndReplace.config.default_replace_prompt_to_selection
+                and self.selection ~= ""
+            then
+                vim.api.nvim_buf_set_text(self.buffer, 0, 0, 0, 0, { self.selection })
+            end
         end,
         group = self.augroup_name,
         desc = "Keeps track of the state after entering new windows",
@@ -149,15 +159,10 @@ function state:create_buffer(scope, cb)
 
         cb(self.selection, replace)
 
-        log.debug(scope, "replace done")
+        log.debug(scope, "replace with '%s' done", replace)
     end)
 
-    vim.keymap.set({ "i", "n" }, "<Esc>", function()
-        log.debug(scope, "requested closing")
-        self.cleanup(self, scope)
-    end, { buffer = self.buffer })
-
-    log.debug(scope, "prompt buffer created")
+    log.debug(scope, "prompt buffer created, searching for '%s'", self.selection)
 
     self.save(self)
 end
@@ -170,19 +175,19 @@ function state:create_window(scope)
     self.window = vim.api.nvim_open_win(self.buffer, true, {
         style = "minimal",
         relative = "editor",
-        width = vim.o.columns,
+        width = math.floor(vim.o.columns / 3),
         height = 1,
         row = math.floor((vim.o.lines - 1) / 2),
-        col = math.floor(vim.o.columns / 2),
+        col = math.floor(vim.o.columns / 3),
         border = "rounded",
-        title = string.format('Replace %s: "%s"', scope, self.selection),
+        title = string.format("Replacing '%s'", self.selection),
         title_pos = "center",
     })
     vim.keymap.set("i", "<Esc>", function()
         vim.api.nvim_win_close(self.window, true)
     end, { buffer = self.buffer })
 
-    log.debug(scope, "window for buffer %d created", self.buffer)
+    log.debug(scope, "window for buffer '%d' created", self.buffer)
 
     self.save(self)
 end
@@ -207,7 +212,9 @@ function state:cleanup(scope)
 
     self.reset(self)
 
-    vim.api.nvim_command("stopinsert")
+    if not _G.SearchAndReplace.config.default_replace_prompt_to_normal_mode then
+        vim.api.nvim_command("stopinsert")
+    end
 end
 
 return state

plugin/search-and-replace.lua

@@ -5,14 +5,14 @@ end
 
 _G.SearchAndReplaceLoaded = true
 
-vim.api.nvim_create_user_command("SearchAndReplaceByPattern", function()
+vim.api.nvim_create_user_command("ReplaceByPattern", function()
     require("search-and-replace").replace_by_pattern()
 end, { range = true })
 
-vim.api.nvim_create_user_command("SearchAndReplaceByReferences", function()
+vim.api.nvim_create_user_command("ReplaceByReferences", function()
     require("search-and-replace").replace_by_references()
 end, { range = true })
 
-vim.api.nvim_create_user_command("SearchAndReplaceUndo", function()
+vim.api.nvim_create_user_command("ReplaceUndo", function()
     require("search-and-replace").undo()
 end, {})