feat(sidebar): Enhance terminal switching with active-only navigation

Co-authored-by: Qwen-Coder <qwen-coder@alibabacloud.com>

Author: gutsav

README.md

@@ -44,6 +44,35 @@ Install with your favorite plugin manager:
 - `:GeminiSend` - Send selected text to AI (use in visual mode)
 - `:GeminiSendLineDiagnostic` - Send line diagnostics to AI
 - `:GeminiSendFileDiagnostic` - Send file diagnostics to AI
+- `:GeminiSwitchSidebarStyle` - Switch the appearance/style of the sidebar
+
+### Sidebar Terminal Switching
+When multiple commands are configured (e.g., both `gemini` and `qwen`), you can switch between active sidebar terminals using default key mappings:
+
+- `<M-]>` - Switch to the next active terminal (Alt + ])
+- `<M-[>` - Switch to the previous active terminal (Alt + [)
+
+To customize these key bindings, you can override the default mappings in your setup function:
+
+```lua
+require("gemini").setup({
+  cmds = { "gemini", "qwen" },
+  -- Override default key mappings
+  on_buf = function(buf)
+    -- Add your own custom mappings
+    vim.api.nvim_buf_set_keymap(buf, 't', '<Tab>', 
+      '<Cmd>lua require("gemini.ideSidebar").switchSidebar()<CR>', 
+      { noremap = true, silent = true }
+    )
+    vim.api.nvim_buf_set_keymap(buf, 't', '<S-Tab>', 
+      '<Cmd>lua require("gemini.ideSidebar").switchSidebar("prev")<CR>', 
+      { noremap = true, silent = true }
+    )
+  end
+})
+```
+
+**Note:** Be aware that `<Tab>` and `<S-Tab>` may already be mapped to other functionality by the Gemini/Qwen CLIs themselves, so using these keys for terminal switching might interfere with their built-in features. Consider using alternative key bindings such as `<C-Tab>` and `<C-S-Tab>` or the default Alt-based mappings instead.
 
 ### Diff Management
 When AI suggests changes, you can:

lua/gemini/announcements/v0.7.1_release.md

@@ -0,0 +1,36 @@
+# v0.7.1 Release Announcement
+
+## 🎉 Improvements
+
+### Enhanced Sidebar Terminal Switching
+The sidebar terminal switching functionality has been improved with more reliable behavior:
+- Only switches between *active* terminals (no more spawning new processes when switching)
+- Supports forward and backward navigation between active terminals
+- Better safety checks to prevent errors when few terminals are active
+
+## ⚠️ Breaking Changes
+
+### Behavior Change
+- **Old**: `<Tab>` would hide current terminal and spawn/show the next one in the list
+- **New**: `<M-]>` (Alt+]) and `<M-[>` (Alt+[) only switch between already *active* terminals without spawning new processes
+
+### Function Renamed
+- **Old**: `require('gemini.ideSidebar').switchTerms()`
+- **New**: `require('gemini.ideSidebar').switchSidebar()`
+
+## 🔄 What You Need to Do
+
+### If You're Using the Function Manually
+If you were calling `switchTerms()` manually in your configuration, update your code:
+
+```lua
+-- Change from this:
+require('gemini.ideSidebar').switchTerms()
+
+-- To this:
+require('gemini.ideSidebar').switchSidebar([direction])
+-- where direction can be 'next' (default) or 'prev'
+```
+
+### For Key Binding Customization
+If you want to customize the terminal switching key bindings, see the updated README documentation which shows how to override the default Alt-based mappings.

lua/gemini/ideSidebar.lua

@@ -450,19 +450,34 @@ function ideSidebar.switchToCli(arg)
   end
 end
 
---- Switch to next sidebar terminal in command list
--- Hide current terminal and open next one in list
--- Used when multiple commands configured and Tab pressed in terminal mode
+--- Switch between active sidebar terminals
+-- Switch to the next or previous active terminal in the list
+-- Used when multiple commands are configured and key mappings are triggered
+-- @param direction string Optional, 'next' or 'prev', defaults to 'next'
 -- @return nil
-function ideSidebar.switchTerms()
-  local opts = ideSidebarState.terminalOpts[ideSidebarState.lastActiveIdx]
-  terminal.create(opts.cmd, opts):hide()
-  ideSidebarState.lastActiveIdx = (
-    ideSidebarState.lastActiveIdx % #ideSidebarState.terminalOpts
-  ) + 1
+function ideSidebar.switchSidebar(direction)
+  local activeSidebarTermIds = {}
+  local currentActiveIndex = -1
+  for idx, opts in ipairs(ideSidebarState.terminalOpts) do
+    local term = terminal.getActiveTerminals()[opts.id]
+    if term then
+      local activeInfo = { id = opts.id, idx = idx }
+      table.insert(activeSidebarTermIds, activeInfo)
+      -- Track the position of the currently active terminal in the active list
+      if idx == ideSidebarState.lastActiveIdx then
+        currentActiveIndex = #activeSidebarTermIds
+      end
+    end
+  end
 
-  local nextOpts = ideSidebarState.terminalOpts[ideSidebarState.lastActiveIdx]
-  terminal.create(nextOpts.cmd, nextOpts):show()
+  -- If there are less than 2 active sidebar terminals, do nothing
+  if #activeSidebarTermIds < 2 then return end
+  direction = direction or 'next'
+  local directionInt = (direction:lower() == 'prev' and -1 or 1)
+  local switchIndex = (
+    (currentActiveIndex - 1 + directionInt) % #activeSidebarTermIds
+  ) + 1
+  ideSidebar.switchToCli('sidebar ' .. activeSidebarTermIds[switchIndex].idx)
 end
 
 --- Toggle the sidebar terminal
@@ -615,7 +630,6 @@ function ideSidebar.setup(opts)
   for idx, cmd in ipairs(opts.cmds) do
     local termOpts =
       vim.tbl_deep_extend('force', vim.deepcopy(opts), { cmd = cmd })
-    local onBuffer = termOpts.on_buf
     local name = string.format('%s-ngc-%d(%s)', cwdBase, idx, cmd)
 
     termOpts.name = name
@@ -640,14 +654,25 @@ function ideSidebar.setup(opts)
       ideSidebar.createDeterministicId(termOpts.cmd, termOpts.env, idx)
 
     if #opts.cmds > 1 then
+      -- Add default keymaps for switching between active sidebar terminals
+      -- Users can define their own on_buf function to override these keymaps
+      local onBuffer = termOpts.on_buf
       termOpts.on_buf = function(buf)
         vim.api.nvim_buf_set_keymap(
           buf,
           't',
-          '<Tab>',
-          '<Cmd>lua require("gemini.ideSidebar").switchTerms()<CR>', -- Corrected escaping for nested quotes
+          '<M-]>',
+          '<Cmd>lua require("gemini.ideSidebar").switchSidebar()<CR>',
+          { noremap = true, silent = true }
+        )
+        vim.api.nvim_buf_set_keymap(
+          buf,
+          't',
+          '<M-[>',
+          '<Cmd>lua require("gemini.ideSidebar").switchSidebar("prev")<CR>',
           { noremap = true, silent = true }
         )
+        -- Call user's custom on_buf function if provided
         if type(onBuffer) == 'function' then onBuffer(buf) end
       end
     end

tests/ideSidebar_spec.lua

@@ -211,8 +211,8 @@ describe('ideSidebar', function()
     end)
   end)
 
-  describe('switchTerms method', function()
-    it('should hide current terminal and show next one', function()
+  describe('switchSidebar method', function()
+    it('should switch to the next active terminal', function()
       -- Setup multiple commands to have multiple terminals to switch between
       ideSidebar.setup({ cmds = { 'gemini', 'qwen' }, port = 12345 })
 
@@ -228,8 +228,8 @@ describe('ideSidebar', function()
         TERM_PROGRAM = 'vscode',
       }
 
-      local geminiId = ideSidebar.createDeterministicId('gemini', geminiEnv)
-      local qwenId = ideSidebar.createDeterministicId('qwen', qwenEnv)
+      local geminiId = ideSidebar.createDeterministicId('gemini', geminiEnv, 1)
+      local qwenId = ideSidebar.createDeterministicId('qwen', qwenEnv, 2)
 
       local geminiTerm = {
         hide = spy.new(function() end),
@@ -247,22 +247,115 @@ describe('ideSidebar', function()
 
       terminalMock.getActiveTerminals = function() return activeTerminals end
 
-      -- Mock terminal.create to return the correct terminals
-      local originalCreate = terminalMock.create
-      terminalMock.create = spy.new(function(cmd, config)
-        if cmd == 'gemini' then
-          return geminiTerm
-        else
-          return qwenTerm
-        end
-      end)
+      -- Spy on switchToCli to verify it's called with the correct parameters
+      local switchToCliSpy = spy.new(function() end)
+      local originalSwitchToCli = ideSidebar.switchToCli
+      ideSidebar.switchToCli = switchToCliSpy
+
+      -- Call switchSidebar (with default 'next' direction)
+      ideSidebar.switchSidebar()
+
+      -- Check that switchToCli was called with the correct parameters
+      assert.spy(switchToCliSpy).was.called(1)
+      local args = switchToCliSpy.calls[1]
+      assert.truthy(string.find(args.vals[1] or '', 'sidebar'))
+
+      -- Restore original function
+      ideSidebar.switchToCli = originalSwitchToCli
+    end)
+
+    it(
+      'should switch to the previous active terminal when direction is prev',
+      function()
+        -- Setup multiple commands to have multiple terminals to switch between
+        ideSidebar.setup({ cmds = { 'gemini', 'qwen' }, port = 12345 })
+
+        -- Create mock terminals
+        local geminiEnv = {
+          GEMINI_CLI_IDE_WORKSPACE_PATH = '/test/dir',
+          GEMINI_CLI_IDE_SERVER_PORT = '12345',
+          TERM_PROGRAM = 'vscode',
+        }
+        local qwenEnv = {
+          QWEN_CODE_IDE_WORKSPACE_PATH = '/test/dir',
+          QWEN_CODE_IDE_SERVER_PORT = '12345',
+          TERM_PROGRAM = 'vscode',
+        }
+
+        local geminiId =
+          ideSidebar.createDeterministicId('gemini', geminiEnv, 1)
+        local qwenId = ideSidebar.createDeterministicId('qwen', qwenEnv, 2)
+
+        local geminiTerm = {
+          hide = spy.new(function() end),
+          show = spy.new(function() end),
+        }
+
+        local qwenTerm = {
+          hide = spy.new(function() end),
+          show = spy.new(function() end),
+        }
+
+        local activeTerminals = {}
+        activeTerminals[geminiId] = geminiTerm
+        activeTerminals[qwenId] = qwenTerm
 
-      -- Call switchTerms
-      ideSidebar.switchTerms()
+        terminalMock.getActiveTerminals = function() return activeTerminals end
 
-      -- Check that hide was called on the first terminal and show on the second
-      assert.spy(geminiTerm.hide).was.called(1)
-      assert.spy(qwenTerm.show).was.called(1)
+        -- Spy on switchToCli to verify it's called with the correct parameters
+        local switchToCliSpy = spy.new(function() end)
+        local originalSwitchToCli = ideSidebar.switchToCli
+        ideSidebar.switchToCli = switchToCliSpy
+
+        -- Call switchSidebar with 'prev' direction
+        ideSidebar.switchSidebar('prev')
+
+        -- Check that switchToCli was called with the correct parameters
+        assert.spy(switchToCliSpy).was.called(1)
+        local args = switchToCliSpy.calls[1]
+        assert.truthy(string.find(args.vals[1] or '', 'sidebar'))
+
+        -- Restore original function
+        ideSidebar.switchToCli = originalSwitchToCli
+      end
+    )
+
+    it('should not switch if there are less than 2 active terminals', function()
+      -- Setup multiple commands to have multiple terminals but only one active
+      ideSidebar.setup({ cmds = { 'gemini', 'qwen' }, port = 12345 })
+
+      -- Create mock terminal for only one command
+      local geminiEnv = {
+        GEMINI_CLI_IDE_WORKSPACE_PATH = '/test/dir',
+        GEMINI_CLI_IDE_SERVER_PORT = '12345',
+        TERM_PROGRAM = 'vscode',
+      }
+
+      local geminiId = ideSidebar.createDeterministicId('gemini', geminiEnv)
+
+      local geminiTerm = {
+        hide = spy.new(function() end),
+        show = spy.new(function() end),
+      }
+
+      local activeTerminals = {}
+      activeTerminals[geminiId] = geminiTerm
+
+      terminalMock.getActiveTerminals = function() return activeTerminals end
+
+      -- Spy on switchToCli to verify it's not called when less than 2 terminals are active
+      local switchToCliSpy = spy.new(function() end)
+      local originalSwitchToCli = ideSidebar.switchToCli
+      ideSidebar.switchToCli = switchToCliSpy
+
+      -- Call switchSidebar
+      ideSidebar.switchSidebar()
+
+      -- Check that switchToCli was not called because only one terminal is active
+      assert.spy(switchToCliSpy).was_not_called()
+
+      -- Restore original function
+      ideSidebar.switchToCli = originalSwitchToCli
     end)
   end)