token-stats-timer 1.0.0 → 1.0.2

package/README.md

@@ -21,11 +21,45 @@ Footer 上行（左对齐）：
 
 Footer 下行：cwd + git 分支 + 其他扩展状态。
 
+## macOS 完成通知
+
+每次 run（agent 任务）结束后弹系统通知，区分三种结果：
+
+- ✅ pi 执行完成 —— 正常结束（含耗时）
+- ❌ pi 执行失败 —— 模型调用出错 / 工具执行失败（含错误摘要）
+- ⏹ pi 已中止 —— 用户 Esc 中止
+
+会话关闭时另有 👋 提示（可关）。通知经 `osascript` 发送，需在系统设置 → 通知 中允许终端 App 通知。
+
+### 配置
+
+配置文件：`~/.pi/agent/extensions/token-stats/notify-config.json`（不存在时用默认值）
+
+```json
+{
+  "enabled": true,
+  "minDurationSec": 0,
+  "sound": "Glass",
+  "onSuccess": true,
+  "onFailure": true,
+  "onAbort": true,
+  "onSessionEnd": true
+}
+```
+
+- `enabled` —— 总开关（也可用 `/notify on|off` 切换）
+- `minDurationSec` —— 耗时低于该秒数的 run 不通知（设为 30 可避免秒回打扰）
+- `sound` —— 通知声音（macOS 内置：Glass/Ping/Sosumi/Hero/Funk 等，`""` 静音）
+- `onSuccess/onFailure/onAbort/onSessionEnd` —— 各类通知开关
+
+`/notify` —— 无参查看当前状态；`on`/`off` 开启/关闭。
+
 ## 命令
 
 - `/stats` —— 无参进入套餐配置（为当前 provider 选择/关闭配额套餐）
 - `/stats day [YYYY-MM-DD]` / `hour` / `week` / `month [YYYY-MM]` —— 统计查询
 - `/stats config` —— 显示样式 / 显示内容（含「计时器」开关）/ 配额刷新时间
+- `/notify [on|off]` —— macOS 完成通知开关（无参查看状态）
 
 ## 与两个原包的兼容性
 
@@ -38,6 +72,7 @@ Footer 下行：cwd + git 分支 + 其他扩展状态。
 ```bash
 pi remove npm:@carlosgtrz/pi-run-timer
 pi remove npm:@liziy/token-stats
+pi install npm:token-stats-timer
 ```
 
-本目录已在 `~/.pi/agent/extensions/` 下，自动发现，`/reload` 或重启 pi 生效。
+`/reload` 或重启 pi 生效。

package/index.ts

@@ -20,6 +20,7 @@ import type { ExtensionAPI } from "@earendil-works/pi-coding-agent";
 import { truncateToWidth, visibleWidth } from "@earendil-works/pi-tui";
 import { createRunTimer } from "./run-timer.ts";
 import { createTokenStats, formatUserPath, type SharedState } from "./token-stats.ts";
+import { createNotifier } from "./notify.ts";
 
 const shared: SharedState = {
   sessionActive: false,
@@ -29,6 +30,8 @@ const shared: SharedState = {
 export default function runTokenStatsExtension(pi: ExtensionAPI) {
   const stats = createTokenStats(pi, shared);
   const timer = createRunTimer(pi, shared);
+  // macOS 完成通知（成功/失败/中止），配置见 notify-config.json
+  createNotifier(pi);
 
   pi.on("session_start", (_event, ctx) => {
     shared.sessionActive = true;

package/notify.ts

@@ -0,0 +1,208 @@
+// run-token-stats / notify 模块
+// =============================================================================
+// macOS 系统通知：每次 run（agent 完成任务）结束后弹系统通知，区分成功/失败/中止。
+//
+// run 语义与 run-timer 一致：从空闲后的第一个 agent_start 到 agent_settled
+// 的连续忙碌期（含重试、压缩恢复、排队提示）。
+//
+// 配置持久化：~/.pi/agent/extensions/token-stats/notify-config.json
+//   enabled       总开关（默认 true）
+//   minDurationSec 时长低于该秒数的 run 不通知（默认 0 = 每次都通知）
+//   sound         通知声音（默认 "Glass"，"" 表示静音）
+//   onSuccess / onFailure / onAbort / onSessionEnd  各类通知开关（默认全开）
+//
+// 命令：/notify on | off | status
+
+import type { ExtensionAPI } from "@earendil-works/pi-coding-agent";
+import { spawn } from "node:child_process";
+import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
+import { homedir } from "node:os";
+import { join } from "node:path";
+
+const CONFIG_DIR = join(homedir(), ".pi/agent/extensions/token-stats");
+const CONFIG_FILE = join(CONFIG_DIR, "notify-config.json");
+
+export interface NotifyConfig {
+  enabled: boolean;
+  minDurationSec: number;
+  sound: string;
+  onSuccess: boolean;
+  onFailure: boolean;
+  onAbort: boolean;
+  onSessionEnd: boolean;
+}
+
+const DEFAULT_CONFIG: NotifyConfig = {
+  enabled: true,
+  minDurationSec: 0,
+  sound: "Glass",
+  onSuccess: true,
+  onFailure: true,
+  onAbort: false,
+  onSessionEnd: false,
+};
+
+function loadConfig(): NotifyConfig {
+  if (!existsSync(CONFIG_FILE)) return { ...DEFAULT_CONFIG };
+  try {
+    const saved = JSON.parse(readFileSync(CONFIG_FILE, "utf-8")) as Partial<NotifyConfig>;
+    return { ...DEFAULT_CONFIG, ...saved };
+  } catch {
+    return { ...DEFAULT_CONFIG };
+  }
+}
+
+function saveConfig(cfg: NotifyConfig): void {
+  mkdirSync(CONFIG_DIR, { recursive: true });
+  writeFileSync(CONFIG_FILE, JSON.stringify(cfg, null, 2) + "\n", "utf-8");
+}
+
+/** 连续两次通知的最短间隔（毫秒），防止并行 agent 结束时刷屏 */
+const DEBOUNCE_MS = 3000;
+
+function formatDuration(ms: number): string {
+  const totalSeconds = Math.max(0, Math.floor(ms / 1000));
+  const hours = Math.floor(totalSeconds / 3600);
+  const minutes = Math.floor((totalSeconds % 3600) / 60);
+  const seconds = totalSeconds % 60;
+  if (hours > 0) {
+    return `${hours}:${String(minutes).padStart(2, "0")}:${String(seconds).padStart(2, "0")}`;
+  }
+  return `${String(minutes).padStart(2, "0")}:${String(seconds).padStart(2, "0")}`;
+}
+
+function truncate(s: string, max = 80): string {
+  return s.length > max ? s.slice(0, max) + "…" : s;
+}
+
+function cwdName(): string {
+  const parts = process.cwd().split("/").filter(Boolean);
+  return parts.pop() || process.cwd();
+}
+
+export function createNotifier(pi: ExtensionAPI): void {
+  let config: NotifyConfig = loadConfig();
+
+  // 当前 run 的状态（agent_start 重置，agent_end 收集，agent_settled 消费）
+  let runStartMs: number | undefined;
+  let runFailed = false;
+  let runAborted = false;
+  let runErrorMsg: string | undefined;
+
+  // 进程内去抖计时
+  let lastNotifyAt = 0;
+
+  function notify(title: string, message: string, sound: string): void {
+    if (process.platform !== "darwin") return; // 非 macOS 直接跳过
+
+    const now = Date.now();
+    if (now - lastNotifyAt < DEBOUNCE_MS) return;
+    lastNotifyAt = now;
+
+    // spawn + 参数数组传参，避免 shell 注入；detached + unref 不阻塞 pi
+    const soundPart = sound ? ` sound name ${JSON.stringify(sound)}` : "";
+    const script = `display notification ${JSON.stringify(message)} with title ${JSON.stringify(title)}${soundPart}`;
+    const child = spawn("osascript", ["-e", script], { detached: true });
+    child.unref();
+  }
+
+  pi.on("agent_start", () => {
+    runFailed = false;
+    runAborted = false;
+    runErrorMsg = undefined;
+    if (runStartMs === undefined) runStartMs = Date.now();
+  });
+
+  // 一次 run 结束；若 run 已带错误状态，最终结论按错误弹
+  pi.on("agent_end", (event) => {
+    if (!config.enabled) return;
+    for (const m of event.messages) {
+      if (m.role === "assistant") {
+        if (m.stopReason === "aborted") {
+          runAborted = true;
+          runErrorMsg = runErrorMsg || "被用户中止";
+        } else if (m.stopReason === "error" || m.errorMessage) {
+          runFailed = true;
+          runErrorMsg = runErrorMsg || m.errorMessage || "模型调用出错";
+        }
+      } else if (m.role === "toolResult" && m.isError) {
+        runFailed = true;
+        const toolMsg = `工具 ${m.toolName} 执行失败`;
+        runErrorMsg = runErrorMsg && !runErrorMsg.startsWith("工具 ")
+          ? runErrorMsg
+          : toolMsg;
+      }
+    }
+  });
+
+  pi.on("agent_settled", (_event, ctx) => {
+    if (!ctx.isIdle()) return;
+
+    const startMs = runStartMs;
+    runStartMs = undefined;
+    if (!config.enabled) return;
+
+    const durationMs = startMs !== undefined ? Date.now() - startMs : 0;
+    if (durationMs < config.minDurationSec * 1000) return;
+
+    const where = `「${cwdName()}」`;
+    const dur = startMs !== undefined ? ` · ${formatDuration(durationMs)}` : "";
+
+    if (runFailed && config.onFailure) {
+      notify(
+        "❌ pi 执行失败",
+        `${where}${dur}\n${truncate(runErrorMsg || "未知错误")}`,
+        config.sound,
+      );
+    } else if (runAborted && config.onAbort) {
+      notify(
+        "⏹ pi 已中止",
+        `${where}${dur}\n${truncate(runErrorMsg || "执行被中止")}`,
+        config.sound,
+      );
+    } else if (config.onSuccess) {
+      notify(
+        "✅ pi 执行完成",
+        `${where}${dur}\nagent 任务已结束`,
+        config.sound,
+      );
+    }
+
+    // 消费本次结果，避免串扰下一次 run
+    runFailed = false;
+    runAborted = false;
+    runErrorMsg = undefined;
+  });
+
+  // 会话关闭时提示（可选）
+  pi.on("session_shutdown", () => {
+    if (config.enabled && config.onSessionEnd) {
+      notify("👋 pi 会话结束", "session 已关闭", config.sound);
+    }
+  });
+
+  // ── /notify 命令 ─────────────────────────────────────
+  pi.registerCommand("notify", {
+    description: "macOS 完成通知: on | off | status（详细配置见 notify-config.json）",
+    handler: async (args, ctx) => {
+      const arg = args.trim();
+      if (arg === "on") {
+        config = { ...config, enabled: true };
+        saveConfig(config);
+        ctx.ui.notify("完成通知已开启", "info");
+      } else if (arg === "off") {
+        config = { ...config, enabled: false };
+        saveConfig(config);
+        ctx.ui.notify("完成通知已关闭", "info");
+      } else {
+        const sound = config.sound ? `, 声音=${config.sound}` : ", 静音";
+        ctx.ui.notify(
+          `完成通知: ${config.enabled ? "开" : "关"}, 最短时长=${config.minDurationSec}s, ` +
+            `成功=${config.onSuccess ? "开" : "关"}, 失败=${config.onFailure ? "开" : "关"}, ` +
+            `中止=${config.onAbort ? "开" : "关"}, 会话结束=${config.onSessionEnd ? "开" : "关"}${sound}`,
+          "info",
+        );
+      }
+    },
+  });
+}

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "token-stats-timer",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "pi extension to display token usage and time spend.",
   "keywords": [
+    "pi-package",
     "pi-extension"
   ],
   "license": "ISC",
@@ -10,11 +11,30 @@
   "type": "module",
   "main": "index.ts",
   "files": [
+    "index.ts",
     "run-timer.ts",
     "token-stats.ts",
+    "notify.ts",
     "README.md"
   ],
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "pi": {
+    "extensions": [
+      "./index.ts"
+    ]
+  },
+  "peerDependencies": {
+    "@earendil-works/pi-ai": "*",
+    "@earendil-works/pi-coding-agent": "*",
+    "@earendil-works/pi-tui": "*"
+  },
+  "devEngines": {
+    "packageManager": {
+      "name": "nub",
+      "version": "^0.7.5",
+      "onFail": "ignore"
+    }
   }
 }