enhance entering and exiting copy mode

Author: BrettKulp

README.md

@@ -83,12 +83,18 @@ Works similarly to tmux copy mode within opencode tui.
 
 <img src=".github/demo-copy-mode.gif" style="border: 1px solid #555; border-radius: 4px;" />
 
-- Enter copy mode with `<leader>v`.
+- Enter copy mode with `<leader>v` or `Ctr + w + k` to enter copy mode without
+scrolling the chat history to the bottom.
 - Navigate with `h` `j` `k` `l` or arrow keys (`Left` `Down` `Up` `Right`).
 - Press `v` / `V` to start character-wise or line-wise selection.
 - `y` yanks to the vim register.
 - `Enter` copies to the system clipboard.
 - `Escape` exits visual mode, `q` exits copy mode.
+- `i` exits copy mode without scrolling the chat history to the bottom and
+enters insert mode
+- `Ctrl + w + j` exits copy mode without scrolling the chat history to the
+bottom
+- 
 - `z` `zt` `zz` `zb` adjust copy-mode scroll positioning.
 - `H` / `M` / `L` jump to the top / middle / bottom of the viewport.
 

packages/opencode/src/cli/cmd/tui/component/prompt/index.tsx

@@ -89,7 +89,7 @@ export type PromptProps = {
   }
   copy?: {
     enter: () => void
-    exit: () => void
+    exit: (scrollToBottom?: boolean) => void
     visual: (mode: "char" | "line") => void
     yank: () => { text: string; linewise: boolean } | null
     copy: () => Promise<void> | void
@@ -365,6 +365,32 @@ export function Prompt(props: PromptProps) {
     return input.plainText.length > 0
   }
 
+  function handleNavigation(action: "up" | "down"){
+    if (!props.copy) return
+
+    if (vimState.isCopy()) {
+      const skipExit = vimState.skipExitOnModeChange()
+      const scrollToBottom = vimState.exitScrollToBottom()
+      vimState.setSkipExitOnModeChange(false)
+      vimState.setExitScrollToBottom(true)
+      vimState.setMode("normal")
+      if (!skipExit) {
+        props.copy.exit(scrollToBottom)
+      }
+      return
+    }
+
+    vimState.setMode("copy")
+    props.copy.enter()
+
+    if (action === "up"){
+      props.copy.move("up")
+    }
+    if (action === "down"){
+      props.copy.move("down")
+    }
+  }
+
   function promptJump(action: "top" | "bottom" | "high" | "middle" | "low") {
     if (!input || input.isDestroyed) return
     if (action === "top") {
@@ -417,6 +443,9 @@ export function Prompt(props: PromptProps) {
       if (action === "top") command.trigger("session.first")
       if (action === "bottom") command.trigger("session.last")
     },
+    navigate(action) {
+      handleNavigation(action)
+    },
     copy(action) {
       props.copy?.move(action)
     },
@@ -426,6 +455,9 @@ export function Prompt(props: PromptProps) {
     copyExitVisual() {
       props.copy?.exitVisual()
     },
+    copyExit(scrollToBottom = true) {
+      props.copy?.exit(scrollToBottom)
+    },
     copyYank() {
       const reg = props.copy?.yank()
       if (reg) vimState.setRegister(reg)
@@ -1390,7 +1422,13 @@ export function Prompt(props: PromptProps) {
                   if (vimState.isCopy()) {
                     const active = vimState.isCopy()
                     vim.handleKey(e)
-                    if (active && !vimState.isCopy()) props.copy?.exit()
+                    if (active && !vimState.isCopy()) {
+                      const skipExit = vimState.skipExitOnModeChange()
+                      const scrollToBottom = vimState.exitScrollToBottom()
+                      vimState.setSkipExitOnModeChange(false)
+                      vimState.setExitScrollToBottom(true)
+                      if (!skipExit) props.copy?.exit(scrollToBottom)
+                    }
                     if (!e.defaultPrevented) e.preventDefault()
                     return
                   }

packages/opencode/src/cli/cmd/tui/component/vim/vim-handler.ts

@@ -3,6 +3,7 @@ import type { createVimState, VimSnapshot } from "./vim-state"
 import type { TextareaRenderable } from "@opentui/core"
 import { vimScroll, type VimScroll } from "./vim-scroll"
 import { vimJump, type VimJump } from "./vim-motion-jump"
+import { vimWindowNavigation, type VimWindowNavigation } from "./vim-motion-window-navigation.ts"
 import {
   appendAfterCursor,
   appendLineEnd,
@@ -49,6 +50,7 @@ import {
 } from "./vim-motions"
 
 export type VimEvent = {
+
   name?: string
   shift?: boolean
   ctrl?: boolean
@@ -66,9 +68,11 @@ export function createVimHandler(input: {
   submit: () => void
   scroll: (action: VimScroll) => void
   jump: (action: VimJump) => void
+  navigate: (action: VimWindowNavigation) => void
   copy?: (action: VimCopyMove) => void
   copyVisual?: (mode: "char" | "line") => void
   copyExitVisual?: () => void
+  copyExit?: (scrollToBottom?: boolean) => void
   copyYank?: () => void
   copyCopy?: () => void
   copyIsVisual?: () => boolean
@@ -182,6 +186,16 @@ export function createVimHandler(input: {
       return true
     }
 
+    const navigation = vimWindowNavigation(event, input.state);
+    if (navigation.handled){
+      if (navigation.action) {
+        input.state.clearPending();
+        input.navigate(navigation.action);
+      }
+      event.preventDefault()
+      return true
+    }
+
     if (key === "escape") {
       if (input.state.isVisual()) {
         clearSelection(input.textarea())
@@ -715,8 +729,15 @@ export function createVimHandler(input: {
       return true
     }
 
+    // window navigation
+    if (key === "w" && hasModifier(event)) {
+      input.state.setPending("w");
+      event.preventDefault();
+      return true;
+    }
+
     return false
-  }
+ }
 
   function copyMotion(offset: number) {
     input.setCopyCol?.(offset)
@@ -740,6 +761,40 @@ export function createVimHandler(input: {
       return true
     }
 
+    if (key === "i") {
+      if (input.copyIsVisual?.()) {
+        input.copyExitVisual?.()
+        event.preventDefault()
+        return true
+      }
+      input.state.setSkipExitOnModeChange(true)
+      input.state.setExitScrollToBottom(false)
+      input.state.setMode("insert")
+      event.preventDefault()
+      input.copyExit?.(false)
+      return true
+    }
+
+    if (event.ctrl && input.state.pending() === "w" && key === "j") {
+      if (input.copyIsVisual?.()) {
+        input.copyExitVisual?.()
+        event.preventDefault()
+        return true
+      }
+      input.state.setSkipExitOnModeChange(true)
+      input.state.setExitScrollToBottom(false)
+      input.state.setMode("normal")
+      event.preventDefault()
+      input.copyExit?.(false)
+      return true
+    }
+
+    if (key === "w" && hasModifier(event)) {
+      input.state.setPending("w")
+      event.preventDefault()
+      return true
+    }
+
     const scroll = vimScroll(event)
     if (scroll) {
       input.scroll(scroll)
@@ -964,6 +1019,7 @@ export function createVimHandler(input: {
       return true
     }
 
+
     // repeat find
     if (key === ";") {
       const last = input.state.lastFind()

packages/opencode/src/cli/cmd/tui/component/vim/vim-motion-window-navigation.ts

@@ -0,0 +1,24 @@
+import type { VimEvent } from "./vim-handler"
+import type { createVimState } from "./vim-state"
+
+export type VimWindowNavigation = "up" | "down";
+
+export function vimWindowNavigation(event: VimEvent, state: ReturnType<typeof createVimState>) {
+  const key = event.name ?? "";
+
+  if (state.pending() === "w"){
+    if (key === "k") {
+      state.clearPending()
+      return { action: "up" as VimWindowNavigation, handled: true }
+    }
+
+    if (key === "j") {
+      state.clearPending()
+      return { action: "down" as VimWindowNavigation, handled: true }
+    }
+
+    return { handled: false };
+  }
+
+  return { handled: false };
+}

packages/opencode/src/cli/cmd/tui/component/vim/vim-state.ts

@@ -1,7 +1,7 @@
 import { createEffect, createMemo, createSignal, type Accessor } from "solid-js"
 
 export type VimMode = "normal" | "insert" | "replace" | "visual" | "visual-line" | "copy"
-export type VimPending = "" | "c" | "d" | "g" | "z" | "f" | "F" | "t" | "T" | "y"
+export type VimPending = "" | "c" | "d" | "g" | "z" | "f" | "F" | "t" | "T" | "y" | "w"
 export type VimFind = { char: string; forward: boolean; till: boolean } | null
 export type VimRegister = { text: string; linewise: boolean } | null
 export type VimSnapshot = { text: string; cursor: number; data?: unknown }
@@ -22,6 +22,8 @@ export function createVimState(input: { enabled: Accessor<boolean>; initial?: Ac
   const [undos, setUndos] = createSignal<VimHistory[]>([])
   const [redos, setRedos] = createSignal<VimSnapshot[]>([])
   const [edit, setEdit] = createSignal<VimSnapshot | null>(null)
+  const [skipExitOnModeChange, setSkipExitOnModeChange] = createSignal(false)
+  const [exitScrollToBottom, setExitScrollToBottom] = createSignal(true)
 
   function clearPending() {
     if (pending()) setPending("")
@@ -81,6 +83,10 @@ export function createVimState(input: { enabled: Accessor<boolean>; initial?: Ac
     setReplace,
     typed,
     setTyped,
+    skipExitOnModeChange,
+    setSkipExitOnModeChange,
+    exitScrollToBottom,
+    setExitScrollToBottom,
     beginEdit(snapshot: VimSnapshot) {
       setEdit(snapshot)
     },