@zhin.js/adapter-github 1.1.15 → 1.1.17

package/schema.json

@@ -31,7 +31,12 @@
         "string",
         "number"
       ],
-      "description": "框架 master（GitHub user login or id；AI/工具权限、endpoint 管理）。endpoints[i].master 可逐项覆盖"
+      "description": "框架 master（GitHub user login or id；AI/工具权限、endpoint 管理）。endpoints[i].master 可逐项覆盖",
+      "x-i18n": {
+        "en": {
+          "description": "Framework masters (GitHub user login or id; AI/tool permissions and endpoint management). endpoints[i].master can override this value."
+        }
+      }
     },
     "trusted": {
       "type": "array",
@@ -42,7 +47,12 @@
         ],
         "description": "Trusted GitHub user login or id"
       },
-      "description": "框架 trusted 用户列表（弱于 master）。endpoints[i].trusted 可逐项追加"
+      "description": "框架 trusted 用户列表（弱于 master）。endpoints[i].trusted 可逐项追加",
+      "x-i18n": {
+        "en": {
+          "description": "Framework trusted users, below master authority. endpoints[i].trusted can add users."
+        }
+      }
     },
     "endpoints": {
       "type": "array",
@@ -57,7 +67,12 @@
               "string",
               "number"
             ],
-            "description": "本 endpoint 的框架 master（GitHub user login or id）；覆盖顶层 master"
+            "description": "本 endpoint 的框架 master（GitHub user login or id）；覆盖顶层 master",
+            "x-i18n": {
+              "en": {
+                "description": "Framework masters for this endpoint (GitHub user login or id), overriding the top-level master list."
+              }
+            }
           },
           "trusted": {
             "type": "array",
@@ -68,7 +83,12 @@
               ],
               "description": "Trusted GitHub user login or id"
             },
-            "description": "本 endpoint 的 trusted 列表"
+            "description": "本 endpoint 的 trusted 列表",
+            "x-i18n": {
+              "en": {
+                "description": "Trusted users for this endpoint."
+              }
+            }
           },
           "app_id": {
             "type": [
@@ -115,7 +135,12 @@
           },
           "commandPrefix": {
             "type": "string",
-            "description": "本 endpoint 的命令前缀"
+            "description": "本 endpoint 的命令前缀",
+            "x-i18n": {
+              "en": {
+                "description": "Command prefix for this endpoint."
+              }
+            }
           }
         },
         "required": [
@@ -123,12 +148,22 @@
           "app_id",
           "private_key"
         ]
+      },
+      "x-i18n": {
+        "en": {
+          "description": "Multiple accounts: mount multiple endpoints in one plugin instance."
+        }
       }
     },
     "commandPrefix": {
       "type": "string",
       "default": "",
-      "description": "命令前缀（默认 '' 无前缀，任意文本按命令匹配；如 '/' 要求 / 开头）。endpoints[i] 可逐项覆盖"
+      "description": "命令前缀（默认 '' 无前缀，任意文本按命令匹配；如 '/' 要求 / 开头）。endpoints[i] 可逐项覆盖",
+      "x-i18n": {
+        "en": {
+          "description": "Command prefix. The default empty string allows unprefixed commands; '/' requires a leading slash. Each endpoints[i] can override it."
+        }
+      }
     }
   },
   "required": [

package/src/github-channel-context.ts

@@ -2,6 +2,7 @@
  * Parse GitHub Issue/PR channel context from IM messages.
  */
 import type { Message } from 'zhin.js';
+import { createMessages, type Locale } from 'zhin.js/i18n';
 import { buildChannelId, parseChannelId, type ParsedChannel } from './types.js';
 import type { GhClient } from './gh-client.js';
 
@@ -24,6 +25,7 @@ export function issueBranchName(number: number): string {
 export async function resolveWorkspaceBranch(
   gh: GhClient,
   ctx: GitHubChannelContext,
+  locale?: Locale,
 ): Promise<{ branch: string; base: string }> {
   if (ctx.type === 'pr') {
     const pr = await gh.getPR(ctx.repo, ctx.number);
@@ -31,7 +33,7 @@ export async function resolveWorkspaceBranch(
       const base = pr.data.base?.ref ?? 'main';
       return { branch: pr.data.head.ref, base };
     }
-    throw new Error(`无法读取 PR #${ctx.number} 的 head 分支`);
+    throw new Error(t(locale, 'missingHead', { number: ctx.number }));
   }
 
   const repoInfo = await gh.getRepo(ctx.repo);
@@ -44,3 +46,7 @@ export async function resolveWorkspaceBranch(
 export function formatChannelContext(ctx: GitHubChannelContext): string {
   return buildChannelId(ctx.repo, ctx.type, ctx.number);
 }
+
+const t = createMessages({
+  missingHead: { 'zh-CN': '无法读取 PR #{number} 的 head 分支', en: 'Cannot read the head branch of PR #{number}' },
+});

package/src/workspace-manager.ts

@@ -4,6 +4,7 @@
 import { spawn } from 'node:child_process';
 import fs from 'node:fs';
 import path from 'node:path';
+import { createMessages, type Locale } from 'zhin.js/i18n';
 import type { GhClient, GitHubBotIdentity } from './gh-client.js';
 
 const REPO_FULL_NAME_RE = /^[A-Za-z0-9_.-]+\/[A-Za-z0-9_.-]+$/;
@@ -23,13 +24,13 @@ function containsIllegalGitRefCharacter(ref: string): boolean {
  * 校验 GitHub "owner/name" 全名，防止路径穿越与 git 选项注入。
  * 返回通过校验的原值，便于调用方直接使用「已消毒」的变量。
  */
-export function assertRepoFullName(repo: string): string {
+export function assertRepoFullName(repo: string, locale?: Locale): string {
   if (
     typeof repo !== 'string' ||
     !REPO_FULL_NAME_RE.test(repo) ||
     repo.split('/').some((seg) => seg === '' || seg.startsWith('-') || /^\.+$/.test(seg))
   ) {
-    throw new TypeError(`非法的仓库全名: ${JSON.stringify(repo)}`);
+    throw new TypeError(t(locale, 'invalidRepo', { value: JSON.stringify(repo) }));
   }
   return repo;
 }
@@ -37,9 +38,9 @@ export function assertRepoFullName(repo: string): string {
 /**
  * 校验 git ref 名称，拒绝选项注入（`-` 前缀）与 git 非法字符。
  */
-export function assertGitRefName(ref: string): string {
+export function assertGitRefName(ref: string, locale?: Locale): string {
   if (typeof ref !== 'string' || ref.length === 0) {
-    throw new TypeError(`非法的 git ref: ${JSON.stringify(ref)}`);
+    throw new TypeError(t(locale, 'invalidRef', { value: JSON.stringify(ref) }));
   }
   if (
     ref.startsWith('-') ||
@@ -48,7 +49,7 @@ export function assertGitRefName(ref: string): string {
     ref.endsWith('/') ||
     ref.endsWith('.')
   ) {
-    throw new TypeError(`非法的 git ref: ${JSON.stringify(ref)}`);
+    throw new TypeError(t(locale, 'invalidRef', { value: JSON.stringify(ref) }));
   }
   return ref;
 }
@@ -59,13 +60,13 @@ export class WorkspaceManager {
     private readonly rootDir: string,
   ) {}
 
-  getRepoPath(repo: string): string {
-    repo = assertRepoFullName(repo);
+  getRepoPath(repo: string, locale?: Locale): string {
+    repo = assertRepoFullName(repo, locale);
     const [owner, name] = repo.split('/');
     return path.join(this.rootDir, owner, name);
   }
 
-  private runGit(cwd: string, args: string[], env?: NodeJS.ProcessEnv): Promise<string> {
+  private runGit(cwd: string, args: string[], env?: NodeJS.ProcessEnv, locale?: Locale): Promise<string> {
     return new Promise((resolve, reject) => {
       const proc = spawn('git', args, {
         cwd,
@@ -77,7 +78,7 @@ export class WorkspaceManager {
       proc.stdout.on('data', (d: Buffer) => { stdout += d.toString(); });
       proc.stderr.on('data', (d: Buffer) => { stderr += d.toString(); });
       proc.on('error', (err: NodeJS.ErrnoException) => {
-        if (err.code === 'ENOENT') reject(new Error('git 未安装'));
+        if (err.code === 'ENOENT') reject(new Error(t(locale, 'missingGit')));
         else reject(err);
       });
       proc.on('close', (code) => {
@@ -87,82 +88,93 @@ export class WorkspaceManager {
     });
   }
 
-  configureBotGit(repoPath: string, identity: GitHubBotIdentity): Promise<void> {
-    return Promise.all([
-      this.runGit(repoPath, ['config', 'user.name', identity.login]),
-      this.runGit(repoPath, ['config', 'user.email', identity.email]),
-    ]).then(() => undefined);
+  async configureBotGit(repoPath: string, identity: GitHubBotIdentity, locale?: Locale): Promise<void> {
+    // Both writes acquire the same .git/config.lock.
+    await this.runGit(repoPath, ['config', 'user.name', identity.login], undefined, locale);
+    await this.runGit(repoPath, ['config', 'user.email', identity.email], undefined, locale);
   }
 
-  async ensureRepo(repo: string): Promise<string> {
-    repo = assertRepoFullName(repo);
+  async ensureRepo(repo: string, locale?: Locale): Promise<string> {
+    repo = assertRepoFullName(repo, locale);
     if (!this.gh.isAppAuth) {
-      throw new Error('GitHub App 认证未配置，无法托管工作区');
+      throw new Error(t(locale, 'appRequired'));
     }
     const token = await this.gh.ensureInstallationTokenForRepo(repo);
-    if (!token) throw new Error(`无法获取 ${repo} 的 Installation Token`);
+    if (!token) throw new Error(t(locale, 'repoTokenUnavailable', { repo }));
 
-    const repoPath = this.getRepoPath(repo);
+    const repoPath = this.getRepoPath(repo, locale);
     fs.mkdirSync(path.dirname(repoPath), { recursive: true });
 
     const identity = await this.gh.getBotIdentity();
-    if (!identity) throw new Error('无法解析 GitHub App Bot 身份');
+    if (!identity) throw new Error(t(locale, 'missingIdentity'));
 
     const cloneUrl = this.gh.buildCloneUrl(repo, token);
     if (!fs.existsSync(path.join(repoPath, '.git'))) {
-      await this.runGit(path.dirname(repoPath), ['clone', cloneUrl, path.basename(repoPath)]);
+      await this.runGit(path.dirname(repoPath), ['clone', '--', cloneUrl, path.basename(repoPath)], undefined, locale);
     } else {
-      await this.runGit(repoPath, ['remote', 'set-url', 'origin', cloneUrl]);
-      await this.runGit(repoPath, ['fetch', 'origin', '--prune']);
+      await this.runGit(repoPath, ['remote', 'set-url', 'origin', cloneUrl], undefined, locale);
+      await this.runGit(repoPath, ['fetch', 'origin', '--prune'], undefined, locale);
     }
 
-    await this.configureBotGit(repoPath, identity);
+    await this.configureBotGit(repoPath, identity, locale);
     return repoPath;
   }
 
-  async checkoutBranch(repo: string, branch: string, baseRef: string): Promise<string> {
-    repo = assertRepoFullName(repo);
-    branch = assertGitRefName(branch);
-    baseRef = assertGitRefName(baseRef);
-    const repoPath = await this.ensureRepo(repo);
-    const localBranches = await this.runGit(repoPath, ['branch', '--list', branch]);
+  async checkoutBranch(repo: string, branch: string, baseRef: string, locale?: Locale): Promise<string> {
+    repo = assertRepoFullName(repo, locale);
+    branch = assertGitRefName(branch, locale);
+    baseRef = assertGitRefName(baseRef, locale);
+    const repoPath = await this.ensureRepo(repo, locale);
+    const localBranches = await this.runGit(repoPath, ['branch', '--list', branch], undefined, locale);
     if (localBranches.trim()) {
-      await this.runGit(repoPath, ['checkout', branch]);
-      await this.runGit(repoPath, ['pull', '--rebase', 'origin', branch]).catch(async () => {
-        await this.runGit(repoPath, ['fetch', 'origin', branch]);
+      await this.runGit(repoPath, ['checkout', branch], undefined, locale);
+      await this.runGit(repoPath, ['pull', '--rebase', '--', 'origin', branch], undefined, locale).catch(async () => {
+        await this.runGit(repoPath, ['fetch', '--', 'origin', branch], undefined, locale);
       });
       return repoPath;
     }
 
-    const remoteBranch = await this.runGit(repoPath, ['ls-remote', '--heads', 'origin', branch]);
+    const remoteBranch = await this.runGit(repoPath, ['ls-remote', '--heads', '--', 'origin', branch], undefined, locale);
     if (remoteBranch.trim()) {
-      await this.runGit(repoPath, ['checkout', '-B', branch, `origin/${branch}`]);
+      await this.runGit(repoPath, ['checkout', '-B', branch, `origin/${branch}`], undefined, locale);
       return repoPath;
     }
 
-    await this.runGit(repoPath, ['fetch', 'origin', baseRef]);
-    await this.runGit(repoPath, ['checkout', '-B', branch, `origin/${baseRef}`]);
+    await this.runGit(repoPath, ['fetch', '--', 'origin', baseRef], undefined, locale);
+    await this.runGit(repoPath, ['checkout', '-B', branch, `origin/${baseRef}`], undefined, locale);
     return repoPath;
   }
 
-  async commitAndPush(repo: string, branch: string, message: string): Promise<string> {
-    repo = assertRepoFullName(repo);
-    branch = assertGitRefName(branch);
-    const repoPath = this.getRepoPath(repo);
+  async commitAndPush(repo: string, branch: string, message: string, locale?: Locale): Promise<string> {
+    repo = assertRepoFullName(repo, locale);
+    branch = assertGitRefName(branch, locale);
+    const repoPath = this.getRepoPath(repo, locale);
     if (!fs.existsSync(repoPath)) {
-      throw new Error(`工作区不存在: ${repoPath}，请先 github_prepare_workspace`);
+      throw new Error(t(locale, 'missingWorkspace', { path: repoPath }));
     }
 
     const token = await this.gh.ensureInstallationTokenForRepo(repo);
-    if (!token) throw new Error('Installation Token 不可用');
-    await this.runGit(repoPath, ['remote', 'set-url', 'origin', this.gh.buildCloneUrl(repo, token)]);
+    if (!token) throw new Error(t(locale, 'missingToken'));
+    await this.runGit(repoPath, ['remote', 'set-url', 'origin', this.gh.buildCloneUrl(repo, token)], undefined, locale);
 
-    const status = await this.runGit(repoPath, ['status', '--porcelain']);
-    if (!status.trim()) return '没有可提交的变更';
+    const status = await this.runGit(repoPath, ['status', '--porcelain'], undefined, locale);
+    if (!status.trim()) return t(locale, 'noChanges');
 
-    await this.runGit(repoPath, ['add', '-A']);
-    await this.runGit(repoPath, ['commit', '-m', message]);
-    await this.runGit(repoPath, ['push', '-u', 'origin', branch]);
-    return `已 push 到 origin/${branch}`;
+    await this.runGit(repoPath, ['add', '-A'], undefined, locale);
+    await this.runGit(repoPath, ['commit', '-m', message], undefined, locale);
+    await this.runGit(repoPath, ['push', '-u', 'origin', branch], undefined, locale);
+    return t(locale, 'pushed', { branch });
   }
 }
+const t = createMessages({
+  invalidRepo: { 'zh-CN': '非法的仓库全名: {value}', en: 'Invalid repository name: {value}' },
+  invalidRef: { 'zh-CN': '非法的 git ref: {value}', en: 'Invalid git ref: {value}' },
+  missingGit: { 'zh-CN': 'git 未安装', en: 'git is not installed' },
+  appRequired: { 'zh-CN': 'GitHub App 认证未配置，无法托管工作区', en: 'GitHub App authentication is not configured; the workspace is unavailable' },
+  repoTokenUnavailable: { 'zh-CN': '无法获取 {repo} 的 Installation Token', en: 'Cannot obtain an Installation Token for {repo}' },
+  missingIdentity: { 'zh-CN': '无法解析 GitHub App Bot 身份', en: 'Cannot resolve the GitHub App bot identity' },
+  missingWorkspace: { 'zh-CN': '工作区不存在: {path}，请先准备工作区', en: 'Workspace does not exist: {path}. Prepare the workspace first' },
+  missingToken: { 'zh-CN': 'Installation Token 不可用', en: 'Installation Token is unavailable' },
+  noChanges: { 'zh-CN': '没有可提交的变更', en: 'No changes to commit' },
+  pushed: { 'zh-CN': '已 push 到 origin/{branch}', en: 'Pushed to origin/{branch}' },
+});