@prevalentware/opencode-goal-plugin 0.1.30 → 0.1.32

package/README.md

@@ -38,7 +38,18 @@ Common use cases:
 
 ## Install
 
-Install locally for the current OpenCode project:
+Choose the instructions that match the CLI you run:
+
+| OpenCode version | How to identify it | Instructions |
+| --- | --- | --- |
+| OpenCode 1 stable | You run `opencode` and `opencode --version` prints `1.x` | [OpenCode 1](#opencode-1-stable) |
+| OpenCode 2 beta | You run `opencode2` | [OpenCode 2](#opencode-2-beta) |
+
+Do not mix the configuration formats. OpenCode 1 uses `plugin` and `tui.json`; OpenCode 2 uses `plugins` and the global `cli.json`.
+
+### OpenCode 1 Stable
+
+Install for the current project:
 
 ```bash
 opencode plugin @prevalentware/opencode-goal-plugin
@@ -52,51 +63,53 @@ opencode plugin -g @prevalentware/opencode-goal-plugin
 
 OpenCode detects both package entrypoints and writes the plugin into the server and TUI config targets.
 
-### OpenCode 2 Beta
-
-The package also supports OpenCode 2 preview `0.0.0-next-17055`. Add it to the V2 server and TUI plugin lists:
+For manual installation, add the package to both V1 config files.
 
 `opencode.json`:
 
 ```json
 {
-  "plugins": ["@prevalentware/opencode-goal-plugin"]
+  "plugin": ["@prevalentware/opencode-goal-plugin"]
 }
 ```
 
-`~/.config/opencode/cli.json`:
+`tui.json`:
 
 ```json
 {
-  "plugins": ["@prevalentware/opencode-goal-plugin"]
+  "plugin": ["@prevalentware/opencode-goal-plugin"]
 }
 ```
 
-OpenCode 2 plugin APIs are still beta. This package pins its V2 development contract to the preview version above; later previews may require a compatible plugin update. V2 currently supports the goal command, tools, persistent state, usage accounting, idle continuation, Plan-mode safety, and TUI sidebar/palette integration. Goal-specific compaction context and recovery of already-running child sessions after a plugin restart remain V1-only because the current V2 plugin context does not expose equivalent hooks or history queries.
+### OpenCode 2 Beta
 
-## Manual Config
+Use this section only when running `opencode2`. Plugin release `0.1.30` and newer supports OpenCode 2 preview `0.0.0-next-17055` while remaining compatible with OpenCode 1.
 
-If you configure it manually, add the package to both config files.
+Add the package to both V2 plugin lists:
 
 `opencode.json`:
 
 ```json
 {
-  "plugin": ["@prevalentware/opencode-goal-plugin"]
+  "plugins": ["@prevalentware/opencode-goal-plugin"]
 }
 ```
 
-`tui.json`:
+`~/.config/opencode/cli.json`:
 
 ```json
 {
-  "plugin": ["@prevalentware/opencode-goal-plugin"]
+  "plugins": ["@prevalentware/opencode-goal-plugin"]
 }
 ```
 
+OpenCode 2 does not read the V1 `tui.json` file. The server entrypoint comes from `opencode.json`, while the sidebar and palette integration come from `~/.config/opencode/cli.json`.
+
+OpenCode 2 plugin APIs are still beta. This package pins its V2 development contract to the preview version above; later previews may require a compatible plugin update. V2 currently supports the goal command, tools, persistent state, usage accounting, idle continuation, Plan-mode safety, and TUI sidebar/palette integration. Goal-specific compaction context and recovery of already-running child sessions after a plugin restart remain V1-only because the current V2 plugin context does not expose equivalent hooks or history queries.
+
 ## Options
 
-Server options can be configured in `opencode.json`:
+In OpenCode 1, server options use the package-and-options tuple in `opencode.json`:
 
 ```json
 {
@@ -122,6 +135,24 @@ Server options can be configured in `opencode.json`:
 }
 ```
 
+In OpenCode 2, use the plugin object form instead:
+
+```json
+{
+  "plugins": [
+    {
+      "package": "@prevalentware/opencode-goal-plugin",
+      "options": {
+        "auto_continue": true,
+        "max_auto_turns": 25,
+        "default_token_budget": 200000,
+        "restricted_agents": ["plan"]
+      }
+    }
+  ]
+}
+```
+
 Defaults:
 
 - `auto_continue`: `true`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prevalentware/opencode-goal-plugin",
-  "version": "0.1.30",
+  "version": "0.1.32",
   "description": "OpenCode goal plugin that adds Codex-style long-running goal mode, /goal commands, persistence, and TUI status for AI coding agents.",
   "keywords": [
     "opencode",

package/src/tui.ts

@@ -111,6 +111,61 @@ function box(props: Record<string, unknown>, children: ElementChild[] = []) {
   return element("box", props, children)
 }
 
+type SlotRender = (props: { sessionID: string }) => unknown
+type SlotDispose = () => void
+
+const noopDispose: SlotDispose = () => {}
+
+/**
+ * Registers a V2 TUI slot across both plugin-context generations.
+ *
+ * Early V2 previews exposed `ui.slot(name, render)`. Current previews expose a
+ * single options argument, `ui.slot({ append, render })`, and silently register
+ * nothing when handed the positional pair — which is how the goal sidebar and
+ * the palette keymap layer both disappeared. Branch on the callback arity so
+ * either host works, and tolerate hosts that return no disposer.
+ */
+export function registerSlotV2(context: TuiPluginV2.Context, name: string, render: SlotRender): SlotDispose {
+  const slot = context.ui.slot as unknown as (...args: unknown[]) => unknown
+  const dispose = slot.length <= 1 ? slot({ append: name, render }) : slot(name, render)
+  return typeof dispose === "function" ? (dispose as SlotDispose) : noopDispose
+}
+
+/**
+ * Reads a theme color by trying each candidate path in order, descending into a
+ * `default` leaf when the resolved node is a color group.
+ *
+ * Current previews expose a nested theme (`text.default`, `text.subdued`,
+ * `text.feedback.success`), while earlier previews and the V1 TUI expose flat
+ * keys (`text`, `textMuted`, `primary`). Passing a color *group* as `fg`
+ * renders nothing useful, so resolve to a leaf before handing it to OpenTUI.
+ */
+export function themeColorV2(theme: unknown, ...paths: readonly (readonly string[])[]): unknown {
+  for (const path of paths) {
+    let cursor: unknown = theme
+    for (const key of path) {
+      if (cursor === null || typeof cursor !== "object") {
+        cursor = undefined
+        break
+      }
+      cursor = (cursor as Record<string, unknown>)[key]
+    }
+    if (cursor !== null && typeof cursor === "object" && "default" in (cursor as Record<string, unknown>)) {
+      cursor = (cursor as Record<string, unknown>).default
+    }
+    if (cursor !== undefined && cursor !== null) return cursor
+  }
+  return undefined
+}
+
+function goalColorsV2(theme: unknown) {
+  return {
+    text: themeColorV2(theme, ["text", "default"], ["text"]),
+    muted: themeColorV2(theme, ["text", "subdued"], ["textMuted"]),
+    achieved: themeColorV2(theme, ["text", "feedback", "success"], ["primary"], ["text", "default"], ["text"]),
+  }
+}
+
 function goalSnapshotKey(sessionID: string) {
   return `goal-mode.snapshot.${sessionID}`
 }
@@ -498,7 +553,7 @@ async function showSummaryV2(api: TuiPluginV2.Context, sessionID: string, goal:
 }
 
 function GoalSidebarV2(api: TuiPluginV2.Context, sessionID: string) {
-  const theme = api.theme
+  const colors = goalColorsV2(api.theme)
   const [cache, setCache] = api.storage.memory<{ goal: GoalSnapshot | null }>(`goal-mode.v2.${sessionID}`, {
     initial: { goal: null },
   })
@@ -523,26 +578,27 @@ function GoalSidebarV2(api: TuiPluginV2.Context, sessionID: string) {
     if (!snapshot) return null
     if (snapshot.status === "complete" || snapshot.status === "unmet") {
       const elapsed = liveTimeUsedSeconds(snapshot)
-      return text({ fg: snapshot.status === "complete" ? theme.primary : theme.textMuted }, [
+      return text({ fg: snapshot.status === "complete" ? colors.achieved : colors.muted }, [
         `${snapshot.status === "complete" ? "Goal achieved" : "Goal unmet"} (${formatDurationBadge(elapsed)})`,
       ])
     }
     return box({}, [
-      text({ fg: theme.text }, ["Goal"]),
-      text({ fg: theme.textMuted }, [`Status: ${snapshot.status}`]),
-      text({ fg: theme.textMuted }, [`Time: ${formatDuration(liveTimeUsedSeconds(snapshot, nowSeconds()))}`]),
-      text({ fg: theme.textMuted }, [`Tokens: ${snapshot.tokensUsed}${snapshot.tokenBudget == null ? "" : `/${snapshot.tokenBudget}`}`]),
-      text({ fg: theme.textMuted }, [`Auto-continues: ${snapshot.autoTurns}${snapshot.maxAutoTurns == null ? "" : `/${snapshot.maxAutoTurns}`}`]),
-      ...(snapshot.lastCheckpoint ? [text({ fg: theme.textMuted }, [`Checkpoint: ${snapshot.lastCheckpoint.summary}`])] : []),
-      ...(snapshot.stopReason ? [text({ fg: theme.textMuted }, [`Stop: ${snapshot.stopReason}`])] : []),
-      ...(snapshot.lastStatus ? [text({ fg: theme.textMuted }, [snapshot.lastStatus])] : []),
-      text({ fg: theme.textMuted }, [snapshot.objective]),
+      text({ fg: colors.text }, ["Goal"]),
+      text({ fg: colors.muted }, [`Status: ${snapshot.status}`]),
+      text({ fg: colors.muted }, [`Time: ${formatDuration(liveTimeUsedSeconds(snapshot, nowSeconds()))}`]),
+      text({ fg: colors.muted }, [`Tokens: ${snapshot.tokensUsed}${snapshot.tokenBudget == null ? "" : `/${snapshot.tokenBudget}`}`]),
+      text({ fg: colors.muted }, [`Auto-continues: ${snapshot.autoTurns}${snapshot.maxAutoTurns == null ? "" : `/${snapshot.maxAutoTurns}`}`]),
+      ...(snapshot.lastCheckpoint ? [text({ fg: colors.muted }, [`Checkpoint: ${snapshot.lastCheckpoint.summary}`])] : []),
+      ...(snapshot.stopReason ? [text({ fg: colors.muted }, [`Stop: ${snapshot.stopReason}`])] : []),
+      ...(snapshot.lastStatus ? [text({ fg: colors.muted }, [snapshot.lastStatus])] : []),
+      text({ fg: colors.muted }, [snapshot.objective]),
     ])
   }])
 }
 
 function GoalKeymapLayerV2(api: TuiPluginV2.Context) {
   api.keymap.layer(() => ({
+    mode: "global",
     commands: [
       {
         id: "goal.show",
@@ -573,8 +629,8 @@ function GoalKeymapLayerV2(api: TuiPluginV2.Context) {
  * needs to dispose the two `ui.slot` registrations.
  */
 export function setupTuiV2(context: TuiPluginV2.Context): TuiPluginV2.Cleanup {
-  const offSidebar = context.ui.slot("sidebar.content", (props) => GoalSidebarV2(context, props.sessionID))
-  const offApp = context.ui.slot("app", () => GoalKeymapLayerV2(context))
+  const offSidebar = registerSlotV2(context, "sidebar.content", (props) => GoalSidebarV2(context, props.sessionID))
+  const offApp = registerSlotV2(context, "app", () => GoalKeymapLayerV2(context))
   return () => {
     offSidebar()
     offApp()