opencode-vim 0.0.19 → 0.0.21

package/tui.tsx

@@ -1 +1,281 @@
-export { default } from "./src/plugin"
+/** @jsxImportSource @opentui/solid */
+import { Plugin } from "@opencode/plugin/tui"
+import { InputRenderable, type CursorStyleOptions, type KeyEvent } from "@opentui/core"
+import { createEffect, onCleanup } from "solid-js"
+import { applyVimCursorStyle, focusedInput } from "./src/modules/vim/actions"
+import { createVimConfig } from "./src/modules/vim/config"
+import { editInput } from "./src/modules/vim/edit"
+import { keyNotation } from "./src/modules/vim/keys"
+import { createVimLog } from "./src/modules/vim/log"
+import { displayToChar } from "./src/modules/vim/map"
+import { createVimState } from "./src/modules/vim/state"
+import { createVimeeAdapter } from "./src/modules/vim/vimee"
+import { VimStatus } from "./view"
+
+type Context = Parameters<Parameters<typeof Plugin.define>[0]["setup"]>[0]
+
+export default Plugin.define({
+  id: "opencode-vim",
+  setup(context) {
+    context.ui.slot({ append: "app", render: () => <VimHost context={context} /> })
+  },
+})
+
+function VimHost(props: { context: Context }) {
+  const config = createVimConfig(props.context.options)
+  const normalMappings = Object.keys(config.keymaps.normal ?? {})
+  const log = createVimLog(config)
+  const state = createVimState(config.defaultMode, log)
+  const vimee = createVimeeAdapter(state, config, log)
+  const dialogState = createVimState(config.defaultMode, log)
+  const dialogVimee = createVimeeAdapter(dialogState, config, log)
+  const promptVim = { state, vimee }
+  const dialogVim = { state: dialogState, vimee: dialogVimee }
+  let dialogInput: typeof props.context.renderer.currentFocusedEditor = null
+  const [saved, setSaved] = props.context.storage.store("state", { initial: { enabled: true } })
+  const enabled = () => saved.enabled
+  const ctx = createCompatContext(props.context)
+  let cursorMode = ""
+  let cursorInput: typeof props.context.renderer.currentFocusedEditor = null
+  let originalCursorStyle: CursorStyleOptions | undefined
+
+  const removeStatus = props.context.ui.slot({
+    prepend: "prompt.footer",
+    render: (footer) =>
+      footer.mode === "normal" ? (
+        <VimStatus
+          mode={state.mode}
+          pending={() => readablePending(state.pending())}
+          enabled={enabled}
+          theme={compatTheme(props.context)}
+          pendingDisplayDelay={config.pendingDisplayDelay}
+        />
+      ) : null,
+  })
+
+  props.context.keymap.layer(() => ({
+    mode: "global",
+    commands: [
+      {
+        id: "opencode-vim.toggle",
+        title: "Toggle Vim Mode",
+        description: "Enable or disable Vim key handling",
+        group: "Vim",
+        palette: true,
+        slash: { name: "vim" },
+        run() {
+          const next = !enabled()
+          void setSaved((draft) => {
+            draft.enabled = next
+          })
+          if (!next) {
+            vimee.suspend()
+            dialogVimee.suspend()
+          }
+          props.context.ui.toast.show({ message: `Vim mode ${next ? "enabled" : "disabled"}`, variant: "info" })
+          props.context.renderer.requestRender()
+        },
+      },
+    ],
+  }))
+
+  const onKey = (event: KeyEvent) => {
+    if (!enabled() || event.defaultPrevented) return
+    const kind = inputKind(props.context)
+    if (!kind) return
+    if (props.context.keymap.pending().length) return
+    const { state, vimee } = kind === "dialog" ? dialogVim : promptVim
+    const key = keyNotation(event as never)
+    if (!key) return
+    const mapped = normalMappings.some((sequence) => sequence.startsWith(key))
+    if (passThroughKey(event, key, state.mode(), vimee.isPending(), mapped)) return
+    if (key === "<Esc>" && state.mode() === "normal" && !vimee.isPending()) return
+
+    if (kind === "dialog" && !vimee.isPending() && !mapped && state.mode() === "normal") {
+      if (key === "<Tab>" || key === "<Home>" || key === "<End>" || key === "<PageUp>" || key === "<PageDown>") return
+      const command = key === "j" ? "dialog.select.next" : key === "k" ? "dialog.select.prev" : undefined
+      if (command && props.context.keymap.commands().some((item) => item.id === command)) {
+        event.preventDefault()
+        event.stopPropagation()
+        props.context.keymap.dispatch(command)
+        return
+      }
+    }
+
+    if (kind === "prompt" && !vimee.isPending() && sendCompletionKey(event, props.context, key, state.mode())) {
+      syncCursor(true)
+      return
+    }
+
+    const before = state.mode()
+    let consumed = false
+    try {
+      consumed = vimee.handle(event as never, key, ctx as never)
+    } finally {
+      if (consumed || state.mode() !== before) {
+        event.preventDefault()
+        event.stopPropagation()
+      }
+    }
+    if (consumed) syncCursor(true)
+  }
+
+  const onFocus = () => {
+    vimee.suspend()
+    dialogVimee.suspend()
+    syncCursor()
+  }
+  props.context.renderer.keyInput.prependListener("keypress", onKey)
+  props.context.renderer.on("focused_editor", onFocus)
+  createEffect(() => syncCursor())
+  onCleanup(() => {
+    removeStatus()
+    props.context.renderer.keyInput.off("keypress", onKey)
+    props.context.renderer.off("focused_editor", onFocus)
+    vimee.cleanup()
+    dialogVimee.cleanup()
+    restoreCursor()
+  })
+
+  return null
+
+  function syncCursor(force = false) {
+    const input = props.context.renderer.currentFocusedEditor
+    const kind = inputKind(props.context)
+    if (!enabled() || !kind || !input) {
+      restoreCursor()
+      return
+    }
+    const { state, vimee } = kind === "dialog" ? dialogVim : promptVim
+    if (kind === "dialog" && dialogInput !== input) {
+      dialogInput = input
+      dialogVimee.suspend()
+      dialogState.setMode(config.defaultMode)
+    }
+    const mode = state.mode()
+    vimee.attach(ctx)
+    const inputChanged = cursorInput !== input
+    if (inputChanged) {
+      restoreCursor()
+      cursorInput = input
+      originalCursorStyle = input.cursorStyle
+    }
+    if (!force && !inputChanged && cursorMode === mode) return
+    if (applyVimCursorStyle(ctx as never, config.cursorStyles[mode])) {
+      cursorMode = mode
+      props.context.renderer.requestRender()
+    }
+  }
+
+  function restoreCursor() {
+    if (cursorInput && !cursorInput.isDestroyed && originalCursorStyle) cursorInput.cursorStyle = originalCursorStyle
+    cursorInput = null
+    cursorMode = ""
+  }
+}
+
+function createCompatContext(context: Context) {
+  const prompt = {
+    get current() {
+      return { input: focusedInputValue(context), mode: "normal", parts: [] }
+    },
+    get focused() {
+      return inputKind(context) !== undefined
+    },
+    set(value: { input: string }) {
+      const input = context.renderer.currentFocusedEditor
+      if (input instanceof InputRenderable) input.value = value.input
+      else if (input) editInput(input, value.input)
+    },
+    submit() {
+      if (inputKind(context) === "dialog") {
+        const command = context.keymap.commands().some((item) => item.id === "dialog.select.submit")
+          ? "dialog.select.submit"
+          : "dialog.prompt.submit"
+        context.keymap.dispatch(command)
+      } else {
+        context.keymap.dispatch("prompt.submit")
+      }
+    },
+    blur() {
+      context.renderer.currentFocusedEditor?.blur()
+    },
+  }
+
+  return {
+    api: {
+      renderer: context.renderer,
+      keymap: {
+        dispatchCommand(command: string) {
+          const ok = context.keymap.commands().some((item) => item.id === command)
+          if (ok) context.keymap.dispatch(command)
+          return { ok }
+        },
+      },
+      theme: { current: compatTheme(context) },
+    },
+    kind: context.ui.router.current().type === "session" ? "session" : "home",
+    prompt: () => (inputKind(context) ? prompt : undefined),
+    requestRender: () => context.renderer.requestRender(),
+  }
+}
+
+function inputKind(context: Context): "prompt" | "dialog" | undefined {
+  if (!context.renderer.currentFocusedEditor) return
+  const commands = context.keymap.commands()
+  if (context.keymap.mode.current() === "modal") {
+    if (commands.some((item) => item.id === "dialog.select.submit" || item.id === "dialog.prompt.submit")) return "dialog"
+    return
+  }
+  if (commands.some(
+    (item) =>
+      item.id === "prompt.submit" || item.id === "prompt.autocomplete.next" || item.id === "prompt.history.previous",
+  )) return "prompt"
+}
+
+function focusedInputValue(context: Context) {
+  return context.renderer.currentFocusedEditor?.plainText ?? ""
+}
+
+function compatTheme(context: Context) {
+  return {
+    get background() { return context.theme.background.base },
+    get info() { return context.theme.text.feedback.info.base },
+    get success() { return context.theme.text.feedback.success.base },
+    get warning() { return context.theme.text.feedback.warning.base },
+    get textMuted() { return context.theme.text.muted },
+  }
+}
+
+function passThroughKey(event: KeyEvent, key: string, mode: string, pending: boolean, mapped: boolean) {
+  if (mode !== "normal") return false
+  if (mapped) return false
+  if (event.ctrl && key !== "<C-r>" && key !== "<C-[>") return true
+  return event.super === true || event.meta === true || (isArrowKey(key) && !pending)
+}
+
+function sendCompletionKey(event: KeyEvent, context: Context, key: string, mode: string) {
+  if (mode !== "normal") return false
+  const command = key === "j" ? "prompt.autocomplete.next" : key === "k" ? "prompt.autocomplete.prev" : undefined
+  if (!command || !isCompletionToken(context) || !context.keymap.commands().some((item) => item.id === command)) return false
+  event.preventDefault()
+  event.stopPropagation()
+  context.keymap.dispatch(command)
+  return true
+}
+
+function isCompletionToken(context: Context) {
+  const input = context.renderer.currentFocusedEditor
+  const text = input?.plainText ?? ""
+  const index = displayToChar(text, Math.max(0, input?.cursorOffset ?? 0))
+  const before = text.slice(0, Math.min(index + 1, text.length))
+  return /^\/\S*$/.test(before) || /(?:^|\s)@\S*$/.test(before)
+}
+
+function isArrowKey(key: string) {
+  return key === "<Left>" || key === "<Down>" || key === "<Up>" || key === "<Right>"
+}
+
+function readablePending(sequence: string) {
+  return sequence ? sequence.replaceAll("><", " ") : undefined
+}

package/view.tsx

@@ -0,0 +1,46 @@
+/** @jsxImportSource @opentui/solid */
+import type { TextRenderable } from "@opentui/core"
+import { createEffect, createSignal, onCleanup, type Accessor } from "solid-js"
+import type { VimMode } from "./src/modules/vim/state"
+
+type VimStatusProps = {
+  mode: Accessor<VimMode>
+  pending: Accessor<string | undefined>
+  enabled: Accessor<boolean>
+  theme: {
+    info: TextRenderable["fg"]
+    success: TextRenderable["fg"]
+    warning: TextRenderable["fg"]
+    textMuted: TextRenderable["fg"]
+  }
+  pendingDisplayDelay?: number
+}
+
+export function VimStatus(props: VimStatusProps) {
+  const [pending, setPending] = createSignal<string>()
+  createEffect(() => {
+    const value = props.enabled() ? props.pending() : undefined
+    const delay = props.pendingDisplayDelay ?? 120
+    if (!value || delay <= 0) {
+      setPending(value)
+      return
+    }
+    const timer = setTimeout(() => setPending(value), delay)
+    onCleanup(() => clearTimeout(timer))
+  })
+
+  return (
+    <box paddingRight={1} flexDirection="row">
+      <text fg={props.theme.info}>{props.enabled() && pending() ? `${pending()} ` : ""}</text>
+      <text fg={props.mode() === "insert" ? props.theme.success : props.theme.warning}>
+        {props.enabled() ? modeLabel(props.mode()) : ""}
+      </text>
+    </box>
+  )
+}
+
+function modeLabel(mode: VimMode) {
+  if (mode === "visual") return "VISUAL"
+  if (mode === "visual-line") return "VISUAL LINE"
+  return mode === "normal" ? "NORMAL" : "INSERT"
+}

package/tui.json.example

@@ -1,37 +0,0 @@
-{
-  "$schema": "https://opencode.ai/tui.json",
-  "plugin": [
-    [
-      "./plugin/opencode-vim",
-      {
-        "vim": {
-          "defaultMode": "insert",
-          "keymapTimeout": 500,
-          "pendingDisplayDelay": 120,
-          "cursorStyles": {
-            "insert": {
-              "style": "line",
-              "blinking": true
-            },
-            "normal": {
-              "style": "block",
-              "blinking": true
-            }
-          },
-          "debug": false,
-          "debugPath": "/home/you/.cache/opencode/opencode-vim.log",
-          "keymaps": {
-            "insert": {
-              "kj": "normal"
-            },
-            "normal": {
-              "i": "insert",
-              "<CR>": "submit",
-              "Y": "y$"
-            }
-          }
-        }
-      }
-    ]
-  ]
-}