opencode-vim 0.0.19 → 0.0.21

package/README.md

@@ -1,28 +1,80 @@
 # opencode-vim
 
-Adds Vim-style insert and normal mode editing to the OpenCode prompt.
+Vim-style editing for the OpenCode 2 prompt and dialog search fields.
 
-![Demo](./assets/demo2.gif)
+This branch supports normal, insert, visual, and visual-line editing, custom
+keymaps, prompt history, command dispatch, cursor styles, and `/vim` toggling.
+The mode indicator appears before the working directory in the prompt footer.
 
-## Installation
+Configure the local plugin in OpenCode 2's `cli.json`:
 
-Install from the CLI:
+```json
+{
+  "plugins": [
+    "opencode-vim@file:/home/dan/src/opencode-config/plugin/opencode-vim"
+  ]
+}
+```
+
+Options use the V2 object form:
+
+```json
+{
+  "package": "opencode-vim@file:/home/dan/src/opencode-config/plugin/opencode-vim",
+  "options": {
+    "vim": {
+      "defaultMode": "insert",
+      "keymapTimeout": 500,
+      "keymaps": {
+        "insert": { "kj": "normal" },
+        "normal": { "Y": "y$" }
+      }
+    }
+  }
+}
+```
+
+OpenCode 2 does not yet expose its prompt ref or low-level key interceptor to
+plugins. This adapter uses the public renderer in the V2 plugin context to
+bridge those capabilities to the existing Vim engine.
+
+## Dialogs
 
-```bash
-opencode plugin opencode-vim@latest --global
+Searchable dialogs such as `/models`, the `Ctrl+P` command palette, and Settings
+support Vim editing in their search fields. Each new dialog starts in your
+configured `defaultMode`.
+
+- In insert mode, type to filter. `Esc` (or your `kj` mapping) enters normal mode.
+- In normal mode, `j`/`k` move the selected list item. `h`/`l`, `x`, `dw`, `u`,
+  and other editing commands act on the search text. `i` returns to insert mode.
+- `Enter` selects the highlighted item; `Esc` in idle normal mode closes or goes
+  back. Arrows, Tab, Home/End, and Page Up/Down keep their dialog behavior.
+- Dialog editing has separate mode and undo state from the main prompt.
+
+Normal-mode custom mappings take precedence over the dialog `j`/`k` defaults.
+
+## Development and testing
+
+```sh
+npm install
+npm test
+npm run typecheck
+npm run bench
 ```
 
-## Supported Keys
+Tests use Bun and OpenTUI's native headless renderer: real textarea input,
+cursor movement, selection, wrapping, attachment extmarks, and the mounted
+plugin footer. They do not contact an OpenCode server or a model. When `nvim`
+is installed, additional tests compare text and cursor results against headless
+Neovim with user configuration disabled.
+
+With an OpenCode source checkout and its dependencies installed, you can also
+test against its real dialog component and keyboard routing:
 
-| Key | Behavior |
-| --- | --- |
-| `<Esc>`, `<C-[>` | Enter normal mode |
-| `i`, `a`, `A`, `o`, `O` | Return to insert mode |
-| `h`, `j`, `k`, `l`, `w`, `b`, `e`, `$`, `0` | Move through the prompt |
-| `x`, `d`, `c`, `y`, `p`, `u`, `<C-r>` | Edit, yank, paste, undo, redo |
-| `v`, `V` | Visual and visual-line selection |
-| `3w`, `diw`, `ci"`, `yiq`, `dip`, `yib` | Counts and text objects |
-| `<CR>` in normal mode | Submit the prompt |
-| `/vim` | Toggle Vim mode on or off |
+```sh
+OPENCODE_SOURCE=/path/to/opencode npm test -- test/opencode-dialog.test.tsx
+```
 
-See [docs/configuration.md](./docs/configuration.md) for configuration options and keymap examples.
+The benchmark measures wrap mapping and normal-mode navigation on prompts of
+1,000, 5,000, and 10,000 characters. Wrapping follows the textarea's visual
+lines; those cases are tested separately from Neovim's logical-line behavior.

package/docs/configuration.md

@@ -246,12 +246,14 @@ Use an absolute path in config. `~` is not expanded inside `debugPath`.
 
 ### `keymaps`
 
-Custom keymaps for insert mode and normal mode.
+Custom keymaps for each Vim mode.
 
 Allowed modes:
 
 - `"insert"`
 - `"normal"`
+- `"visual"`
+- `"visual-line"`
 
 Each keymap entry maps a key sequence to an action:
 
@@ -272,6 +274,8 @@ Supported built-in actions:
 - `"insert"` enters insert mode.
 - `"submit"` submits the OpenCode prompt.
 
+Use `"command:<name>"` to dispatch an active OpenCode command. See [Keymap Actions](./keymap-actions.md) for the full action and command reference.
+
 Any other action string is treated as a Vim key sequence. For example, this maps `Y` to yank from the cursor to the end of the line:
 
 ```jsonc
@@ -282,6 +286,10 @@ Any other action string is treated as a Vim key sequence. For example, this maps
 }
 ```
 
+Unlike other keys, `<CR>` in normal mode defaults to `"submit"` when no mapping is configured. A mode-specific mapping overrides that default. In insert mode, an unmapped `<CR>` passes through to OpenCode's `input_submit` and `input_newline` keybinds.
+
+When `input_submit` is not `"return"`, map `input_newline` to `"return"` for insert-mode newlines.
+
 ## Keymap Syntax
 
 Key sequences can contain printable ASCII characters, except literal spaces. Use `<Space>` for the space key.
@@ -307,6 +315,8 @@ Supported special keys:
 
 Ctrl key names must be lowercase. Use `<C-s>`, not `<C-S>`.
 
+`<CR>` can be mapped directly or end a sequence, but cannot start a multi-key sequence.
+
 Unsupported examples:
 
 ```jsonc
@@ -331,7 +341,7 @@ Use `kj` or `jk` to leave insert mode:
 }
 ```
 
-Submit the prompt with Enter in normal mode:
+Submit with `<CR>` in normal mode is the default, so this keymap is optional:
 
 ```jsonc
 "keymaps": {
@@ -407,7 +417,7 @@ Use a leader-style sequence:
 
 If a keymap does not work, check these first:
 
-- The mode is either `insert` or `normal`.
+- The mode is `insert`, `normal`, `visual`, or `visual-line`.
 - The key sequence does not contain a literal space.
 - Special keys use one of the supported names exactly.
 - Ctrl keys use lowercase letters, such as `<C-s>`.

package/docs/keymap-actions.md

@@ -0,0 +1,213 @@
+# Keymap Actions
+
+Each keymap entry maps a key sequence to an action in one Vim mode:
+
+```jsonc
+"keymaps": {
+  "normal": {
+    "q": "command:session.new"
+  }
+}
+```
+
+## Modes
+
+| Mode | Keymaps apply while |
+| --- | --- |
+| `insert` | Typing text |
+| `normal` | Navigating and editing |
+| `visual` | Selecting characters |
+| `visual-line` | Selecting lines |
+
+All action types below can be configured in any mode.
+
+## Actions
+
+| Action | Behavior |
+| --- | --- |
+| `normal` | Enter normal mode |
+| `insert` | Enter insert mode |
+| `submit` | Submit the prompt |
+| `command:<name>` | Dispatch an active OpenCode command |
+| Any other string | Run it as a Vim key sequence, such as `y$` |
+
+An unmapped `<CR>` submits in normal mode and passes through to OpenCode in insert mode. `<CR>` can be mapped directly or end a sequence, but cannot start a multi-key sequence.
+
+## OpenCode Commands
+
+Command mappings use the command ID, not a slash command. For example, use `command:session.new`, not `command:/new`.
+
+Commands are provided by OpenCode and installed plugins. They may change between versions and only run when their UI context is active. The commands below are available from a focused prompt in the current OpenCode release.
+
+### Application
+
+| Command | Behavior |
+| --- | --- |
+| `command.palette.show` | Open the command palette |
+| `session.list` | Open the session list |
+| `session.new` | Start a new session |
+| `session.quick_switch.1` through `.9` | Switch to a numbered recent session |
+| `workspace.copy_path` | Copy the current worktree path |
+| `workspace.list` | Open workspace management |
+| `model.list` | Open model selection |
+| `model.cycle_recent` | Select the next recent model |
+| `model.cycle_recent_reverse` | Select the previous recent model |
+| `model.cycle_favorite` | Select the next favorite model |
+| `model.cycle_favorite_reverse` | Select the previous favorite model |
+| `agent.list` | Open agent selection |
+| `agent.cycle` | Select the next agent |
+| `agent.cycle.reverse` | Select the previous agent |
+| `mcp.list` | Open MCP management |
+| `variant.cycle` | Select the next model variant |
+| `variant.list` | Open variant selection |
+| `provider.connect` | Connect a provider |
+| `console.org.switch` | Switch organizations |
+| `opencode.status` | Open status information |
+| `opencode.debug` | Open debug information |
+| `theme.switch` | Select a theme |
+| `theme.switch_mode` | Toggle light and dark mode |
+| `theme.mode.lock` | Lock automatic theme changes |
+| `help.show` | Open help |
+| `docs.open` | Open OpenCode documentation |
+| `app.exit` | Exit OpenCode |
+| `app.debug` | Toggle the debug overlay |
+| `app.console` | Toggle the renderer console |
+| `app.heap_snapshot` | Write a heap snapshot |
+| `terminal.suspend` | Suspend OpenCode |
+| `terminal.title.toggle` | Toggle terminal title updates |
+| `app.toggle.animations` | Toggle TUI animations |
+| `app.toggle.file_context` | Toggle automatic file context |
+| `app.toggle.diffwrap` | Toggle diff wrapping |
+| `app.toggle.paste_summary` | Toggle pasted-text summaries |
+| `app.toggle.session_directory_filter` | Toggle session directory filtering |
+| `permission.mode` | Toggle permission auto-approval |
+
+### Prompt
+
+| Command | Behavior |
+| --- | --- |
+| `prompt.clear` | Clear the prompt |
+| `prompt.submit` | Submit the prompt |
+| `prompt.editor_context.clear` | Remove attached editor context |
+| `prompt.paste` | Paste clipboard text or an image |
+| `session.interrupt` | Interrupt the active session |
+| `prompt.editor` | Edit the prompt in an external editor |
+| `prompt.skills` | Open skill selection |
+| `workspace.set` | Switch workspace |
+| `session.move` | Move the session to another project |
+| `prompt.stash` | Stash and clear the prompt |
+| `prompt.stash.pop` | Restore the latest prompt stash |
+| `prompt.stash.list` | Open prompt stash selection |
+| `prompt.history.previous` | Load the previous prompt |
+| `prompt.history.next` | Load the next prompt |
+
+### Autocomplete
+
+These commands are active while prompt autocomplete is visible.
+
+| Command | Behavior |
+| --- | --- |
+| `prompt.autocomplete.prev` | Select the previous item |
+| `prompt.autocomplete.next` | Select the next item |
+| `prompt.autocomplete.hide` | Hide autocomplete |
+| `prompt.autocomplete.select` | Accept the selected item |
+| `prompt.autocomplete.complete` | Complete or expand the selected item |
+
+### Input
+
+These commands act on the focused prompt input.
+
+| Command | Behavior |
+| --- | --- |
+| `input.move.left` | Move left |
+| `input.move.right` | Move right |
+| `input.move.up` | Move up |
+| `input.move.down` | Move down |
+| `input.select.left` | Select left |
+| `input.select.right` | Select right |
+| `input.select.up` | Select up |
+| `input.select.down` | Select down |
+| `input.line.home` | Move to logical line start |
+| `input.line.end` | Move to logical line end |
+| `input.select.line.home` | Select to logical line start |
+| `input.select.line.end` | Select to logical line end |
+| `input.visual.line.home` | Move to visual line start |
+| `input.visual.line.end` | Move to visual line end |
+| `input.select.visual.line.home` | Select to visual line start |
+| `input.select.visual.line.end` | Select to visual line end |
+| `input.buffer.home` | Move to the start of the prompt |
+| `input.buffer.end` | Move to the end of the prompt |
+| `input.select.buffer.home` | Select to the start of the prompt |
+| `input.select.buffer.end` | Select to the end of the prompt |
+| `input.delete.line` | Delete the current line |
+| `input.delete.to.line.end` | Delete to line end |
+| `input.delete.to.line.start` | Delete to line start |
+| `input.backspace` | Delete backward |
+| `input.delete` | Delete forward |
+| `input.newline` | Insert a newline |
+| `input.undo` | Undo an edit |
+| `input.redo` | Redo an edit |
+| `input.word.forward` | Move forward one word |
+| `input.word.backward` | Move backward one word |
+| `input.select.word.forward` | Select forward one word |
+| `input.select.word.backward` | Select backward one word |
+| `input.delete.word.forward` | Delete forward one word |
+| `input.delete.word.backward` | Delete backward one word |
+| `input.select.all` | Select the entire prompt |
+| `input.submit` | Submit the prompt input |
+
+### Session
+
+These commands are active in a session.
+
+| Command | Behavior |
+| --- | --- |
+| `session.share` | Share the session or copy its URL |
+| `session.rename` | Rename the session |
+| `session.timeline` | Open the message timeline |
+| `session.fork` | Fork from the timeline |
+| `session.compact` | Summarize the session |
+| `session.unshare` | Stop sharing the session |
+| `session.undo` | Undo the latest user message |
+| `session.redo` | Redo an undone message |
+| `session.sidebar.toggle` | Toggle the session sidebar |
+| `session.toggle.conceal` | Toggle code concealment |
+| `session.toggle.timestamps` | Toggle message timestamps |
+| `session.toggle.thinking` | Toggle expanded thinking |
+| `session.toggle.actions` | Toggle tool action details |
+| `session.toggle.scrollbar` | Toggle the session scrollbar |
+| `session.toggle.generic_tool_output` | Toggle generic tool output |
+| `session.page.up` | Scroll up half a page |
+| `session.page.down` | Scroll down half a page |
+| `session.line.up` | Scroll up one line |
+| `session.line.down` | Scroll down one line |
+| `session.half.page.up` | Scroll up a quarter page |
+| `session.half.page.down` | Scroll down a quarter page |
+| `session.first` | Jump to the first message |
+| `session.last` | Jump to the last message |
+| `session.messages_last_user` | Jump to the latest user message |
+| `session.message.next` | Jump to the next message |
+| `session.message.previous` | Jump to the previous message |
+| `messages.copy` | Copy the latest assistant message |
+| `session.copy` | Copy the session transcript |
+| `session.export` | Export the session transcript |
+| `session.background` | Background active subagents |
+| `session.child.first` | Open the first child session |
+| `session.parent` | Open the parent session |
+| `session.child.next` | Open the next child session |
+| `session.child.previous` | Open the previous child session |
+
+### Plugins
+
+| Command | Behavior | Requirement |
+| --- | --- | --- |
+| `opencode-vim.toggle` | Toggle Vim mode | Always available |
+| `snippets.reload` | Reload snippets | Snippets plugin installed |
+| `snippets.insert` | Open snippet selection | Snippets plugin installed |
+| `snippets.accept` | Accept the active snippet field | Snippets plugin installed |
+| `plugins.list` | Open plugin management | Built-in plugin manager enabled |
+| `plugins.install` | Open plugin installation | Built-in plugin manager enabled |
+| `diff.open` | Open the diff viewer | Built-in diff viewer enabled |
+| `tips.toggle` | Toggle home-screen tips | Home screen visible |
+
+Other plugins can register additional commands. A command that is unavailable in the current context is ignored.

package/package.json

@@ -1,39 +1,41 @@
 {
+  "$schema": "https://json.schemastore.org/package.json",
   "name": "opencode-vim",
-  "version": "0.0.19",
+  "version": "0.0.21",
+  "type": "module",
   "repository": {
     "type": "git",
     "url": "https://github.com/Tarquinen/opencode-vim"
   },
   "exports": {
-    "./tui": {
-      "import": "./tui.tsx"
-    }
+    "./tui": "./tui.tsx"
+  },
+  "scripts": {
+    "typecheck": "tsc --noEmit",
+    "test": "bun test --conditions=browser --preload @opentui/solid/preload",
+    "bench": "bun test/benchmark.ts"
   },
   "dependencies": {
     "@vimee/core": "^0.3.0"
   },
   "peerDependencies": {
-    "@opencode-ai/plugin": ">=1.4.3",
-    "@opentui/core": "^0.4.2",
-    "@opentui/keymap": "^0.4.2",
-    "@opentui/solid": "^0.4.2",
-    "solid-js": "^1.9.12"
+    "@opencode/plugin": "2.0.10",
+    "@opentui/core": ">=0.5.10",
+    "@opentui/solid": ">=0.5.10",
+    "solid-js": ">=1.9.0"
   },
   "devDependencies": {
-    "@opencode-ai/plugin": "1.14.44",
-    "@opentui/core": "^0.4.2",
-    "@opentui/keymap": "^0.4.2",
-    "@opentui/solid": "^0.4.2",
+    "@opencode/theme": "2.0.10",
     "@types/bun": "^1.3.14",
-    "solid-js": "^1.9.12"
+    "@types/node": "^24.0.0",
+    "typescript": "^5.9.0"
   },
   "files": [
     "assets/",
     "docs/",
     "src/",
     "README.md",
-    "tui.json.example",
-    "tui.tsx"
+    "tui.tsx",
+    "view.tsx"
   ]
 }

package/src/modules/vim/actions.ts

@@ -1,14 +1,38 @@
-import type { RGBA } from "@opentui/core"
-import type { TuiPromptInfo, TuiPromptRef } from "@opencode-ai/plugin/tui"
-import type { PromptContext } from "../../prompt/types"
+import type { CursorStyleOptions, LineInfo, RGBA } from "@opentui/core"
 import type { VimCursorStyle } from "./config"
 
+type PromptInfo = {
+    input: string
+    mode: string
+    parts: unknown[]
+}
+
+type PromptRef = {
+    current: PromptInfo
+    set: (value: PromptInfo) => void
+    submit: () => void
+    blur: () => void
+}
+
+export type PromptContext = {
+    api: {
+        renderer: { currentFocusedRenderable?: unknown }
+        keymap: { dispatchCommand: (command: string) => { ok: boolean } }
+        theme: { current: { warning: RGBA; info: RGBA; background: RGBA } }
+    }
+    prompt: () => PromptRef | undefined
+    requestRender: () => void
+}
+
 export type EditBufferLike = {
+    isDestroyed?: boolean
+    width?: number
+    wrapMode?: string
     cursorOffset?: number
     plainText?: string
     visualCursor?: VisualCursorLike
-    editorView?: { getVisualEOL?: () => VisualCursorLike | undefined; setSelection?: (start: number, end: number, bgColor?: RGBA, fgColor?: RGBA) => void; resetSelection?: () => void }
-    cursorStyle?: VimCursorStyle
+    editorView?: { getLogicalLineInfo?: () => LineInfo; getVisualEOL?: () => VisualCursorLike | undefined; setSelection?: (start: number, end: number, bgColor?: RGBA, fgColor?: RGBA) => void; resetSelection?: () => void }
+    cursorStyle?: CursorStyleOptions
     selectionBg?: RGBA
     selectionFg?: RGBA
     moveCursorLeft?: () => boolean
@@ -16,6 +40,7 @@ export type EditBufferLike = {
     moveCursorUp?: () => boolean
     moveCursorDown?: () => boolean
     setSelection?: (start: number, end: number) => void
+    insertText?: (text: string) => void
     setSelectionInclusive?: (start: number, end: number) => void
     clearSelection?: () => void
     gotoVisualLineEnd?: () => boolean
@@ -43,7 +68,7 @@ export function focusedInput(ctx: PromptContext): EditBufferLike | undefined {
     return focused
 }
 
-export function setInput(ref: TuiPromptRef, input: string) {
+export function setInput(ref: PromptRef, input: string) {
     ref.set(toPromptInfo(ref, input))
 }
 
@@ -51,7 +76,7 @@ function hasEditBufferMethods(input: EditBufferLike) {
     return typeof input.moveCursorLeft === "function" || typeof input.moveCursorRight === "function" || typeof input.moveCursorUp === "function" || typeof input.moveCursorDown === "function" || typeof input.gotoLineEnd === "function"
 }
 
-function toPromptInfo(ref: TuiPromptRef, input: string): TuiPromptInfo {
+function toPromptInfo(ref: PromptRef, input: string): PromptInfo {
     return {
         input,
         mode: ref.current.mode,

package/src/modules/vim/edit.test.ts

@@ -0,0 +1,51 @@
+import { describe, expect, test } from "bun:test"
+import { editInput } from "./edit"
+
+describe("editInput", () => {
+    test("inserts without replacing unchanged placeholders", () => {
+        const fixture = createFixture("[Image 1] after")
+
+        editInput(fixture.input, "[Image 1] kafter")
+
+        expect(fixture.calls).toEqual([["cursor", 10], ["insert", "k"]])
+    })
+
+    test("uses display offsets for a minimal deletion", () => {
+        const fixture = createFixture("中 [Image 1] abc")
+
+        editInput(fixture.input, "中 [Image 1] ac")
+
+        expect(fixture.calls).toEqual([["selection", 14, 15], ["insert", ""]])
+    })
+
+    test("does not split graphemes", () => {
+        const fixture = createFixture("a👩‍💻b")
+
+        editInput(fixture.input, "axb")
+
+        expect(fixture.calls).toEqual([["selection", 1, 3], ["insert", "x"]])
+    })
+})
+
+function createFixture(plainText: string) {
+    const calls: Array<["cursor", number] | ["selection", number, number] | ["insert", string]> = []
+    let cursorOffset = 0
+    const input = {
+        plainText,
+        clearSelection() {},
+        get cursorOffset() {
+            return cursorOffset
+        },
+        set cursorOffset(value: number) {
+            cursorOffset = value
+            calls.push(["cursor", value])
+        },
+        setSelection(start: number, end: number) {
+            calls.push(["selection", start, end])
+        },
+        insertText(text: string) {
+            calls.push(["insert", text])
+        },
+    }
+    return { input, calls }
+}

package/src/modules/vim/edit.ts

@@ -0,0 +1,33 @@
+import { charToDisplay } from "./map"
+
+const graphemes = new Intl.Segmenter(undefined, { granularity: "grapheme" })
+
+type Input = {
+    plainText: string
+    cursorOffset: number
+    setSelection: (start: number, end: number) => void
+    insertText: (text: string) => void
+    clearSelection: () => unknown
+}
+
+export function editInput(input: Input, value: string) {
+    if (input.plainText === value) return
+    input.clearSelection()
+
+    const before = [...graphemes.segment(input.plainText)]
+    const after = [...graphemes.segment(value)]
+    let prefix = 0
+    while (prefix < before.length && prefix < after.length && before[prefix].segment === after[prefix].segment) prefix++
+
+    let suffix = 0
+    while (suffix + prefix < before.length && suffix + prefix < after.length && before[before.length - suffix - 1].segment === after[after.length - suffix - 1].segment) suffix++
+
+    const start = before[prefix]?.index ?? input.plainText.length
+    const end = suffix ? before[before.length - suffix].index : input.plainText.length
+    const valueEnd = suffix ? after[after.length - suffix].index : value.length
+    const startOffset = charToDisplay(input.plainText, start)
+
+    if (start === end) input.cursorOffset = startOffset
+    else input.setSelection(startOffset, charToDisplay(input.plainText, end))
+    input.insertText(value.slice(start, valueEnd))
+}

package/src/modules/vim/graphemes.ts

@@ -0,0 +1,38 @@
+const segments = new Intl.Segmenter(undefined, { granularity: "grapheme" })
+
+// Vimee indexes JavaScript strings by UTF-16 code unit. Give each multi-unit
+// grapheme one private-use character so motions, operators and registers cannot
+// split it. The dictionary lives with the adapter, including its undo history.
+export function createGraphemeCodec() {
+    const encoded = new Map<string, string>()
+    const decoded = new Map<string, string>()
+    let next = 0xe000
+    return {
+        encode(text: string) {
+            let result = ""
+            for (const { segment } of segments.segment(text)) {
+                const code = segment.charCodeAt(0)
+                if (segment.length === 1 && (code < 0xe000 || code > 0xf8ff)) {
+                    result += segment
+                    continue
+                }
+                let token = encoded.get(segment)
+                if (!token) {
+                    if (next > 0xf8ff) throw new Error("Vim grapheme dictionary is full")
+                    token = String.fromCharCode(next++)
+                    encoded.set(segment, token)
+                    decoded.set(token, segment)
+                }
+                result += token
+            }
+            return result
+        },
+        decode(text: string) {
+            let result = ""
+            for (const token of text) result += decoded.get(token) ?? token
+            return result
+        },
+    }
+}
+
+export type GraphemeCodec = ReturnType<typeof createGraphemeCodec>