opencode-vim 0.0.22 → 0.0.24

package/README.md

@@ -1,81 +1,43 @@
 # opencode-vim
 
-Vim-style editing for the OpenCode 2 prompt and dialog search fields.
+Vim-style prompt editing and session navigation for OpenCode 2.
 
-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.
-Pending key sequences stay hidden so they do not shift the footer layout.
+![Vim prompt editing, dialog navigation, and session mode](./assets/vim-in-motion-dialogs.gif)
 
-Configure the local plugin in OpenCode 2's `cli.json`:
+## Installation
 
-```json
-{
-  "plugins": [
-    "opencode-vim@file:/home/dan/src/opencode-config/plugin/opencode-vim"
-  ]
-}
+```sh
+opencode plugin add opencode-vim@latest
 ```
 
-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$" }
-      }
-    }
-  }
-}
-```
+## Updating
 
-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.
+```sh
+opencode plugin update opencode-vim@latest
+```
 
-## Dialogs
+Restart the terminal UI after updating to load the new version.
 
-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`.
+## Usage
 
-- 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.
+Press `Esc` to enter normal mode and `i` to type again in insert mode.
 
-Normal-mode custom mappings take precedence over the dialog `j`/`k` defaults.
+In a session, press `s` from normal mode to browse messages and tools. Use `j`/`k`
+to navigate, `Enter` to open an item, and `s` to return to the prompt.
 
-## Development and testing
+Use `/vim` to toggle the plugin on or off.
 
-```sh
-npm install
-npm test
-npm run typecheck
-npm run bench
-```
+## Development
 
-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.
+Run `npm ci` and `bun run build` before loading this checkout as a local plugin.
+Rebuild after changing source files. The published entrypoint compiles JSX and
+uses OpenCode's shared UI runtime.
 
-With an OpenCode source checkout and its dependencies installed, you can also
-test against its real dialog component and keyboard routing:
+`bun run test` checks both source loading and the packed npm plugin under
+`node_modules`, including mode updates, session browsing, clipboard and cleanup.
 
-```sh
-OPENCODE_SOURCE=/path/to/opencode npm test -- test/opencode-dialog.test.tsx
-```
+## Documentation
 
-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.
+- [Keybindings and modes](./docs/vim-behavior.md)
+- [Configuration](./docs/configuration.md)
+- [Custom keymaps](./docs/keymap-actions.md)