opencode-dock-badge 0.0.0-stage → 1.0.0

package/README.md

@@ -1,3 +1,67 @@
-# Temporary Holding Version
+# opencode-dock-badge
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+给 **OpenCode Desktop** 加 macOS Dock 角标：有会话「需要你处理」或「有新回复未看」时，Dock 图标上显示红色数字。
+
+## 为什么需要自己写
+
+社区现有的 opencode 通知插件（`kdco/notify`、`opencode-notify`、`opencode-alert`、`opencode-bell` 等）**全部是给终端 TUI 版做的**，
+它们的 “Dock badge” 靠向 TTY 写 BEL 字符 `\x07` 实现。OpenCode Desktop 是 Electron web view，没有终端，收不到。
+
+Desktop 自带的 `设置 → General → 通知` 也有两个限制：
+- 只有**窗口失焦**时才弹（`getWindowFocused()` 为真直接 return）
+- 只对**已打开标签页**的会话生效，后台/未打开的会话完全静默
+
+## 实现方式
+
+用 OpenCode 2.2.0+ 的实验性 GUI 插件能力（`./gui-experimental`），在 Electron 主进程里调用
+`app.dock.setBadge()`，在窗口端读 OpenCode 自己维护的会话状态标记：
+
+```
+[data-slot='titlebar-tab-item'][data-status]
+```
+
+| data-status | 含义 | 计入角标 |
+|---|---|---|
+| `attention` | 需要你处理（黄点） | ✅ |
+| `unread` | 有新回复未看（蓝点） | ✅ |
+| `busy` | 正在运行 | ❌ |
+
+**关键点**：这些标记由 OpenCode 自己维护，**只有你点开会话并看过才会被清掉**。
+所以角标天然满足「点掉才减少、全看完才消失」，不需要自己记状态，也永远不会和侧栏对不上。
+
+## 文件
+
+| 文件 | 作用 |
+|---|---|
+| `src/gui.js` | 窗口侧扫 `data-status` + 主进程侧 `app.dock.setBadge` |
+| `src/contract.js` | 窗口 ↔ 主进程的 Ipc 桥（`opencode-dock-badge.badge`） |
+| `src/index.js` | 服务端占位部分（只为让插件有正常 id） |
+| `dist/gui-experimental.cjs` | 构建产物（Vite 打包） |
+
+## 构建
+
+```bash
+cd ~/.config/opencode/plugins/opencode-dock-badge
+npx vite build
+```
+
+改完 `src/` 重新 build，桌面端会自动重载 GUI，**不用重启 app**。
+
+## 安装（已完成）
+
+`~/.config/opencode/opencode.json` 的 `plugins` 里：
+
+```json
+"plugins": [
+  "file:///Users/wuwu/.config/opencode/plugins/opencode-task-checker",
+  "file:///Users/wuwu/.config/opencode/plugins/opencode-dock-badge"
+]
+```
+
+首次加入时需要重启服务（`opencode-cli service restart`），之后改代码不用。
+
+## 注意
+
+- GUI 插件 API 仍是 **experimental**，OpenCode 升级后可能失效，升级后先看角标还灵不灵。
+- 依赖 `data-status` / `data-slot="titlebar-tab-item"` 这两个 DOM 属性，属于非公开接口，官方改结构就需要跟着改。
+- 仅 macOS 生效（`app.dock.setBadge`）。

package/dist/gui-experimental.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});const i=require("@opencode/plugin/gui"),g=require("effect"),l=i.Ipc.define({id:"opencode-dock-badge.badge",methods:{set:{input:g.Schema.Number},clear:{}}}),m=i.Plugin.define({i18n:{en:{"pill.pending":"needs you","command.clear":"Clear Dock badge"},zh:{"pill.pending":"待处理","command.clear":"清除 Dock 角标"}},setup(e){const r=new Set(["attention","unread"]);let t=0;const n=()=>{try{return e.main(l)}catch{return}},d=a=>{a!==t&&(t=a,n()?.set(a)?.catch(()=>{}))},o=()=>{const a=document.querySelectorAll("[data-slot='titlebar-tab-item'][data-status]");let c=0;for(const p of a)r.has(p.getAttribute("data-status"))&&(c+=1);d(c)};o();const s=setInterval(o,1500),u=()=>d(0);return e.add(i.TitlebarItem,()=>t>0?{id:"pending",label:`${t} ${e.t("pill.pending")}`,icon:"notifications",title:e.t("pill.pending")}:void 0),e.add(i.Command,()=>({id:"clear",title:e.t("command.clear"),run:u})),()=>{clearInterval(s),n()?.clear()?.catch(()=>{})}},main(e){const{app:r}=require("electron"),t=n=>{if(process.platform==="darwin")try{r.dock?.setBadge(n>0?String(n):"")}catch{}};return e.provide(l,{set:n=>t(Number(n)||0),clear:()=>t(0)}),e.log.write("info","opencode-dock-badge main ready"),()=>t(0)}});exports.default=m;

package/package.json

@@ -1,6 +1,41 @@
 {
   "name": "opencode-dock-badge",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.0",
+  "description": "macOS Dock badge for OpenCode Desktop — shows how many sessions need your attention or have unread replies. Count clears only when you actually open each session.",
+  "license": "MIT",
+  "author": "wuwu",
+  "homepage": "https://github.com/changjianghome/opencode-dock-badge#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/changjianghome/opencode-dock-badge.git"
+  },
+  "keywords": [
+    "opencode",
+    "opencode-plugin",
+    "opencode-desktop",
+    "dock-badge",
+    "notification",
+    "macos"
+  ],
+  "type": "module",
+  "exports": {
+    ".": "./src/index.js",
+    "./gui-experimental": "./dist/gui-experimental.cjs"
+  },
+  "files": [
+    "src",
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "vite build"
+  },
+  "dependencies": {
+    "@opencode/plugin": "2.2.5"
+  },
+  "devDependencies": {
+    "vite": "^7.0.0",
+    "vite-plugin-solid": "^2.11.0",
+    "solid-js": "^1.9.0"
+  }
+}

package/src/contract.js

@@ -0,0 +1,15 @@
+import { Schema } from "effect"
+import { Ipc } from "@opencode/plugin/gui"
+
+/**
+ * Bridge from the app window (which sees events and focus state) to the Electron main
+ * process (which alone can call `app.dock.setBadge`).
+ */
+export const Badge = Ipc.define({
+  id: "opencode-dock-badge.badge",
+  methods: {
+    /** Paint the badge with this count; 0 clears it. */
+    set: { input: Schema.Number },
+    clear: {},
+  },
+})

package/src/gui.js

@@ -0,0 +1,85 @@
+import { Command, Plugin, TitlebarItem } from "@opencode/plugin/gui"
+import { Badge } from "./contract"
+
+/**
+ * Dock badge for OpenCode Desktop.
+ *
+ * Reads OpenCode's own per-session status markers from the shell tabstrip
+ * (`data-status`: busy / attention / unread) and mirrors the attention-worthy
+ * ones onto the macOS Dock badge. Because the app clears those markers only
+ * when the user actually opens a session, the badge goes down on its own —
+ * no extra bookkeeping, and it can never drift from what the UI shows.
+ */
+export default Plugin.define({
+  i18n: {
+    en: { "pill.pending": "needs you", "command.clear": "Clear Dock badge" },
+    zh: { "pill.pending": "待处理", "command.clear": "清除 Dock 角标" },
+  },
+  setup(ctx) {
+    const COUNTED = new Set(["attention", "unread"])
+
+    let pending = 0
+    const bridge = () => {
+      try {
+        return ctx.main(Badge)
+      } catch {
+        return undefined
+      }
+    }
+    const paint = (n) => {
+      if (n === pending) return
+      pending = n
+      void bridge()?.set(n)?.catch(() => {})
+    }
+
+    const scan = () => {
+      const els = document.querySelectorAll("[data-slot='titlebar-tab-item'][data-status]")
+      let n = 0
+      for (const el of els) {
+        if (COUNTED.has(el.getAttribute("data-status"))) n += 1
+      }
+      paint(n)
+    }
+
+    scan()
+    const timer = setInterval(scan, 1500)
+    const clear = () => paint(0)
+
+    ctx.add(TitlebarItem, () =>
+      pending > 0
+        ? {
+            id: "pending",
+            label: `${pending} ${ctx.t("pill.pending")}`,
+            icon: "notifications",
+            title: ctx.t("pill.pending"),
+          }
+        : undefined,
+    )
+    ctx.add(Command, () => ({
+      id: "clear",
+      title: ctx.t("command.clear"),
+      run: clear,
+    }))
+
+    return () => {
+      clearInterval(timer)
+      void bridge()?.clear()?.catch(() => {})
+    }
+  },
+
+  main(ctx) {
+    const { app } = require("electron")
+    const paint = (n) => {
+      if (process.platform !== "darwin") return
+      try {
+        app.dock?.setBadge(n > 0 ? String(n) : "")
+      } catch {}
+    }
+    ctx.provide(Badge, {
+      set: (n) => paint(Number(n) || 0),
+      clear: () => paint(0),
+    })
+    ctx.log.write("info", "opencode-dock-badge main ready")
+    return () => paint(0)
+  },
+})

package/src/index.js

@@ -0,0 +1,11 @@
+/**
+ * opencode-dock-badge — server part.
+ *
+ * Deliberately minimal: the desktop GUI half already subscribes to the full event
+ * stream and owns the Dock badge. This export exists only so the package has a
+ * normal plugin id and can be listed / toggled like any other plugin.
+ */
+export default {
+  id: "opencode-dock-badge",
+  setup: async () => {},
+}