feat: allow configuring keymaps (#217)

Author: tjdevries

doc/sg.txt

@@ -47,15 +47,22 @@ sg.config                                                          *sg.config*
 
 
   Configuration Options: ~
-    {enable_cody}       (boolean?)   Enable/disable cody integration
-    {accept_tos}        (boolean?)   Accept the TOS without being prompted
-    {download_binaries} (boolean?)   Default true, download latest release
-                                     from Github
-    {node_executable}   (string?)    path to node executable
-    {skip_node_check}   (boolean?)   Useful if using other js runtime
-    {cody_agent}        (string?)    path to the cody-agent js bundle
-    {on_attach}         (function?)  function to run when attaching to
-                                     sg://<file> buffers
+    {enable_cody}       (boolean?)               Enable/disable cody
+                                                 integration
+    {accept_tos}        (boolean?)               Accept the TOS without being
+                                                 prompted
+    {download_binaries} (boolean?)               Default true, download latest
+                                                 release from Github
+    {node_executable}   (string?)                path to node executable
+    {skip_node_check}   (boolean?)               Useful if using other js
+                                                 runtime
+    {cody_agent}        (string?)                path to the cody-agent js
+                                                 bundle
+    {on_attach}         (function?)              function to run when
+                                                 attaching to sg://<file>
+                                                 buffers
+    {src_headers}       (table<string, string>)  Headers to be sent with each
+                                                 sg request
 
 
 
@@ -121,6 +128,12 @@ Default commands for interacting with Cody
 :CodyAsk ~
     Ask a question about the current selection.
 
+    Use from visual mode to pass the current selection
+
+                                                                *:CodyExplain*
+:CodyExplain ~
+    Ask a question about the current selection.
+
     Use from visual mode to pass the current selection
 
                                                                 *:CodyChat{!}*
@@ -129,6 +142,8 @@ Default commands for interacting with Cody
 
     If {!} is passed, will reset the chat and start a new chat conversation.
 
+    For more configuation options, see: `:help sg.cody.commands.chat`
+
                                                                  *:CodyToggle*
 :CodyToggle ~
     Toggles the current Cody Chat window.
@@ -137,25 +152,6 @@ Default commands for interacting with Cody
 :CodyTask {task_description} ~
     Instruct Cody to perform a task on selected text.
 
-                                                               *:CodyTaskView*
-:CodyTaskView ~
-    Opens the last active CodyTask.
-
-                                                             *:CodyTaskAccept*
-:CodyTaskAccept ~
-    Accepts the current CodyTask, removing it from the pending tasks list and
-    applying it to the selection the task was performed on. Can also be
-    triggered by pressing <CR> while a task is open.
-
-                                                               *:CodyTaskPrev*
-:CodyTaskPrev ~
-    Cycles to the previous CodyTask. Navigates to the appropriate buffer
-    location.
-
-                                                               *:CodyTaskNext*
-:CodyTaskNext ~
-    Cycles to the next CodyTask. Navigates to the appropriate buffer location.
-
                                                                 *:CodyRestart*
 :CodyRestart ~
     Restarts Cody and Sourcegraph, clearing all state.
@@ -176,15 +172,7 @@ M.setup({config})                                               *cody.setup()*
 ================================================================================
 LUA-COMMANDS                                                 *cody.lua-commands*
 
-commands.ask({message})                               *sg.cody.commands.ask()*
-    Ask Cody a question, without any selection
-
-
-    Parameters: ~
-        {message} (string[])
-
-
-commands.ask_range({bufnr}, {start_row}, {end_row}, {message}) *sg.cody.commands.ask_range()*
+commands.ask_range({bufnr}, {start_row}, {end_row}, {message}, {opts}) *sg.cody.commands.ask_range()*
     Ask Cody about the selected code
 
 
@@ -193,6 +181,7 @@ commands.ask_range({bufnr}, {start_row}, {end_row}, {message}) *sg.cody.commands
         {start_row} (number)
         {end_row}   (number)
         {message}   (string)
+        {opts}      (cody.ChatOpts)
 
 
 commands.autocomplete({request}, {callback}) *sg.cody.commands.autocomplete()*
@@ -204,27 +193,45 @@ commands.autocomplete({request}, {callback}) *sg.cody.commands.autocomplete()*
         {callback} (function(err: table, data: CodyAutocompleteResult))
 
 
-commands.float({bufnr}, {start_line}, {end_line}, {message}) *sg.cody.commands.float()*
-    Ask Cody about the selected code
+commands.chat({new}, {opts})                         *sg.cody.commands.chat()*
+    Open a cody chat
 
+    To configure keymaps, you can do something like:
 
-    Parameters: ~
-        {bufnr}      (number)
-        {start_line} (number)
-        {end_line}   (number)
-        {message}    (string)
+    This will disable <c-c> in insert mode from getting mapped by Cody.
 
+    >lua
+      require("sg.cody.commands").chat(true, {
+        keymaps = {
+          i = {
+            ["<c-c>"] = false,
+          },
+        },
+      })
+<
+
+    Additionally, you can map more functionality like so:
+
+    >lua
+      require("sg.cody.commands").chat(true, {
+        keymaps = {
+          i = {
+            ["hello"] = { "Says Hello", function(chat) print("hello") end },
+          },
+        },
+      })
+<
 
-commands.chat({name}, {opts})                        *sg.cody.commands.chat()*
-    Start a new CodyChat
 
 
     Parameters: ~
-        {name} (string?)
-        {opts} ({ reset: boolean }?)
+        {new}  (boolean)
+        {opts} (cody.ChatOpts)
+
+
+commands.toggle()                                  *sg.cody.commands.toggle()*
+    Toggle a Cody chat
 
-    Return: ~
-        CodyLayoutSplit
 
 
 commands.do_task({bufnr}, {start_line}, {end_line}, {message}) *sg.cody.commands.do_task()*
@@ -243,16 +250,6 @@ commands.history()                                *sg.cody.commands.history()*
 
 
 
-commands.add_context({start_line}, {end_line}, {state}) *sg.cody.commands.add_context()*
-    Add context to an existing state
-
-
-    Parameters: ~
-        {start_line} (any)
-        {end_line}   (any)
-        {state}      (CodyState?)
-
-
 commands.focus_history()                    *sg.cody.commands.focus_history()*
     Focus the currently active history window.
 
@@ -319,38 +316,16 @@ Default commands for interacting with Sourcegraph
     Run a search. For more sourcegraph search syntax, refer to online
     documentation
 
+                                                     *:CodyIgnoreNotification*
+:CodyIgnoreNotification ~
+    Ingore particular notifications
+
 
 
 
 ================================================================================
 RPC                                                                     *sg.rpc*
 
-rpc.complete({snippet}, {opts})                            *sg.rpc.complete()*
-    Complete a single string snippet
-
-
-
-    Parameters: ~
-        {snippet} (string)               Code to send as the prompt
-        {opts}    ({ prefix: string? })
-
-    Return: ~
-        string?: The error
-        string?: The completion
-
-
-rpc.repository({name})                                   *sg.rpc.repository()*
-    Get the repository ID for a repo with a name
-
-
-    Parameters: ~
-        {name} (string)
-
-    Return: ~
-        string?: The error, if any
-        string?: The repository ID, if found
-
-
 rpc.get_entry({path}, {callback})                         *sg.rpc.get_entry()*
     Get an SgEntry based on a path
 

lua/sg/cody/commands.lua

@@ -62,6 +62,34 @@ commands.autocomplete = function(request, callback)
 end
 
 --- Open a cody chat
+---
+--- To configure keymaps, you can do something like:
+---
+--- This will disable <c-c> in insert mode from getting
+--- mapped by Cody.
+---
+--- <code=lua>
+---   require("sg.cody.commands").chat(true, {
+---     keymaps = {
+---       i = {
+---         ["<c-c>"] = false,
+---       },
+---     },
+---   })
+--- </code>
+---
+--- Additionally, you can map more functionality like so:
+---
+--- <code=lua>
+---   require("sg.cody.commands").chat(true, {
+---     keymaps = {
+---       i = {
+---         ["hello"] = { "Says Hello", function(chat) print("hello") end },
+---       },
+---     },
+---   })
+--- </code>
+---
 ---@param new boolean
 ---@param opts cody.ChatOpts
 commands.chat = function(new, opts)

lua/sg/cody/plugin/commands.lua

@@ -98,6 +98,8 @@ commands.CodyExplain = {
 --- State a new cody chat, with an optional {title}
 ---
 --- If {!} is passed, will reset the chat and start a new chat conversation.
+---
+--- For more configuation options, see: `:help sg.cody.commands.chat`
 ---@command ]]
 commands.CodyChat = {
   function(command)

lua/sg/cody/rpc/chat.lua

@@ -13,11 +13,15 @@ local Typewriter = require "sg.components.typewriter"
 ---@type cody.Chat?
 local last_chat = nil
 
+---@alias cody.ChatKeymap fun(self: cody.Chat): nil
+---@alias cody.ChatMapping { [1]: string, [2]: cody.ChatKeymap } | false
+
 ---@class cody.ChatOpts
 ---@field id? string: ID sent from cody-agent
 ---@field name? string
 ---@field model? string: The name of the model to set for the conversation
 ---@field interval? number: The interval (in ms) to send a message
+---@field keymaps? table<string, table<string, cody.ChatMapping>>: Table of mode, key -> function
 ---@field window_type? "float" | "split" | "hover"
 ---@field window_opts? { width: number, height: number, split_cmd: string? }
 
@@ -158,6 +162,20 @@ function Chat:_add_prompt_keymaps()
     keymaps.help(bufnr)
   end)
 
+  local keymap_overrides = self.opts.keymaps or {}
+  for mode, overrides in pairs(keymap_overrides) do
+    for key, value in pairs(overrides) do
+      if value then
+        local desc, func = unpack(value)
+        keymaps.map(bufnr, mode, key, desc, function()
+          func(self)
+        end)
+      else
+        keymaps.del(bufnr, mode, key)
+      end
+    end
+  end
+
   -- TODO: Need to write a bit more stuff to manage this
   -- keymaps.map(bufnr, "n", "<space>m", function()
   --   rpc.request("webview/receiveMessage", {

lua/sg/keymaps.lua

@@ -114,4 +114,14 @@ M.help = function(bufnr)
   end)
 end
 
+M.del = function(bufnr, mode, key)
+  vim.keymap.del(mode, key, { buffer = bufnr })
+
+  store[bufnr].maps = vim.tbl_filter(function(map)
+    return map.mode ~= mode
+      or vim.api.nvim_replace_termcodes(map.key, true, false, true)
+        ~= vim.api.nvim_replace_termcodes(key, true, false, true)
+  end, store[bufnr].maps)
+end
+
 return M

scratch/test-keymap.lua

@@ -0,0 +1,7 @@
+require("sg.cody.commands").chat(true, {
+  keymaps = {
+    i = {
+      ["<c-c>"] = false,
+    },
+  },
+})