chore(mappings): add options to reflect wiki changes (#349)

Signed-off-by: Aaron Pham <contact@aarnphm.xyz>

README.md

@@ -23,13 +23,14 @@ Install `avante.nvim` using [lazy.nvim](https://github.com/folke/lazy.nvim):
 {
   "yetone/avante.nvim",
   event = "VeryLazy",
+  lazy = false,
   opts = {
     -- add any opts here
   },
-  keys = { -- See https://github.com/yetone/avante.nvim/wiki#keymaps for more info
+  keys = {
     { "<leader>aa", function() require("avante.api").ask() end, desc = "avante: ask", mode = { "n", "v" } },
-    { "<leader>ar", function() require("avante.api").refresh() end, desc = "avante: refresh", mode = "v" },
+    { "<leader>ar", function() require("avante.api").refresh() end, desc = "avante: refresh" },
-    { "<leader>ae", function() require("avante.api").edit() end, desc = "avante: edit", mode = { "n", "v" } },
+    { "<leader>ae", function() require("avante.api").edit() end, desc = "avante: edit", mode = "v" },
   },
   dependencies = {
     "stevearc/dressing.nvim",
@@ -211,7 +212,7 @@ The following key bindings are available for use with `avante.nvim`:
 > [!NOTE]
 >
 > If you are using `lazy.nvim`, then all keymap here will be safely set, meaning if `<leader>aa` is already binded, then avante.nvim won't bind this mapping.
-> In this case, user will be responsible for setting up their own. See [notes on keymaps](https://github.com/yetone/avante.nvim/wiki#keymaps) for more details.
+> In this case, user will be responsible for setting up their own. See [notes on keymaps](https://github.com/yetone/avante.nvim/wiki#keymaps-and-api-i-guess) for more details.
 
 ## Highlight Groups
 

lua/avante/config.lua

@@ -66,10 +66,13 @@ M.defaults = {
   ---Specify the behaviour of avante.nvim
   ---1. auto_apply_diff_after_generation: Whether to automatically apply diff after LLM response.
   ---                                     This would simulate similar behaviour to cursor. Default to false.
-  ---2. auto_set_highlight_group: Whether to automatically set the highlight group for the current line. Default to true.
+  ---2. auto_set_keymaps                : Whether to automatically set the keymap for the current line. Default to true.
-  ---3. support_paste_from_clipboard: Whether to support pasting image from clipboard. This will be determined automatically based whether img-clip is available or not.
+  ---                                     Note that avante will safely set these keymap. See https://github.com/yetone/avante.nvim/wiki#keymaps-and-api-i-guess for more details.
+  ---3. auto_set_highlight_group        : Whether to automatically set the highlight group for the current line. Default to true.
+  ---4. support_paste_from_clipboard    : Whether to support pasting image from clipboard. This will be determined automatically based whether img-clip is available or not.
   behaviour = {
     auto_set_highlight_group = true,
+    auto_set_keymaps = true,
     auto_apply_diff_after_generation = false,
     support_paste_from_clipboard = false,
   },

lua/avante/init.lua

@@ -28,13 +28,6 @@ H.commands = function()
   cmd("Ask", function()
     M.ask()
   end, { desc = "avante: ask AI for code suggestions" })
-  cmd("Close", function()
-    local sidebar, _ = M._get()
-    if not sidebar then
-      return
-    end
-    sidebar:close()
-  end, { desc = "avante: close chat window" })
   cmd("Edit", function()
     M.edit()
   end, { desc = "avante: edit selected block" })
@@ -61,6 +54,7 @@ H.keymaps = function()
     M.toggle.hint()
   end)
 
+  if Config.behaviour.auto_set_keymaps then
     Utils.safe_keymap_set({ "n", "v" }, Config.mappings.ask, function()
       M.ask()
     end, { desc = "avante: ask" })
@@ -77,6 +71,7 @@ H.keymaps = function()
       M.toggle.hint()
     end, { desc = "avante: toggle hint" })
   end
+end
 
 ---@class ApiCaller
 ---@operator call(...): any