feat(grug-far-nvim)!: add more features and align with recommended spectre.nvim mappings (#1212)

Author: mehalter

lua/astrocommunity/search/grug-far-nvim/init.lua

@@ -1,3 +1,15 @@
+local default_opts = { instanceName = "main", transient = true }
+local function grug_far_open(opts)
+  local grug_far = require "grug-far"
+  opts = require("astrocore").extend_tbl(default_opts, opts)
+  if not grug_far.has_instance(opts.instanceName) then
+    grug_far.open(opts)
+  else
+    grug_far.open_instance(opts.instanceName)
+    if opts.prefills then grug_far.update_instance_prefills(opts.instanceName, opts.prefills, false) end
+  end
+end
+
 ---@type LazySpec
 return {
   "MagicDuck/grug-far.nvim",
@@ -12,17 +24,51 @@ return {
       "AstroNvim/astrocore",
       ---@param opts AstroCoreOpts
       opts = function(_, opts)
-        if not opts.mappings then opts.mappings = require("astrocore").empty_map_table() end
-        local maps, prefix = opts.mappings, "<Leader>r"
+        local maps, prefix = opts.mappings, "<Leader>s"
 
-        maps.n[prefix] = {
-          function() require("grug-far").open { transient = true } end,
-          desc = require("astroui").get_icon("GrugFar", 1, true) .. "Search and Replace",
+        maps.n[prefix] = { desc = require("astroui").get_icon("GrugFar", 1, true) .. "Search/Replace" }
+        maps.n[prefix .. "s"] = {
+          function() grug_far_open() end,
+          desc = "Search/Replace workspace",
+        }
+        maps.n[prefix .. "e"] = {
+          function()
+            local ext = require("astrocore.buffer").is_valid() and vim.fn.expand "%:e" or ""
+            grug_far_open {
+              prefills = { filesFilter = ext ~= "" and "*." .. ext or nil },
+            }
+          end,
+          desc = "Search/Replace filetype",
+        }
+        maps.n[prefix .. "f"] = {
+          function()
+            local filter = require("astrocore.buffer").is_valid() and vim.fn.expand "%" or nil
+            grug_far_open { prefills = { paths = filter } }
+          end,
+          desc = "Search/Replace file",
+        }
+        maps.n[prefix .. "w"] = {
+          function()
+            local current_word = vim.fn.expand "<cword>"
+            if current_word ~= "" then
+              grug_far_open {
+                startCursorRow = 4,
+                prefills = { search = vim.fn.expand "<cword>" },
+              }
+            else
+              vim.notify("No word under cursor", vim.log.levels.WARN, { title = "Grug-far" })
+            end
+          end,
+          desc = "Replace current word",
         }
-
         maps.x[prefix] = {
-          function() require("grug-far").open { transient = true, startCursorRow = 4 } end,
-          desc = require("astroui").get_icon("GrugFar", 1, true) .. "Search and Replace (current word)",
+          function()
+            local grug_far = require "grug-far"
+            local grug_opts = require("astrocore").extend_tbl(default_opts, { startCursorRow = 4 })
+            if grug_far.has_instance(grug_opts.instanceName) then grug_far.close_instance(grug_opts.instanceName) end
+            grug_far.with_visual_selection(grug_opts)
+          end,
+          desc = "Replace selection",
         }
       end,
     },
@@ -42,6 +88,47 @@ return {
       ---@type CatppuccinOptions
       opts = { integrations = { grug_far = true } },
     },
+    {
+      "folke/which-key.nvim",
+      optional = true,
+      opts = function(_, opts)
+        if not opts.disable then opts.disable = {} end
+        opts.disable.ft = require("astrocore").list_insert_unique(opts.disable.ft, { "grug-far" })
+      end,
+    },
+    {
+      "nvim-neo-tree/neo-tree.nvim",
+      optional = true,
+      opts = {
+        commands = {
+          grug_far_replace = function(state)
+            local node = state.tree:get_node()
+            grug_far_open {
+              prefills = {
+                path = node.type == "directory" and node:get_id() or vim.fn.fnamemodify(node:get_id(), ":h"),
+              },
+            }
+          end,
+        },
+        window = {
+          mappings = {
+            gS = "grug_far_replace",
+          },
+        },
+      },
+    },
+    {
+      "stevearc/oil.nvim",
+      optional = true,
+      opts = {
+        keymaps = {
+          gS = {
+            function() grug_far_open { prefills = { path = require("oil").get_current_dir() } } end,
+            desc = "Search/Replace in directory",
+          },
+        },
+      },
+    },
   },
   ---@param opts GrugFarOptionsOverride
   opts = function(_, opts)