@freely01/opencode-notify 0.1.0

package/cli.ts

@@ -0,0 +1,354 @@
+#!/usr/bin/env bun
+/**
+ * opencode-notify 诊断与调试 CLI
+ *
+ * 用法:
+ *   bun cli.ts check              检查配置文件的正确性
+ *   bun cli.ts test                测试所有已启用的通知渠道
+ *   bun cli.ts test <channel>      测试指定渠道 (system|wechat_work|feishu|custom_webhook)
+ *   bun cli.ts log [lines]         查看最近 N 行插件日志 (默认 20)
+ *   bun cli.ts info                显示插件版本、配置、渠道状态等综合信息
+ *   bun cli.ts help                显示帮助
+ */
+
+import { loadYamlConfig, resolveConfig, mergeConfig } from "./config.js"
+import type { PluginConfig, ChannelsConfig } from "./config.js"
+import type { Message } from "./message.js"
+import { SystemSender } from "./senders/system.js"
+import { CustomWebhookSender } from "./senders/custom-webhook.js"
+import { WechatWorkSender } from "./senders/wechat-work.js"
+import { FeishuSender } from "./senders/feishu.js"
+import { readFileSync, existsSync, statSync } from "node:fs"
+import { homedir } from "node:os"
+import { join } from "node:path"
+
+// ─── 常量 ───────────────────────────────────────────────────────────────────
+
+const PKG = JSON.parse(readFileSync(join(import.meta.dirname, "package.json"), "utf-8"))
+const LOG_FILE = join(homedir(), ".opencode-notify", "plugin.log")
+const YAML_PATH = process.env.OPENCODE_NOTIFY_CONFIG ?? join(homedir(), ".config", "opencode", "opencode-notify.yaml")
+
+const SAMPLE_MSG: Message = {
+  agent: "opencode",
+  event: "permission_required",
+  sessionID: "diagnose-test",
+  title: "opencode - 诊断测试",
+  body: "这是一条来自诊断工具的测试通知，如果收到说明渠道配置正确",
+}
+
+// ─── main ───────────────────────────────────────────────────────────────────
+
+async function main() {
+  const args = process.argv.slice(2)
+  const cmd = args[0] ?? "help"
+
+  switch (cmd) {
+    case "check":
+      cmdCheck()
+      break
+    case "test":
+      await cmdTest(args[1])
+      break
+    case "log":
+      cmdLog(args[1] ? parseInt(args[1], 10) : 20)
+      break
+    case "info":
+      cmdInfo()
+      break
+    case "help":
+    default:
+      cmdHelp()
+      break
+  }
+}
+
+// ─── 命令: check ─────────────────────────────────────────────────────────────
+
+function cmdCheck() {
+  console.log("═".repeat(50))
+  console.log("  🔍 配置检查")
+  console.log("═".repeat(50))
+
+  // 1. 检查配置文件是否存在
+  if (!existsSync(YAML_PATH)) {
+    console.log(`\n❌ 配置文件不存在: ${YAML_PATH}`)
+    console.log("   请创建配置文件，或设置 OPENCODE_NOTIFY_CONFIG 环境变量指向正确的路径")
+    process.exit(1)
+  }
+  console.log(`\n✅ 配置文件: ${YAML_PATH}`)
+
+  // 2. 尝试解析 YAML
+  let yamlCfg: PluginConfig | null = null
+  try {
+    yamlCfg = loadYamlConfig()
+    console.log("✅ YAML 解析成功")
+  } catch (e: any) {
+    console.log(`\n❌ YAML 解析失败: ${e.message}`)
+    process.exit(1)
+  }
+  if (!yamlCfg) {
+    console.log("\n❌ YAML 解析返回空")
+    process.exit(1)
+  }
+
+  // 3. resolveConfig 合并
+  const cfg = resolveConfig(mergeConfig(yamlCfg, {}))
+
+  // 4. 检查渠道配置
+  const channels = cfg.channels ?? {}
+  let hasError = false
+
+  for (const [name, ch] of Object.entries(channels)) {
+    if (!ch || !ch.enabled) continue
+
+    switch (name) {
+      case "system":
+        console.log(`\n✅ 系统通知: 已启用`)
+        break
+      case "custom_webhook": {
+        const c = ch as any
+        if (!c.url) {
+          console.log(`\n❌ 自定义 Webhook: 已启用但未配置 url`)
+          hasError = true
+        } else {
+          console.log(`\n✅ 自定义 Webhook: url=${c.url}`)
+        }
+        break
+      }
+      case "wechat_work": {
+        const c = ch as any
+        if (!c.webhook_url) {
+          console.log(`\n❌ 企业微信: 已启用但未配置 webhook_url`)
+          hasError = true
+        } else {
+          console.log(`\n✅ 企业微信: webhook_url=${c.webhook_url.slice(0, 60)}...`)
+        }
+        break
+      }
+      case "feishu": {
+        const c = ch as any
+        if (!c.webhook_url) {
+          console.log(`\n❌ 飞书: 已启用但未配置 webhook_url`)
+          hasError = true
+        } else {
+          console.log(`\n✅ 飞书: webhook_url=${c.webhook_url.slice(0, 60)}...`)
+        }
+        break
+      }
+    }
+  }
+
+  // 5. 检查订阅事件
+  const events = cfg.events ?? []
+  console.log(`\n📋 订阅事件: ${events.length > 0 ? events.join(", ") : "(无)"}`)
+
+  // 6. 检查活跃抑制
+  console.log(`\n🔇 活跃抑制: ${cfg.suppress_when_active ? "开启" : "关闭"} (超时 ${cfg.activity_timeout_ms}ms)`)
+
+  // 7. 检查去重
+  console.log(`\n🔄 去重窗口: ${cfg.dedupe_seconds} 秒`)
+
+  if (hasError) {
+    console.log(`\n⚠️  检查完成，存在配置错误，请修正后重试`)
+    process.exit(1)
+  }
+  console.log(`\n✅ 配置检查通过！`)
+}
+
+// ─── 命令: test ──────────────────────────────────────────────────────────────
+
+async function cmdTest(channel?: string) {
+  const yamlCfg = loadYamlConfig() ?? {}
+  const cfg = resolveConfig(mergeConfig(yamlCfg, {}))
+  const channels = cfg.channels ?? {}
+  const allChannels: [string, boolean, () => Promise<void>][] = []
+
+  // 收集要测试的渠道
+  function add(name: string, enabled: boolean, sender: () => Promise<void>) {
+    allChannels.push([name, enabled, sender])
+  }
+
+  add("system_message", !!(channels.system_message?.enabled), async () => {
+    await new SystemSender().send(SAMPLE_MSG)
+  })
+
+  if (channels.custom_webhook?.enabled && channels.custom_webhook.url) {
+    add("custom_webhook", true, async () => {
+      await new CustomWebhookSender(channels.custom_webhook!).send(SAMPLE_MSG)
+    })
+  }
+
+  if (channels.wechat_work?.enabled && channels.wechat_work.webhook_url) {
+    add("wechat_work", true, async () => {
+      await new WechatWorkSender(channels.wechat_work!).send(SAMPLE_MSG)
+    })
+  }
+
+  if (channels.feishu?.enabled && channels.feishu.webhook_url) {
+    add("feishu", true, async () => {
+      await new FeishuSender(channels.feishu!).send(SAMPLE_MSG)
+    })
+  }
+
+  // 过滤
+  const targets = channel
+    ? allChannels.filter(([n]) => n === channel)
+    : allChannels
+
+  if (targets.length === 0) {
+    console.log(`没有匹配的渠道。${channel ? `渠道 "${channel}" 不存在或未启用。` : "请在配置文件中启用至少一个渠道。"}`)
+    console.log("可用渠道: system, custom_webhook, wechat_work, feishu")
+    process.exit(1)
+  }
+
+  console.log(`开始测试 ${targets.length} 个渠道...\n`)
+
+  for (const [name, enabled, send] of targets) {
+    process.stdout.write(`  ${enabled ? "▶" : "⏭"} ${name} ... `)
+    try {
+      await send()
+      console.log("✅ 成功")
+    } catch (e: any) {
+      console.log(`❌ 失败: ${e.message}`)
+    }
+  }
+
+  console.log("\n测试完成。")
+}
+
+// ─── 命令: log ───────────────────────────────────────────────────────────────
+
+function cmdLog(lines: number) {
+  if (!existsSync(LOG_FILE)) {
+    console.log(`日志文件不存在: ${LOG_FILE}`)
+    console.log("插件尚未运行过，或日志已被清理。")
+    process.exit(1)
+  }
+
+  const stat = statSync(LOG_FILE)
+  const all = readFileSync(LOG_FILE, "utf-8").trimEnd()
+  const entries = all.split("\n")
+
+  console.log(`📄 ${LOG_FILE} (${(stat.size / 1024).toFixed(1)} KB, ${entries.length} 行)\n`)
+
+  const tail = entries.slice(-lines)
+  for (const line of tail) {
+    // 着色: 错误行标红，成功行标绿
+    if (line.includes("失败") || line.includes("error") || line.includes("Error")) {
+      console.log(`  ${line}`)
+    } else if (line.includes("成功") || line.includes("✅")) {
+      console.log(`  ${line}`)
+    } else {
+      console.log(`  ${line}`)
+    }
+  }
+
+  if (entries.length > lines) {
+    console.log(`\n... 共 ${entries.length} 行，显示最后 ${lines} 行`)
+  }
+}
+
+// ─── 命令: info ──────────────────────────────────────────────────────────────
+
+function cmdInfo() {
+  console.log("═".repeat(50))
+  console.log("  📋 opencode-notify 插件信息")
+  console.log("═".repeat(50))
+
+  // 版本
+  console.log(`\n  📦 版本:       ${PKG.version}`)
+  console.log(`  📂 项目路径:   ${import.meta.dirname}`)
+
+  // 配置文件
+  console.log(`\n  📄 配置文件:`)
+  if (existsSync(YAML_PATH)) {
+    const stat = statSync(YAML_PATH)
+    console.log(`     路径: ${YAML_PATH}`)
+    console.log(`     大小: ${(stat.size / 1024).toFixed(1)} KB`)
+  } else {
+    console.log(`     路径: ${YAML_PATH} (不存在，使用默认配置)`)
+  }
+
+  // 日志文件
+  console.log(`\n  📝 日志文件:`)
+  if (existsSync(LOG_FILE)) {
+    const stat = statSync(LOG_FILE)
+    const lines = readFileSync(LOG_FILE, "utf-8").split("\n").length
+    const recent = readFileSync(LOG_FILE, "utf-8").trimEnd().split("\n").slice(-1)[0] ?? ""
+    console.log(`     路径: ${LOG_FILE}`)
+    console.log(`     大小: ${(stat.size / 1024).toFixed(1)} KB, ${lines} 行`)
+    console.log(`     最新: ${recent}`)
+  } else {
+    console.log(`     路径: ${LOG_FILE} (暂无日志)`)
+  }
+
+  // 配置详情
+  const yamlCfg = loadYamlConfig()
+  const cfg = yamlCfg ? resolveConfig(mergeConfig(yamlCfg, {})) : null
+
+  if (cfg) {
+    const ch = cfg.channels ?? {}
+
+    console.log(`\n  🔔 通知渠道:`)
+    const channelNames: [string, any, string][] = [
+      ["系统消息", ch.system_message, ""],
+      ["屏幕跑马灯", ch.screen_flash, ch.screen_flash?.enabled ? `强度${ch.screen_flash.intensity ?? 0.9}` : ""],
+      ["自定义 Webhook", ch.custom_webhook, ch.custom_webhook?.url ?? ""],
+      ["企业微信", ch.wechat_work, ch.wechat_work?.webhook_url ? `${ch.wechat_work.webhook_url.slice(0, 40)}...` : ""],
+      ["飞书", ch.feishu, ch.feishu?.webhook_url ? `${ch.feishu.webhook_url.slice(0, 40)}...` : ""],
+    ]
+    for (const [label, config, url] of channelNames) {
+      if (config?.enabled) {
+        const urlInfo = url ? ` ${url}` : ""
+        console.log(`     ✅ ${label}${urlInfo}`)
+      } else {
+        console.log(`     ⏸  ${label} (未启用)`)
+      }
+    }
+
+    console.log(`\n  📋 订阅事件:   ${cfg.events?.join(", ") ?? "(无)"}`)
+    console.log(`  🔇 活跃抑制:   ${cfg.suppress_when_active ? "开启" : "关闭"}`)
+    console.log(`  ⏱  去重窗口:   ${cfg.dedupe_seconds} 秒`)
+  } else {
+    console.log(`\n  ⚠️  未加载到配置`)
+  }
+
+  console.log(`\n  🔧 诊断命令:`)
+  console.log(`     bun cli.ts check      检查配置`)
+  console.log(`     bun cli.ts test       测试所有渠道`)
+  console.log(`     bun cli.ts log        查看日志`)
+}
+
+// ─── 命令: help ──────────────────────────────────────────────────────────────
+
+function cmdHelp() {
+  console.log("opencode-notify 诊断工具")
+  console.log("")
+  console.log("用法:")
+  console.log("  bun cli.ts check              检查配置文件")
+  console.log("  bun cli.ts test                测试所有通知渠道")
+  console.log("  bun cli.ts test <channel>      测试指定渠道")
+  console.log("  bun cli.ts log [lines]         查看插件日志 (默认 20 行)")
+  console.log("  bun cli.ts info                显示插件综合信息")
+  console.log("  bun cli.ts help                显示此帮助")
+  console.log("")
+  console.log("渠道名称:")
+  console.log("  system          系统通知")
+  console.log("  wechat_work     企业微信")
+  console.log("  feishu          飞书")
+  console.log("  custom_webhook  自定义 Webhook")
+  console.log("")
+  console.log("示例:")
+  console.log("  bun cli.ts check")
+  console.log("  bun cli.ts test wechat_work")
+  console.log("  bun cli.ts test feishu")
+  console.log("  bun cli.ts log 50")
+  console.log("  bun cli.ts info")
+}
+
+// ─── 启动 ────────────────────────────────────────────────────────────────────
+
+main().catch((e) => {
+  console.error("诊断工具执行出错:", e.message)
+  process.exit(1)
+})

package/config.ts

@@ -0,0 +1,217 @@
+/** 通知渠道配置 */
+export interface ChannelConfig {
+  enabled: boolean
+  /**
+   * 渠道级事件过滤 — 仅这些事件触发本渠道通知
+   * 不填或留空则继承全局 events
+   */
+  events?: string[]
+}
+
+/** 系统消息通知配置 */
+export interface SystemMessageChannelConfig extends ChannelConfig {}
+
+/** 屏幕跑马灯渠道配置 */
+export interface ScreenFlashChannelConfig extends ChannelConfig {
+  /** 持续秒数，默认 3.0 */
+  duration?: number
+  /** 移动速度因子，默认 4.0 */
+  speed?: number
+  /** 不透明度 0.0–1.0，默认 0.9 */
+  intensity?: number
+}
+
+/** 企业微信通知配置 */
+export interface WechatWorkChannelConfig extends ChannelConfig {
+  webhook_url?: string
+}
+
+/** 飞书通知配置 */
+export interface FeishuChannelConfig extends ChannelConfig {
+  webhook_url?: string
+}
+
+/** 自定义 Webhook 配置 */
+export interface CustomWebhookChannelConfig extends ChannelConfig {
+  url?: string
+  method?: "POST" | "GET"
+  headers?: Record<string, string>
+  /** 消息模板，支持占位符 {{title}} {{body}} {{event}} */
+  template?: string
+}
+
+/** 渠道配置集合 */
+export interface ChannelsConfig {
+  system_message?: SystemMessageChannelConfig
+  screen_flash?: ScreenFlashChannelConfig
+  wechat_work?: WechatWorkChannelConfig
+  feishu?: FeishuChannelConfig
+  custom_webhook?: CustomWebhookChannelConfig
+}
+
+/** 插件配置 */
+export interface PluginConfig {
+  channels?: ChannelsConfig
+  /**
+   * 需要通知的事件列表
+   * 可选值:
+   *   permission_required  - Agent 需要用户授权（执行命令、读写文件等）
+   *   input_required       - Agent 等待用户输入
+   *   run_completed        - 任务执行完成（技术预留，暂未实现）
+   *   run_failed           - 任务执行失败
+   */
+  events?: string[]
+  /** 去重时间窗口（秒），默认 60 */
+  dedupe_seconds?: number
+  /**
+   * 当用户活跃（正在操作 TUI）时抑制通知
+   * 检测的事件：message.updated / permission.replied / question.replied / command.executed / tui.command.execute
+   * @default true
+   */
+  suppress_when_active?: boolean
+  /** 用户活跃超时时间（毫秒），超过此时间无操作视为离开 */
+  activity_timeout_ms?: number
+  /** 写入 ~/.opencode-notify/plugin.log 调试日志，默认 false */
+  debug_log?: boolean
+}
+
+import { readFileSync, existsSync } from "node:fs"
+import { homedir } from "node:os"
+import { join } from "node:path"
+import yaml from "js-yaml"
+
+/**
+ * 加载 YAML 配置文件
+ *
+ * 文件路径优先级:
+ * 1. OPENCODE_NOTIFY_CONFIG 环境变量
+ * 2. ~/.config/opencode/opencode-notify.yaml
+ *
+ * 文件不存在时返回 null，插件使用默认配置 + plugin options
+ */
+export function loadYamlConfig(): PluginConfig | null {
+  const configPath =
+    process.env.OPENCODE_NOTIFY_CONFIG ??
+    join(homedir(), ".config", "opencode", "opencode-notify.yaml")
+
+  if (!existsSync(configPath)) return null
+
+  const raw = readFileSync(configPath, "utf-8")
+  return yaml.load(raw) as PluginConfig
+}
+
+/**
+ * 浅层合并配置：overrides 覆盖 base 的对应字段
+ * 用于 YAML 配置 + plugin options 的合并
+ */
+export function mergeConfig(base: PluginConfig, overrides: PluginConfig): PluginConfig {
+  return {
+    ...base,
+    ...overrides,
+    channels: {
+      ...(base.channels ?? {}),
+      ...(overrides.channels ?? {}),
+      system_message: { ...(base.channels?.system_message ?? {}), ...(overrides.channels?.system_message ?? {}) } as any,
+      screen_flash: { ...(base.channels?.screen_flash ?? {}), ...(overrides.channels?.screen_flash ?? {}) } as any,
+      wechat_work: { ...(base.channels?.wechat_work ?? {}), ...(overrides.channels?.wechat_work ?? {}) } as any,
+      feishu: { ...(base.channels?.feishu ?? {}), ...(overrides.channels?.feishu ?? {}) } as any,
+      custom_webhook: { ...(base.channels?.custom_webhook ?? {}), ...(overrides.channels?.custom_webhook ?? {}) } as any,
+    },
+  }
+}
+
+/** 默认配置 */
+const DEFAULT_CONFIG: Required<Pick<PluginConfig, "suppress_when_active" | "activity_timeout_ms" | "debug_log">> & PluginConfig = {
+  channels: {
+    system_message: { enabled: true },
+    screen_flash: { enabled: false },
+    wechat_work: { enabled: false },
+    feishu: { enabled: false },
+    custom_webhook: { enabled: false },
+  },
+  events: [
+    "permission_required",
+    "input_required",
+    "run_completed",
+    "run_failed",
+  ],
+  dedupe_seconds: 60,
+  suppress_when_active: true,
+  activity_timeout_ms: 30_000,
+  debug_log: false,
+}
+
+/**
+ * 合并配置：options → 环境变量 → 默认值
+ */
+export function resolveConfig(options: PluginConfig): PluginConfig {
+  const wechatWebhook =
+    options.channels?.wechat_work?.webhook_url ||
+    process.env.OPENCODE_NOTIFY_WECHAT_WEBHOOK
+
+  const feishuWebhook =
+    options.channels?.feishu?.webhook_url ||
+    process.env.OPENCODE_NOTIFY_FEISHU_WEBHOOK
+
+  const customWebhookUrl =
+    options.channels?.custom_webhook?.url ||
+    process.env.OPENCODE_NOTIFY_CUSTOM_WEBHOOK_URL
+
+  // 全局 events，各渠道继承此值
+  const globalEvents = options.events ?? DEFAULT_CONFIG.events
+
+  // 渠道级 events：有则用渠道的，否则继承全局
+  function chEvents(ch: ChannelConfig | undefined): string[] | undefined {
+    return ch?.events?.length ? ch.events : undefined
+  }
+
+  return {
+    channels: {
+      system_message: {
+        enabled:
+          options.channels?.system_message?.enabled ??
+          DEFAULT_CONFIG.channels!.system_message!.enabled,
+        events: chEvents(options.channels?.system_message),
+      },
+      screen_flash: {
+        enabled:
+          options.channels?.screen_flash?.enabled ??
+          DEFAULT_CONFIG.channels!.screen_flash!.enabled,
+        duration: options.channels?.screen_flash?.duration,
+        speed: options.channels?.screen_flash?.speed,
+        intensity: options.channels?.screen_flash?.intensity,
+        events: chEvents(options.channels?.screen_flash),
+      },
+      wechat_work: {
+        enabled:
+          options.channels?.wechat_work?.enabled ??
+          DEFAULT_CONFIG.channels!.wechat_work!.enabled,
+        webhook_url: wechatWebhook || undefined,
+        events: chEvents(options.channels?.wechat_work),
+      },
+      feishu: {
+        enabled:
+          options.channels?.feishu?.enabled ??
+          DEFAULT_CONFIG.channels!.feishu!.enabled,
+        webhook_url: feishuWebhook || undefined,
+        events: chEvents(options.channels?.feishu),
+      },
+      custom_webhook: {
+        enabled:
+          options.channels?.custom_webhook?.enabled ??
+          DEFAULT_CONFIG.channels?.custom_webhook?.enabled ??
+          false,
+        url: customWebhookUrl || undefined,
+        method: options.channels?.custom_webhook?.method ?? "POST",
+        headers: options.channels?.custom_webhook?.headers,
+        template: options.channels?.custom_webhook?.template,
+        events: chEvents(options.channels?.custom_webhook),
+      },
+    },
+    events: globalEvents,
+    dedupe_seconds: options.dedupe_seconds ?? DEFAULT_CONFIG.dedupe_seconds,
+    suppress_when_active: options.suppress_when_active ?? DEFAULT_CONFIG.suppress_when_active,
+    activity_timeout_ms: options.activity_timeout_ms ?? DEFAULT_CONFIG.activity_timeout_ms,
+    debug_log: options.debug_log ?? DEFAULT_CONFIG.debug_log,
+  }
+}

package/dispatcher.ts

@@ -0,0 +1,69 @@
+import type { Message } from "./message.js"
+import type { Sender } from "./senders/types.js"
+import { FileStore } from "./store.js"
+
+/**
+ * 通知分发器
+ *
+ * 职责：
+ * 1. 去重检查（通过 Store）
+ * 2. 遍历所有已启用的 Sender 发送通知
+ * 3. 发送成功后标记状态
+ */
+export class Dispatcher {
+  private store: FileStore
+  private windowSec: number
+  private senders: Sender[]
+
+  constructor(
+    store: FileStore,
+    windowSec: number,
+    senders: Sender[],
+  ) {
+    this.store = store
+    this.windowSec = windowSec
+    this.senders = senders
+  }
+
+  async dispatch(msg: Message): Promise<void> {
+    if (this.senders.length === 0) {
+      return
+    }
+
+    const now = Date.now()
+    const key = this.store.buildKey(msg.agent, msg.event, msg.sessionID)
+
+    // 去重检查 + 预留发送时隙
+    const allowed = this.store.reserveSend(key, this.windowSec, now)
+    if (!allowed) {
+      return // 去重命中，跳过
+    }
+
+    // 并发发送到所有渠道
+    const results = await Promise.allSettled(
+      this.senders.map((s) => s.send(msg)),
+    )
+
+    // 所有都成功 → 标记已发送
+    const allSuccess = results.every(
+      (r) => r.status === "fulfilled",
+    )
+
+    if (allSuccess) {
+      this.store.markSent(key, now)
+    } else {
+      // 有失败 → 释放预留
+      this.store.clearReservation(key)
+      // 记录失败（但不抛异常避免影响主流程）
+      for (let i = 0; i < results.length; i++) {
+        const r = results[i]
+        if (r.status === "rejected") {
+          console.error(
+            `[opencode-notify] sender ${this.senders[i].name} failed:`,
+            r.reason,
+          )
+        }
+      }
+    }
+  }
+}