dsh-github-flow 0.4.0 → 0.6.0

package/lib/executor/git-parser.d.ts

@@ -9,7 +9,7 @@ import type { GitLocalStatus, GitCommitEntry, GitBranchesResult } from '../types
  *   `## master` / `## HEAD (no branch)`               无 upstream（ahead/behind 未知=-1）
  * 后续每行 `<XY> <path>` 为 porcelain 变更项（XY 两字符状态码，?? = untracked）。
  */
-export declare function parseGitStatusOutput(output: string): GitLocalStatus | null;
+export declare function parseGitStatusOutput(output: string, maxFiles?: number): GitLocalStatus | null;
 /**
  * 解析 `git log` 输出为提交条目数组。
  * 支持两种形态：
@@ -23,3 +23,159 @@ export declare function parseGitLogLines(output: string): GitCommitEntry[];
  * 格式为: %(refname:short)|%(HEAD)|%(upstream:short)|%(committerdate:relative)|%(objectname:short)|%(subject)
  */
 export declare function parseGitBranchLines(output: string): GitBranchesResult;
+/**
+ * 解析 unified diff 输出，统计增删行数与区块数量。
+ * 忽略 diff 文件头（--- 和 +++），仅统计真正的改动行（+ 与 -）。
+ */
+export declare function parseUncommittedDiff(rawDiff: string): {
+    additions: number;
+    deletions: number;
+    hunksCount: number;
+};
+export interface GitStatFileInfo {
+    path: string;
+    total: number;
+    additions: number;
+    deletions: number;
+    isBinary: boolean;
+    rawRight?: string;
+}
+export interface GitStatSummary {
+    filesChanged: number;
+    insertions: number;
+    deletions: number;
+}
+export interface GitStatParsedResult {
+    files: GitStatFileInfo[];
+    summary: GitStatSummary | null;
+}
+/**
+ * 解析 `git show --stat` 或 `git log --stat` 的统计文本为结构化列表与增删数字。
+ * 能够从 `19 ++++++++++++++++++-` 精准推导 additions=18, deletions=1，
+ * 提取文件路径与 `X files changed, Y insertions(+), Z deletions(-)` 汇总。
+ */
+export declare function parseGitStatText(statText: string): GitStatParsedResult | null;
+/**
+ * 提取 `.git/config` 中所有 `[remote "..."]` 段内的 url。
+ *
+ * 为什么必须按段扫描而不是全文抓 `url = `：`[submodule "..."]` 段同样带 url
+ * （实测 `[submodule "lib"] url = https://github.com/x/y.git`）。全文正则会把
+ * 子模块的远程算进指纹，导致一次 `git submodule add` 就触发整个面板缓存的
+ * 无谓作废。子模块的 url 与本工作区关联哪个 GitHub 仓库毫无关系。
+ *
+ * 输出语义：保持文件中的出现顺序、已去重、不含空值。
+ * 排序交给调用方（指纹需要稳定顺序，但那是调用方的语义，纯函数不该替它决定）。
+ */
+export declare function parseRemoteUrls(configText: string): string[];
+/** 单个 remote 段的解析结果 */
+export interface ParsedRemote {
+    name: string;
+    url: string;
+}
+/** `.git/config` + `HEAD` 的解析结果，是「这个工作区关联哪个仓库」的唯一事实源 */
+export interface ParsedGitConfig {
+    /** 每个 remote 名对应的第一个 url（身份解析用；同名多 url 时取首个） */
+    remotes: ParsedRemote[];
+    /**
+     * 全部 remote url 行（指纹用）。
+     *
+     * 为什么与 remotes 分开：身份解析需要「remote 名 → url」的一对一映射，
+     * 而指纹需要「配置里出现过的所有 url」。同一个 remote 允许写多行 url
+     * （git 认首个，但配置确实是多行），若指纹也按名字去重，第二行 url 的
+     * 变化就检测不到——那会让「用户改了备用 url」这种情况静默漏检。
+     */
+    allUrls: string[];
+    /** 当前分支名（来自 HEAD 的 `ref: refs/heads/<name>`）；detached HEAD 时为 null */
+    currentBranch: string | null;
+    /** `branch.<currentBranch>.remote` 的值；无配置或无当前分支时为 null */
+    branchRemote: string | null;
+}
+/**
+ * 解析 `.git/config` 与 `HEAD`，产出与 git 语义一致的远程视图。
+ *
+ * 为什么把 HEAD 一起解析：`branch.<name>.remote` 的 `<name>` 是**当前分支**，
+ * 不知道当前分支就无法按 git 的规则选出 remote，只能退化成「取第一个」——
+ * 那正是本次要修的错误。
+ *
+ * @param configText `.git/config` 全文
+ * @param headText   HEAD 文件全文。worktree 场景必须传**局部 gitdir** 下的那个，
+ *                   传共享目录的会拿到主工作树分支名（实测两者不同）。
+ */
+export declare function parseGitConfig(configText: string, headText?: string | null): ParsedGitConfig;
+/**
+ * 按 git 的规则选出「这个工作区关联的 remote」。
+ *
+ * 优先级与 git 一致：
+ *   1. `branch.<当前分支>.remote` —— 当前分支显式跟踪的 remote
+ *   2. `origin`                  —— git 的默认远程
+ *   3. 第一个 remote              —— 兜底（保持既有行为）
+ *
+ * 特殊值 `.` 表示跟踪**本地分支**而非远程（实测可设置），跳过第 1 级——
+ * 拿 "." 去查 `[remote "."]` 必然查不到，且语义上它根本不是远程。
+ */
+export declare function resolveRemoteTarget(cfg: ParsedGitConfig): ParsedRemote | null;
+/**
+ * 从 remote url 中提取 GitHub 的 owner/repo。
+ *
+ * 覆盖形态（均实测于真实 clone / hand-written config）：
+ *   https://github.com/o/r.git
+ *   git@github.com:o/r.git
+ *   ssh://git@github.com/o/r.git
+ *   https://user:token@github.com/o/r.git
+ *   带尾斜杠 / 不带 .git
+ *
+ * 非 github.com 的 host 一律返回 null（GHE 不在支持范围）。
+ * 为什么绝不"猜一个"：错误身份比没有身份更有害——面板会显示一个
+ * 用户根本不认识的仓库，且所有后续判断都建立在错误前提上。
+ * 正则两端锚定，杜绝 `github.com.evil.com` 这类子串误匹配。
+ */
+export declare function parseGithubUrl(url: string): {
+    owner: string;
+    repo: string;
+} | null;
+/**
+ * 从 remote url 中提取 host（小写）。
+ *
+ * 覆盖：https://host/o/r、git@host:o/r、ssh://git@host:2222/o/r、带 token 的 https。
+ * 无法解析返回 null。
+ *
+ * 为什么不直接复用 parseGithubUrl：本函数要处理**任意 host**（GHE / GitLab），
+ * 用于判断「这个 remote 是不是 GitHub」，而不是「这个 remote 属于哪个 GitHub 仓库」。
+ */
+export declare function parseRemoteHost(url: string): string | null;
+/**
+ * 判断工作区处于哪种远程布局。
+ *
+ * 为什么需要分类而不是顺序盲扫：S2 的兜底逻辑按 `.git/config` 的书写顺序
+ * 挑第一个能解析出 GitHub 身份的 remote，而用户执行 `git remote rename` /
+ * `git remote add` 的先后会改变这个顺序——同一个工作区在两次配置操作后
+ * 可能解析出不同仓库。分类后每种布局的处置规则固定，与顺序无关。
+ *
+ * 分类只看 host 与 git 选中的 remote，不看 URL 的仓库名——后者是身份层的事。
+ */
+export declare function classifyRepoLayout(cfg: ParsedGitConfig): 'github-only' | 'github-mixed' | 'no-github' | 'no-remote';
+/**
+ * 在混合布局中确定性地选出一个 GitHub remote。
+ *
+ * 规则（与书写顺序无关）：
+ *   1. 名字为 `origin` 的优先
+ *   2. 否则按 remote 名字字典序最小的
+ *
+ * 为什么用字典序而不是「第一个出现的」：后者让同一个工作区的解析结果
+ * 依赖用户执行 git remote 命令的先后，属于不可复现的行为。
+ * 字典序是可复现、可断言的确定性规则。
+ */
+export declare function pickGithubRemote(cfg: ParsedGitConfig): ParsedRemote | null;
+/**
+ * 将整段 Git Unified Diff 纯文本按变动文件切分为字典映射。
+ *
+ * 为什么需要按文件切片：PR 可能会修改数十个文件，前端需要支持「点击某个文件即刻查看该文件改动」。
+ * 在内存做切片索引后，切换文件无需发起网络请求（0ms 响应），体验极致流畅。
+ *
+ * 键必须与 `gh pr view --json files` 返回的 `files[].path` **逐字一致**，
+ * 否则点击文件查不到 diff。因此需要处理 core.quotePath 的八进制转义。
+ *
+ * @param rawDiff gh pr diff 或 git diff 输出的原始文本
+ * @returns 映射字典：{ [filePath: string]: string (该文件的完整 diff 文本段) }
+ */
+export declare function splitUnifiedDiff(rawDiff: string): Record<string, string>;