@wu529778790/open-im 1.10.7-beta.0 → 1.10.7-beta.1

package/README.md

@@ -38,6 +38,10 @@ Config: **`~/.open-im/config.json`**
 
 After `start`, the CLI prints the dashboard URL (default **`http://127.0.0.1:39282`**).
 
+## Git co-authors
+
+`Co-authored-by` is appended by default on AI-driven commits. **Disable:** set **`OPEN_IM_GIT_COAUTHOR=0`** in the environment and restart the bridge.
+
 ## Web dashboard
 
 `open-im start` and `open-im dashboard` serve the built-in SPA and **`/api/*`** on **`OPEN_IM_WEB_PORT`** (default **39282**). Open **`http://127.0.0.1:39282`** in a browser (same origin as the API). Override the displayed URL with **`OPEN_IM_PUBLIC_WEB_URL`** if behind a proxy.

package/README.zh-CN.md

@@ -38,6 +38,10 @@ npx @wu529778790/open-im start
 
 `start` 后会提示控制台地址（默认 **`http://127.0.0.1:39282`**）。
 
+## Git 共同作者
+
+默认在 AI 发起的提交里追加 `Co-authored-by`。**关闭**：设置环境变量 **`OPEN_IM_GIT_COAUTHOR=0`** 并重启桥接。
+
 ## Web 控制台
 
 `open-im start` / `open-im dashboard` 在 **`OPEN_IM_WEB_PORT`**（默认 **39282**）提供内置页面与 **`/api/*`**。浏览器打开 **`http://127.0.0.1:39282`** 即可（与 API 同源）。反向代理时可设 **`OPEN_IM_PUBLIC_WEB_URL`**。

package/dist/constants.d.ts

@@ -17,6 +17,11 @@ export declare const WEB_CONFIG_PORT = 39282;
 export declare function getDefaultLocalDashboardUrl(): string;
 export declare function getPublicWebDashboardUrl(): string;
 export declare const IMAGE_DIR: string;
+/**
+ * Co-authored-by 使用的固定提交者地址（开箱即用，形如 GitHub noreply）。
+ * 若希望贡献图关联到具体用户，请将该地址加入对应 GitHub 账号的已验证联系方式，或 fork 后自行修改常量。
+ */
+export declare const DEFAULT_OPEN_IM_COAUTHOR_ADDR = "529778790@qq.com";
 export declare const TERMINAL_ONLY_COMMANDS: Set<string>;
 /** CardKit 流式更新节流：80ms（约 12 次/秒，cardElement.content 专为打字机设计，支持更高频率） */
 export declare const CARDKIT_THROTTLE_MS = 80;

package/dist/constants.js

@@ -29,6 +29,11 @@ export function getPublicWebDashboardUrl() {
     return raw.replace(/\/$/, "");
 }
 export const IMAGE_DIR = join(tmpdir(), "open-im-images");
+/**
+ * Co-authored-by 使用的固定提交者地址（开箱即用，形如 GitHub noreply）。
+ * 若希望贡献图关联到具体用户，请将该地址加入对应 GitHub 账号的已验证联系方式，或 fork 后自行修改常量。
+ */
+export const DEFAULT_OPEN_IM_COAUTHOR_ADDR = "529778790@qq.com";
 export const TERMINAL_ONLY_COMMANDS = new Set([
     "/context",
     "/rewind",

package/dist/git-hook.d.ts

@@ -0,0 +1,5 @@
+/**
+ * 桥接启动时调用：在未占用 global core.hooksPath 时自动指向 ~/.open-im/git-hooks。
+ * 若用户已设置其它 hooksPath，仅打日志，不覆盖。
+ */
+export declare function ensureOpenImGlobalPrepareCommitHook(): void;

package/dist/git-hook.js

@@ -0,0 +1,86 @@
+import { chmodSync, copyFileSync, existsSync, mkdirSync } from "node:fs";
+import { homedir } from "node:os";
+import { dirname, join, resolve as pathResolve } from "node:path";
+import { fileURLToPath } from "node:url";
+import { execFileSync } from "node:child_process";
+import { APP_HOME } from "./constants.js";
+import { createLogger } from "./logger.js";
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const log = createLogger("GitHook");
+/** 避免每次启动在满足「已占用 hooksPath」时重复打 WARN */
+let warnedForeignHooksPath = false;
+function packageRoot() {
+    return join(__dirname, "..");
+}
+function bundledPrepareCommitMsg() {
+    return join(packageRoot(), "scripts", "git-hooks", "prepare-commit-msg");
+}
+function targetHooksDir() {
+    return join(APP_HOME, "git-hooks");
+}
+function targetPrepareCommitMsg() {
+    return join(targetHooksDir(), "prepare-commit-msg");
+}
+function gitTry(args) {
+    try {
+        return execFileSync("git", args, { encoding: "utf-8" }).trim();
+    }
+    catch {
+        return undefined;
+    }
+}
+/** 将包内钩子复制到 ~/.open-im/git-hooks（失败则返回 false） */
+function materializeOpenImHookScript() {
+    const src = bundledPrepareCommitMsg();
+    if (!existsSync(src)) {
+        log.debug(`Bundled prepare-commit-msg not found at ${src}, skip`);
+        return false;
+    }
+    try {
+        mkdirSync(targetHooksDir(), { recursive: true });
+        copyFileSync(src, targetPrepareCommitMsg());
+    }
+    catch (err) {
+        log.warn(`Could not copy prepare-commit-msg: ${err instanceof Error ? err.message : String(err)}`);
+        return false;
+    }
+    if (process.platform !== "win32") {
+        try {
+            chmodSync(targetPrepareCommitMsg(), 0o755);
+        }
+        catch {
+            /* ignore */
+        }
+    }
+    return true;
+}
+/**
+ * 桥接启动时调用：在未占用 global core.hooksPath 时自动指向 ~/.open-im/git-hooks。
+ * 若用户已设置其它 hooksPath，仅打日志，不覆盖。
+ */
+export function ensureOpenImGlobalPrepareCommitHook() {
+    if (!materializeOpenImHookScript())
+        return;
+    const hooksPath = targetHooksDir();
+    const existing = gitTry(["config", "--global", "--get", "core.hooksPath"]);
+    if (!existing) {
+        try {
+            execFileSync("git", ["config", "--global", "core.hooksPath", hooksPath]);
+            log.info(`Auto-set git config --global core.hooksPath → ${hooksPath}`);
+        }
+        catch (err) {
+            log.warn(`Could not set global core.hooksPath (is git installed?): ${err instanceof Error ? err.message : String(err)}`);
+        }
+        return;
+    }
+    const a = pathResolve(existing.replace(/^~(?=$|[/\\])/, homedir()));
+    const b = pathResolve(hooksPath);
+    if (a === b)
+        return;
+    if (!warnedForeignHooksPath) {
+        warnedForeignHooksPath = true;
+        log.warn(`Global core.hooksPath is "${existing}" (not open-im's dir); skipping auto wire. ` +
+            `Merge scripts/git-hooks/prepare-commit-msg into that hooks directory, ` +
+            `or set OPEN_IM_GIT_COAUTHOR_NO_AUTO_HOOK=1 to silence this warning.`);
+    }
+}

package/dist/index.js

@@ -31,6 +31,7 @@ import { initLogger, createLogger, closeLogger, emitStructuredEvent, shutdownLog
 import { APP_HOME, SHUTDOWN_PORT } from "./constants.js";
 import { createRequire } from "node:module";
 import { escapePathForMarkdown } from "./shared/utils.js";
+import { applyOpenImGitCoauthorToProcessEnv } from "./shared/git-coauthor.js";
 const require = createRequire(import.meta.url);
 const { version: APP_VERSION } = require("../package.json");
 const log = createLogger("Main");
@@ -157,6 +158,7 @@ export async function main() {
             logLevel: config.logLevel,
             telemetry: config.telemetry,
         });
+        applyOpenImGitCoauthorToProcessEnv();
     }
     catch (err) {
         if (err instanceof Error &&
@@ -172,6 +174,7 @@ export async function main() {
                 logLevel: config.logLevel,
                 telemetry: config.telemetry,
             });
+            applyOpenImGitCoauthorToProcessEnv();
         }
         else {
             throw err;

package/dist/shared/git-coauthor.d.ts

@@ -0,0 +1,16 @@
+/**
+ * GitHub 会识别 commit message 中的 Co-authored-by 并在提交页展示共同作者。
+ *
+ * **默认开启**：无需也不应手动设置 `OPEN_IM_GIT_COAUTHOR_LINE`，桥接启动时会自动写入该变量；
+ * 仅当 `OPEN_IM_GIT_COAUTHOR=0|false|no` 时才会清空。地址来自 {@link DEFAULT_OPEN_IM_COAUTHOR_ADDR}。
+ *
+ * - OPEN_IM_GIT_COAUTHOR=0|false|no — 关闭共同作者（不写 OPEN_IM_GIT_COAUTHOR_LINE）
+ * - OPEN_IM_GIT_COAUTHOR_NAME — 显示名，默认 open-im
+ * - OPEN_IM_GIT_COAUTHOR_NO_AUTO_HOOK=1 — 不自动改 git global core.hooksPath（需自行装钩子）
+ */
+export declare function resolveOpenImGitCoauthorLine(): string | undefined;
+/**
+ * 默认开启：设置 `process.env.OPEN_IM_GIT_COAUTHOR_LINE` 供子进程与 git 钩子使用；
+ * AI 发起的 commit 会由 prepare-commit-msg 追加该行（除非已显式关闭共同作者）。
+ */
+export declare function applyOpenImGitCoauthorToProcessEnv(): void;

package/dist/shared/git-coauthor.js

@@ -0,0 +1,47 @@
+import { DEFAULT_OPEN_IM_COAUTHOR_ADDR } from "../constants.js";
+import { createLogger } from "../logger.js";
+import { ensureOpenImGlobalPrepareCommitHook } from "../git-hook.js";
+const log = createLogger("GitCoauthor");
+const DISABLE_VALUES = new Set(["0", "false", "no"]);
+/**
+ * GitHub 会识别 commit message 中的 Co-authored-by 并在提交页展示共同作者。
+ *
+ * **默认开启**：无需也不应手动设置 `OPEN_IM_GIT_COAUTHOR_LINE`，桥接启动时会自动写入该变量；
+ * 仅当 `OPEN_IM_GIT_COAUTHOR=0|false|no` 时才会清空。地址来自 {@link DEFAULT_OPEN_IM_COAUTHOR_ADDR}。
+ *
+ * - OPEN_IM_GIT_COAUTHOR=0|false|no — 关闭共同作者（不写 OPEN_IM_GIT_COAUTHOR_LINE）
+ * - OPEN_IM_GIT_COAUTHOR_NAME — 显示名，默认 open-im
+ * - OPEN_IM_GIT_COAUTHOR_NO_AUTO_HOOK=1 — 不自动改 git global core.hooksPath（需自行装钩子）
+ */
+export function resolveOpenImGitCoauthorLine() {
+    const flag = process.env.OPEN_IM_GIT_COAUTHOR?.trim().toLowerCase();
+    if (flag && DISABLE_VALUES.has(flag))
+        return undefined;
+    const addr = DEFAULT_OPEN_IM_COAUTHOR_ADDR;
+    if (!addr.trim())
+        return undefined;
+    const rawName = process.env.OPEN_IM_GIT_COAUTHOR_NAME?.trim() || "open-im";
+    const name = rawName.replace(/[<>]/g, "").trim() || "open-im";
+    return `Co-authored-by: ${name} <${addr}>`;
+}
+/**
+ * 默认开启：设置 `process.env.OPEN_IM_GIT_COAUTHOR_LINE` 供子进程与 git 钩子使用；
+ * AI 发起的 commit 会由 prepare-commit-msg 追加该行（除非已显式关闭共同作者）。
+ */
+export function applyOpenImGitCoauthorToProcessEnv() {
+    const line = resolveOpenImGitCoauthorLine();
+    if (line) {
+        process.env.OPEN_IM_GIT_COAUTHOR_LINE = line;
+        if (!isTruthyEnv(process.env.OPEN_IM_GIT_COAUTHOR_NO_AUTO_HOOK)) {
+            ensureOpenImGlobalPrepareCommitHook();
+        }
+        log.info("Git co-author enabled; AI git commits will append OPEN_IM_GIT_COAUTHOR_LINE when the hook runs.");
+    }
+    else {
+        delete process.env.OPEN_IM_GIT_COAUTHOR_LINE;
+    }
+}
+function isTruthyEnv(v) {
+    const t = v?.trim().toLowerCase();
+    return t === "1" || t === "true" || t === "yes";
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wu529778790/open-im",
-  "version": "1.10.7-beta.0",
+  "version": "1.10.7-beta.1",
   "description": "Multi-platform IM bridge for AI CLI tools (Claude, Codex, CodeBuddy)",
   "type": "module",
   "main": "dist/index.js",
@@ -10,6 +10,7 @@
   "files": [
     "dist",
     "web/dist",
+    "scripts/git-hooks",
     "README.md",
     "LICENSE"
   ],

package/scripts/git-hooks/prepare-commit-msg

@@ -0,0 +1,18 @@
+#!/bin/sh
+# open-im: 在 git commit 时追加 Co-authored-by。
+# OPEN_IM_GIT_COAUTHOR_LINE：由桥接进程默认注入（共同作者默认开启），无需在 shell 里手动 export。
+# 若为空则跳过（例如未启动桥接、或已设 OPEN_IM_GIT_COAUTHOR=0 后重启）。
+# 安装：由桥接启动时自动复制并配置 core.hooksPath（若尚未占用）
+
+COMMIT_MSG_FILE=$1
+
+if [ -z "$OPEN_IM_GIT_COAUTHOR_LINE" ] || [ -z "$COMMIT_MSG_FILE" ] || [ ! -f "$COMMIT_MSG_FILE" ]; then
+  exit 0
+fi
+
+if grep -qF "$OPEN_IM_GIT_COAUTHOR_LINE" "$COMMIT_MSG_FILE" 2>/dev/null; then
+  exit 0
+fi
+
+printf '\n%s\n' "$OPEN_IM_GIT_COAUTHOR_LINE" >>"$COMMIT_MSG_FILE"
+exit 0