chore(keymap): add explicit descriptions for default mappings

Author: dekaravanhoc

lua/opencode/config.lua

@@ -61,63 +61,83 @@ M.defaults = {
       ['<leader>o/'] = { 'quick_chat', desc = 'Quick chat with current context', mode = { 'n', 'x' } },
     },
     output_window = {
-      ['<esc>'] = { 'close' },
-      ['<C-c>'] = { 'cancel' },
-      [']]'] = { 'next_message' },
-      ['[['] = { 'prev_message' },
-      ['<tab>'] = { 'toggle_pane', mode = { 'n' } },
-      ['i'] = { 'focus_input' },
+      ['<esc>'] = { 'close', desc = 'Close Opencode windows' },
+      ['<C-c>'] = { 'cancel', desc = 'Cancel running request' },
+      [']]'] = { 'next_message', desc = 'Go to next message' },
+      ['[['] = { 'prev_message', desc = 'Go to previous message' },
+      ['<tab>'] = {
+        'toggle_pane',
+        mode = { 'n' },
+        desc = 'Toggle input/output panes',
+      },
+      ['i'] = { 'focus_input', desc = 'Focus input window' },
       ['gr'] = { 'references', desc = 'Browse code references' },
       ['<M-i>'] = { 'toggle_input', mode = { 'n' }, desc = 'Toggle input window' },
-      ['<M-r>'] = { 'cycle_variant', mode = { 'n' } },
-      ['<leader>oS'] = { 'select_child_session' },
-      ['<leader>oD'] = { 'debug_message' },
-      ['<leader>oO'] = { 'debug_output' },
-      ['<leader>ods'] = { 'debug_session' },
+      ['<M-r>'] = { 'cycle_variant', mode = { 'n' }, desc = 'Cycle model variants' },
+      ['<leader>oS'] = { 'select_child_session', desc = 'Select child session' },
+      ['<leader>oD'] = { 'debug_message', desc = 'Open raw message debug view' },
+      ['<leader>oO'] = { 'debug_output', desc = 'Open raw output debug view' },
+      ['<leader>ods'] = { 'debug_session', desc = 'Open raw session debug view' },
     },
     input_window = {
-      ['<cr>'] = { 'submit_input_prompt', mode = { 'n' } },
-      ['<S-cr>'] = { 'submit_input_prompt', mode = { 'n', 'i' } },
-      ['<esc>'] = { 'close' },
-      ['<C-c>'] = { 'cancel' },
-      ['~'] = { 'mention_file', mode = 'i' },
-      ['@'] = { 'mention', mode = 'i' },
-      ['/'] = { 'slash_commands', mode = 'i' },
-      ['#'] = { 'context_items', mode = 'i' },
-      ['<M-v>'] = { 'paste_image', mode = 'i' },
-      ['<tab>'] = { 'toggle_pane', mode = { 'n' } },
-      ['<up>'] = { 'prev_prompt_history', mode = { 'n', 'i' } },
-      ['<down>'] = { 'next_prompt_history', mode = { 'n', 'i' } },
-      ['<M-m>'] = { 'switch_mode', mode = { 'n', 'i' } },
-      ['<M-r>'] = { 'cycle_variant', mode = { 'n', 'i' } },
+      ['<cr>'] = { 'submit_input_prompt', mode = { 'n' }, desc = 'Submit prompt' },
+      ['<S-cr>'] = { 'submit_input_prompt', mode = { 'n', 'i' }, desc = 'Submit prompt' },
+      ['<esc>'] = { 'close', desc = 'Close Opencode windows' },
+      ['<C-c>'] = { 'cancel', desc = 'Cancel running request' },
+      ['~'] = { 'mention_file', mode = 'i', desc = 'Mention file in context' },
+      ['@'] = { 'mention', mode = 'i', desc = 'Open mention picker' },
+      ['/'] = { 'slash_commands', mode = 'i', desc = 'Open slash commands picker' },
+      ['#'] = { 'context_items', mode = 'i', desc = 'Open context items picker' },
+      ['<M-v>'] = { 'paste_image', mode = 'i', desc = 'Paste image from clipboard' },
+      ['<tab>'] = { 'toggle_pane', mode = { 'n' }, desc = 'Toggle input/output panes' },
+      ['<up>'] = {
+        'prev_prompt_history',
+        mode = { 'n', 'i' },
+        desc = 'Previous prompt history item',
+      },
+      ['<down>'] = {
+        'next_prompt_history',
+        mode = { 'n', 'i' },
+        desc = 'Next prompt history item',
+      },
+      ['<M-m>'] = { 'switch_mode', mode = { 'n', 'i' }, desc = 'Switch agent mode' },
+      ['<M-r>'] = { 'cycle_variant', mode = { 'n', 'i' }, desc = 'Cycle model variants' },
       ['<M-i>'] = { 'toggle_input', mode = { 'n', 'i' }, desc = 'Toggle input window' },
       ['gr'] = { 'references', desc = 'Browse code references' },
-      ['<leader>oS'] = { 'select_child_session' },
-      ['<leader>oD'] = { 'debug_message' },
-      ['<leader>oO'] = { 'debug_output' },
-      ['<leader>ods'] = { 'debug_session' },
+      ['<leader>oS'] = { 'select_child_session', desc = 'Select child session' },
+      ['<leader>oD'] = { 'debug_message', desc = 'Open raw message debug view' },
+      ['<leader>oO'] = { 'debug_output', desc = 'Open raw output debug view' },
+      ['<leader>ods'] = { 'debug_session', desc = 'Open raw session debug view' },
     },
     session_picker = {
-      rename_session = { '<C-r>' },
-      delete_session = { '<C-d>' },
-      new_session = { '<C-s>' },
+      rename_session = { '<C-r>', desc = 'Rename selected session' },
+      delete_session = { '<C-d>', desc = 'Delete selected sessions' },
+      new_session = { '<C-s>', desc = 'Create a new session' },
     },
     timeline_picker = {
-      undo = { '<C-u>', mode = { 'i', 'n' } },
-      fork = { '<C-f>', mode = { 'i', 'n' } },
+      undo = { '<C-u>', mode = { 'i', 'n' }, desc = 'Undo to selected message' },
+      fork = { '<C-f>', mode = { 'i', 'n' }, desc = 'Fork from selected message' },
     },
     history_picker = {
-      delete_entry = { '<C-d>', mode = { 'i', 'n' } },
-      clear_all = { '<C-X>', mode = { 'i', 'n' } },
+      delete_entry = {
+        '<C-d>',
+        mode = { 'i', 'n' },
+        desc = 'Delete selected history entries',
+      },
+      clear_all = { '<C-X>', mode = { 'i', 'n' }, desc = 'Clear all history entries' },
     },
     model_picker = {
-      toggle_favorite = { '<C-f>', mode = { 'i', 'n' } },
+      toggle_favorite = { '<C-f>', mode = { 'i', 'n' }, desc = 'Toggle model favorite' },
     },
     mcp_picker = {
-      toggle_connection = { '<C-t>', mode = { 'i', 'n' } },
+      toggle_connection = {
+        '<C-t>',
+        mode = { 'i', 'n' },
+        desc = 'Toggle MCP server connection',
+      },
     },
     quick_chat = {
-      cancel = { '<C-c>', mode = { 'i', 'n' } },
+      cancel = { '<C-c>', mode = { 'i', 'n' }, desc = 'Cancel active quick chat requests' },
     },
   },
   ui = {

lua/opencode/ui/dialog.lua

@@ -311,7 +311,9 @@ function Dialog:_setup_keymaps()
       if key and key ~= '' then
         vim.keymap.set('n', key, function()
           self:navigate(-1)
-        end, keymap_opts)
+        end, vim.tbl_extend('force', keymap_opts, {
+          desc = 'Dialog: navigate up',
+        }))
         table.insert(self._keymaps, key)
       end
     end
@@ -322,7 +324,9 @@ function Dialog:_setup_keymaps()
       if key and key ~= '' then
         vim.keymap.set('n', key, function()
           self:navigate(1)
-        end, keymap_opts)
+        end, vim.tbl_extend('force', keymap_opts, {
+          desc = 'Dialog: navigate down',
+        }))
         table.insert(self._keymaps, key)
       end
     end
@@ -331,14 +335,18 @@ function Dialog:_setup_keymaps()
   if keymaps.select and keymaps.select ~= '' then
     vim.keymap.set('n', keymaps.select, function()
       self:select()
-    end, keymap_opts)
+    end, vim.tbl_extend('force', keymap_opts, {
+      desc = 'Dialog: select option',
+    }))
     table.insert(self._keymaps, keymaps.select)
   end
 
   if keymaps.dismiss and keymaps.dismiss ~= '' then
     vim.keymap.set('n', keymaps.dismiss, function()
       self:dismiss()
-    end, keymap_opts)
+    end, vim.tbl_extend('force', keymap_opts, {
+      desc = 'Dialog: dismiss',
+    }))
     table.insert(self._keymaps, keymaps.dismiss)
   end
 
@@ -353,7 +361,9 @@ function Dialog:_setup_keymaps()
         end
         self._selected_index = i
         self._config.on_select(i)
-      end, number_keymap_opts)
+      end, vim.tbl_extend('force', number_keymap_opts, {
+        desc = 'Dialog: select option ' .. key,
+      }))
       table.insert(self._keymaps, key)
     end
   end