@trydying/opencode-feishu-notifier 0.3.1 → 0.3.3

package/README.md

@@ -107,6 +107,19 @@ gh api --method PUT /user/starred/Thrimbda/opencode-feishu-notifier
 }
 ```
 
+也支持将 `appId` 和 `appSecret` 写成环境变量占位符（变量名可自定义）：
+
+```json
+{
+  "appId": "${FEISHU_CUSTOM_APP_ID}",
+  "appSecret": "${FEISHU_CUSTOM_APP_SECRET}",
+  "receiverType": "user_id",
+  "receiverId": "your_user_id"
+}
+```
+
+当配置使用 `${ENV_NAME}` 格式时，插件会在启动时读取对应环境变量；如果变量未设置会报错。
+
 ### 2. OpenCode 插件配置
 
 在 `~/.config/opencode/opencode.json` 中启用插件：

package/package.json

@@ -1,42 +1,27 @@
 {
   "name": "@trydying/opencode-feishu-notifier",
-  "version": "0.3.1",
+  "version": "0.3.3",
   "description": "OpenCode plugin for Feishu notifications",
   "type": "module",
-  "main": "dist/index.js",
-  "module": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "src/index.ts",
   "files": [
-    "dist"
+    "src"
   ],
   "scripts": {
-    "typecheck": "tsc --noEmit",
-    "build": "tsup"
+    "typecheck": "tsc --noEmit"
   },
   "dependencies": {
     "@opencode-ai/plugin": "^1.0.0"
   },
   "devDependencies": {
     "@types/node": "^22.0.0",
-    "tsup": "^8.3.5",
     "typescript": "^5.5.0"
   },
-  "publishConfig": {
-    "access": "public"
-  },
-  "keywords": [
-    "opencode",
-    "plugin",
-    "feishu",
-    "notification"
-  ],
-  "author": "trydying@mail.ustc.edu.cn",
-  "license": "MIT",
   "engines": {
     "bun": ">=1.0.0"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/Thrimbda/opencode-feishu-notifier.git"
+    "url": "https://github.com/Thrimbda/opencode-feishu-notifier"
   }
 }

package/src/config.ts

@@ -0,0 +1,176 @@
+import fs from "fs"
+import os from "os"
+import path from "path"
+
+export type ReceiverType = "user_id" | "open_id" | "chat_id"
+
+export interface FeishuConfig {
+  appId: string
+  appSecret: string
+  receiverType: ReceiverType
+  receiverId: string
+}
+
+export interface LoadConfigOptions {
+  directory?: string
+  configPath?: string
+}
+
+export type ConfigSource =
+  | { type: "file"; detail: string }
+  | { type: "env"; detail: string }
+
+const receiverTypes: ReceiverType[] = ["user_id", "open_id", "chat_id"]
+
+function getConfigPaths(options: LoadConfigOptions): string[] {
+  if (options.configPath) {
+    return [options.configPath]
+  }
+
+  const paths: string[] = []
+  const directory = options.directory ?? process.cwd()
+  const xdgConfig = process.env.XDG_CONFIG_HOME ?? path.join(os.homedir(), ".config")
+
+  paths.push(path.join(xdgConfig, "opencode", "feishu-notifier.json"))
+  paths.push(path.join(directory, ".opencode", "feishu-notifier.json"))
+
+  return paths
+}
+
+function readConfigFile(filePath: string): Partial<FeishuConfig> | null {
+  if (!fs.existsSync(filePath)) {
+    return null
+  }
+
+  const raw = fs.readFileSync(filePath, "utf8").trim()
+  if (!raw) {
+    return null
+  }
+
+  try {
+    return JSON.parse(raw) as Partial<FeishuConfig>
+  } catch (error) {
+    throw new Error(`Invalid JSON in ${filePath}: ${String(error)}`)
+  }
+}
+
+function resolveEnvPlaceholder(value: string | undefined, fieldName: keyof FeishuConfig): string | undefined {
+  if (!value) {
+    return value
+  }
+
+  const envReferenceMatch = value.match(/^\$\{([A-Za-z_][A-Za-z0-9_]*)\}$/)
+  if (!envReferenceMatch) {
+    return value
+  }
+
+  const envName = envReferenceMatch[1]
+  const envValue = process.env[envName]
+
+  if (!envValue) {
+    throw new Error(
+      `Config field ${fieldName} references environment variable ${envName}, but it is not set.`
+    )
+  }
+
+  return envValue
+}
+
+function resolveConfigPlaceholders(config: Partial<FeishuConfig>): Partial<FeishuConfig> {
+  return {
+    ...config,
+    appId: resolveEnvPlaceholder(config.appId, "appId"),
+    appSecret: resolveEnvPlaceholder(config.appSecret, "appSecret"),
+    receiverType: resolveEnvPlaceholder(config.receiverType, "receiverType") as
+      | ReceiverType
+      | undefined,
+    receiverId: resolveEnvPlaceholder(config.receiverId, "receiverId")
+  }
+}
+
+function readEnvConfig(): Partial<FeishuConfig> {
+  return {
+    appId: process.env.FEISHU_APP_ID,
+    appSecret: process.env.FEISHU_APP_SECRET,
+    receiverType: process.env.FEISHU_RECEIVER_TYPE as ReceiverType | undefined,
+    receiverId: process.env.FEISHU_RECEIVER_ID
+  }
+}
+
+function resolveConfig(options: LoadConfigOptions): {
+  mergedConfig: Partial<FeishuConfig>
+  sources: ConfigSource[]
+} {
+  const configPaths = getConfigPaths(options)
+  let mergedConfig: Partial<FeishuConfig> = {}
+  const sources: ConfigSource[] = []
+
+  for (const configPath of configPaths) {
+    const config = readConfigFile(configPath)
+    if (config) {
+      const resolvedConfig = resolveConfigPlaceholders(config)
+      mergedConfig = {
+        ...mergedConfig,
+        ...resolvedConfig
+      }
+      sources.push({ type: "file", detail: configPath })
+    }
+  }
+
+  const envConfig = readEnvConfig()
+  if (envConfig.appId || envConfig.appSecret || envConfig.receiverType || envConfig.receiverId) {
+    mergedConfig = {
+      ...mergedConfig,
+      ...envConfig
+    }
+    sources.push({ type: "env", detail: "FEISHU_*" })
+  }
+
+  return { mergedConfig, sources }
+}
+
+function finalizeConfig(mergedConfig: Partial<FeishuConfig>, sources: ConfigSource[]): FeishuConfig {
+  if (sources.length === 0) {
+    throw new Error(
+      "Missing Feishu configuration. Use FEISHU_* environment variables or create feishu-notifier.json."
+    )
+  }
+
+  const missing: string[] = []
+  if (!mergedConfig.appId) missing.push("appId")
+  if (!mergedConfig.appSecret) missing.push("appSecret")
+  if (!mergedConfig.receiverType) missing.push("receiverType")
+  if (!mergedConfig.receiverId) missing.push("receiverId")
+
+  if (missing.length > 0) {
+    throw new Error(`Missing config fields: ${missing.join(", ")}`)
+  }
+
+  const receiverType = mergedConfig.receiverType as ReceiverType
+  if (!receiverTypes.includes(receiverType)) {
+    throw new Error(
+      `Invalid receiverType: ${mergedConfig.receiverType}. Expected one of ${receiverTypes.join(", ")}`
+    )
+  }
+
+  return {
+    appId: mergedConfig.appId!,
+    appSecret: mergedConfig.appSecret!,
+    receiverType,
+    receiverId: mergedConfig.receiverId!
+  }
+}
+
+export function loadConfig(options: LoadConfigOptions = {}): FeishuConfig {
+  return loadConfigWithSource(options).config
+}
+
+export function loadConfigWithSource(
+  options: LoadConfigOptions = {}
+): { config: FeishuConfig; sources: ConfigSource[] } {
+  const { mergedConfig, sources } = resolveConfig(options)
+  return {
+    config: finalizeConfig(mergedConfig, sources),
+    sources
+  }
+}

package/src/context/progress.ts

@@ -0,0 +1,174 @@
+import type { ProgressInfo } from "../types";
+
+/**
+ * 从事件负载中提取进度信息
+ * @param eventPayload 事件负载
+ * @returns 进度信息
+ */
+export function extractProgressInfo(eventPayload?: unknown): ProgressInfo {
+  const timestamp = new Date().toISOString();
+
+  // 尝试从事件负载中提取信息
+  let lastAction: string | undefined;
+  let currentTask: string | undefined;
+
+  if (eventPayload && typeof eventPayload === "object") {
+    const payload = eventPayload as Record<string, unknown>;
+
+    // 尝试从常见字段提取信息
+    if (typeof payload.message === "string") {
+      lastAction = payload.message;
+    } else if (typeof payload.description === "string") {
+      lastAction = payload.description;
+    } else if (typeof payload.action === "string") {
+      lastAction = payload.action;
+    }
+
+    if (typeof payload.task === "string") {
+      currentTask = payload.task;
+    } else if (typeof payload.currentTask === "string") {
+      currentTask = payload.currentTask;
+    }
+  }
+
+  // 如果没有从负载中提取到信息，提供默认值
+  if (!lastAction) {
+    lastAction = "OpenCode 正在处理任务";
+  }
+
+  return {
+    lastAction,
+    currentTask,
+    timestamp,
+    // 文件变更信息需要从 Git 或其他来源获取，这里暂时留空
+  };
+}
+
+/**
+ * 从 Git 状态中提取文件变更信息
+ * @param directory 工作目录
+ * @returns 文件变更信息
+ */
+export function extractFileChanges(directory: string):
+  | {
+      added?: number;
+      modified?: number;
+      deleted?: number;
+    }
+  | undefined {
+  try {
+    const { execSync } = require("child_process");
+
+    // 获取 Git 状态摘要
+    const statusOutput = execSync("git status --porcelain", {
+      cwd: directory,
+      encoding: "utf-8",
+    });
+
+    let added = 0;
+    let modified = 0;
+    let deleted = 0;
+
+    const lines = statusOutput.trim().split("\n");
+    for (const line of lines) {
+      if (!line.trim()) continue;
+
+      const status = line.substring(0, 2).trim();
+      if (status === "A" || status.startsWith("A")) {
+        added++;
+      } else if (status === "M" || status.startsWith("M")) {
+        modified++;
+      } else if (status === "D" || status.startsWith("D")) {
+        deleted++;
+      } else if (status === "??") {
+        added++; // 未跟踪的文件视为新增
+      }
+    }
+
+    if (added > 0 || modified > 0 || deleted > 0) {
+      return { added, modified, deleted };
+    }
+  } catch (error) {
+    // Git 命令失败或不是 Git 仓库
+  }
+
+  return undefined;
+}
+
+/**
+ * 创建带文件变更信息的进度信息
+ * @param eventPayload 事件负载
+ * @param directory 工作目录
+ * @returns 完整的进度信息
+ */
+export function createProgressInfo(
+  eventPayload?: unknown,
+  directory?: string
+): ProgressInfo {
+  const baseInfo = extractProgressInfo(eventPayload);
+
+  // 如果提供了目录，尝试获取文件变更信息
+  if (directory) {
+    const fileChanges = extractFileChanges(directory);
+    if (fileChanges) {
+      return {
+        ...baseInfo,
+        fileChanges,
+      };
+    }
+  }
+
+  return baseInfo;
+}
+
+/**
+ * 格式化进度信息为可读文本
+ * @param progress 进度信息
+ * @returns 格式化后的文本
+ */
+export function formatProgressInfo(progress: ProgressInfo): string {
+  const lines: string[] = [];
+
+  // 格式化时间戳
+  const time = new Date(progress.timestamp);
+  const timeStr = time.toLocaleString("zh-CN", {
+    year: "numeric",
+    month: "2-digit",
+    day: "2-digit",
+    hour: "2-digit",
+    minute: "2-digit",
+    second: "2-digit",
+  });
+
+  lines.push(`• 时间：${timeStr}`);
+
+  if (progress.lastAction) {
+    lines.push(`• 最近操作：${progress.lastAction}`);
+  }
+
+  if (progress.currentTask) {
+    lines.push(`• 当前任务：${progress.currentTask}`);
+  }
+
+  // 添加文件变更信息
+  if (progress.fileChanges) {
+    const changes = progress.fileChanges;
+    const changeParts: string[] = [];
+
+    if (changes.added && changes.added > 0) {
+      changeParts.push(`新增 ${changes.added} 个文件`);
+    }
+    if (changes.modified && changes.modified > 0) {
+      changeParts.push(`修改 ${changes.modified} 个文件`);
+    }
+    if (changes.deleted && changes.deleted > 0) {
+      changeParts.push(`删除 ${changes.deleted} 个文件`);
+    }
+
+    if (changeParts.length > 0) {
+      lines.push(`• 文件变更：${changeParts.join("，")}`);
+    }
+  }
+
+  return lines.join("\n");
+}

package/src/context/project.ts

@@ -0,0 +1,202 @@
+import { execSync } from "child_process";
+import fs from "fs";
+import path from "path";
+import os from "os";
+import type { ProjectContext } from "../types";
+
+/**
+ * 提取项目上下文信息
+ * @param directory 工作目录路径
+ * @returns 项目上下文信息
+ */
+export async function extractProjectContext(
+  directory: string
+): Promise<ProjectContext> {
+  const workingDir = path.resolve(directory);
+
+  // 从 package.json 提取项目名称，否则使用目录名
+  const projectName = await extractProjectName(workingDir);
+
+  // 检查是否为 Git 仓库并提取信息
+  const gitInfo = await extractGitInfo(workingDir);
+
+  return {
+    projectName,
+    branch: gitInfo.branch,
+    workingDir,
+    repoUrl: gitInfo.repoUrl,
+    isGitRepo: gitInfo.isGitRepo,
+    hostname: os.hostname(),
+  };
+}
+
+/**
+ * 从 package.json 或目录名提取项目名称
+ */
+async function extractProjectName(directory: string): Promise<string> {
+  const packageJsonPath = path.join(directory, "package.json");
+
+  if (fs.existsSync(packageJsonPath)) {
+    try {
+      const content = await fs.promises.readFile(packageJsonPath, "utf-8");
+      const packageJson = JSON.parse(content);
+      if (packageJson.name) {
+        return packageJson.name;
+      }
+    } catch {
+      // 如果读取失败，使用目录名
+    }
+  }
+
+  // 使用目录名作为项目名
+  return path.basename(directory);
+}
+
+/**
+ * 提取 Git 仓库信息
+ */
+async function extractGitInfo(directory: string): Promise<{
+  isGitRepo: boolean;
+  branch?: string;
+  repoUrl?: string;
+}> {
+  const gitDir = path.join(directory, ".git");
+
+  if (!fs.existsSync(gitDir)) {
+    return { isGitRepo: false };
+  }
+
+  try {
+    // 获取当前分支
+    const branch = execSync("git branch --show-current", {
+      cwd: directory,
+      encoding: "utf-8",
+    }).trim();
+
+    // 获取远程仓库 URL
+    let repoUrl: string | undefined;
+    try {
+      const remoteUrl = execSync("git config --get remote.origin.url", {
+        cwd: directory,
+        encoding: "utf-8",
+      }).trim();
+
+      if (remoteUrl) {
+        // 转换 SSH URL 为 HTTPS URL（如果适用）
+        repoUrl = convertGitUrlToWeb(remoteUrl);
+      }
+    } catch {
+      // 无法获取远程 URL，忽略
+    }
+
+    return {
+      isGitRepo: true,
+      branch: branch || undefined,
+      repoUrl,
+    };
+  } catch (error) {
+    // Git 命令失败，但目录中有 .git 文件夹
+    return { isGitRepo: true };
+  }
+}
+
+/**
+ * 转换 Git URL 为可访问的 Web URL
+ */
+function convertGitUrlToWeb(gitUrl: string): string {
+  // 移除 .git 后缀
+  let url = gitUrl.replace(/\.git$/, "");
+
+  // 转换 SSH URL 为 HTTPS URL
+  // git@github.com:user/repo -> https://github.com/user/repo
+  if (url.startsWith("git@")) {
+    url = url.replace(":", "/").replace("git@", "https://");
+  }
+
+  return url;
+}
+
+/**
+ * 简化版：同步提取项目上下文（用于简单场景）
+ */
+export function extractProjectContextSync(directory: string): ProjectContext {
+  const workingDir = path.resolve(directory);
+  const projectName = extractProjectNameSync(workingDir);
+  const gitInfo = extractGitInfoSync(workingDir);
+
+  return {
+    projectName,
+    branch: gitInfo.branch,
+    workingDir,
+    repoUrl: gitInfo.repoUrl,
+    isGitRepo: gitInfo.isGitRepo,
+    hostname: os.hostname(),
+  };
+}
+
+/**
+ * 同步提取项目名称
+ */
+function extractProjectNameSync(directory: string): string {
+  const packageJsonPath = path.join(directory, "package.json");
+
+  if (fs.existsSync(packageJsonPath)) {
+    try {
+      const content = fs.readFileSync(packageJsonPath, "utf-8");
+      const packageJson = JSON.parse(content);
+      if (packageJson.name) {
+        return packageJson.name;
+      }
+    } catch {
+      // 如果读取失败，使用目录名
+    }
+  }
+
+  return path.basename(directory);
+}
+
+/**
+ * 同步提取 Git 信息
+ */
+function extractGitInfoSync(directory: string): {
+  isGitRepo: boolean;
+  branch?: string;
+  repoUrl?: string;
+} {
+  const gitDir = path.join(directory, ".git");
+
+  if (!fs.existsSync(gitDir)) {
+    return { isGitRepo: false };
+  }
+
+  try {
+    // 获取当前分支
+    const branch = execSync("git branch --show-current", {
+      cwd: directory,
+      encoding: "utf-8",
+    }).trim();
+
+    // 获取远程仓库 URL
+    let repoUrl: string | undefined;
+    try {
+      const remoteUrl = execSync("git config --get remote.origin.url", {
+        cwd: directory,
+        encoding: "utf-8",
+      }).trim();
+
+      if (remoteUrl) {
+        repoUrl = convertGitUrlToWeb(remoteUrl);
+      }
+    } catch {
+      // 无法获取远程 URL，忽略
+    }
+
+    return {
+      isGitRepo: true,
+      branch: branch || undefined,
+      repoUrl,
+    };
+  } catch (error) {
+    return { isGitRepo: true };
+  }
+}