pi-zh-cn 0.1.1 → 0.2.1

package/README.md

@@ -1,58 +1,50 @@
 # pi-zh-cn
 
-pi（[@earendil-works/pi-coding-agent](https://github.com/earendil-works/pi)）简体中文 TUI 界面汉化插件。
-纯扩展 API 实现，不 patch 源码、不侵入安装；正常情况下可随 pi 升级保持兼容。
+把 [pi](https://github.com/earendil-works/pi) 编码代理的界面变成简体中文。装上重启即可，不想要了随时卸载。
 
-## 汉化范围
+原理上它只是一个普通扩展：调用官方扩展 API 替换文案，不打补丁、不改安装目录里的任何文件，所以 pi 正常升级后一般也能直接用。
 
-| 界面元素                                    | 方式                                                                                                   |
-| ------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
-| 启动 header（标题 + 快捷键提示行 + 引导语） | `ctx.ui.setHeader()`，快捷键跟随用户键位配置                                                           |
-| 流式加载提示（默认 "Working..."）           | `ctx.ui.setWorkingMessage()` → 「正在处理…」                                                           |
-| thinking 折叠块标签                         | `ctx.ui.setHiddenThinkingLabel()` → 「思考过程已折叠」                                                 |
-| 底部状态栏                                  | `ctx.ui.setFooter()` 中文重建：目录/分支/会话名、token/缓存/费用/上下文用量、模型/思考等级、扩展状态行 |
-| read 工具渲染                               | 同名重注册，标签「读取」+ 中文状态文案                                                                 |
-| bash 工具渲染                               | 同名重注册，标签「执行」+「完成 / 退出码 N / 输出过长已截断」                                          |
-| edit 工具渲染                               | 同名重注册，标签「编辑」+「已修改 / +N / -N」                                                          |
-| write 工具渲染                              | 同名重注册，标签「写入」+「已写入」                                                                    |
-| grep 工具渲染                               | 同名重注册，标签「搜索内容」+ 中文搜索结果状态                                                         |
-| find 工具渲染                               | 同名重注册，标签「查找文件」+ 中文查找结果状态                                                         |
-| ls 工具渲染                                 | 同名重注册，标签「列出目录」+ 中文目录状态                                                             |
-| PowerShell 工具渲染                         | 同名重注册，标签「执行 PowerShell」+ 中文执行状态                                                      |
+## 会变成中文的部分
 
-**明确不改**：工具 description（发给模型的内容保持英文，避免影响模型行为）、
-内置菜单及其他核心 chrome（扩展 API 覆盖不到，见下方“已知边界”）。
+- 启动画面：标题、快捷键提示、引导语（快捷键显示跟随你自己的键位配置）
+- 底部状态栏：当前目录 / 分支 / 会话名、token 与缓存用量、费用、上下文占比、模型和思考等级
+- 加载提示：「正在处理…」；thinking 折叠块的标签
+- 八个内置工具的执行结果：读取、执行（bash）、编辑、写入、搜索内容、查找文件、列出目录、PowerShell——状态行都是中文，比如「完成」「退出码 N」「输出过长已截断」
+- 项目信任弹窗：信任/不信任选择，含「信任父文件夹」变体
 
-运行时可用 `/footer` 在中文 footer 和 built-in footer 之间切换，方便核对统计数据。
+发给模型的内容不变。工具的 description 保持英文原文，避免影响模型行为。
 
-插件只替换 pi 已提供工具的渲染，不改变原有 active 工具集合；`grep`、`find`、`ls` 或 `powershell` 未启用时，不会因安装本插件而自动启用。
+## 保持原样的部分
 
-## 安装
+- 内置菜单和其他硬编码在 pi 源码里的英文（扩展 API 够不到，除非 fork 上游重编译，不值得）
+- 工具的启用范围：`grep`、`find`、`ls` 或 `powershell` 没开就不会被这个插件偷偷打开
 
-```bash
-# 本地路径安装（路径引用，不复制文件）
-pi install /path/to/pi-zh
+## 使用
 
-# 或发布 npm 后
+```bash
+# 从 npm 安装
 pi install npm:pi-zh-cn
 
-# 查看已安装包（remove 时使用这里显示的 source）
+# 查看/卸载用这里显示的 source 名
 pi list
 ```
 
-## 已知边界
+觉得中文状态栏不如原生好读，可以临时切回英文：
 
-- pi 无内置 i18n，内置菜单、`esc to …` 提示行等硬编码英文文案无法通过扩展 API 修改。
-  若需彻底汉化，需要 fork 上游或 patch `dist/bundle`（维护成本高，本插件不做）。
+```text
+/footer
+```
 
 ## 开发
 
 ```bash
-npm install          # 安装 devDependencies（含 peer 自动安装）
+npm install
 ./node_modules/.bin/tsc -p .   # 类型检查
 
 # 本地试跑
 pi --no-session -e ./extensions/index.ts -p "hi"
 ```
 
-文案集中在 [`extensions/i18n.ts`](extensions/i18n.ts)，改词只需动这一个文件。
+所有文案都集中在 [`extensions/zh.ts`](extensions/zh.ts)，想改词只动这一个文件就够了。
+
+改动记录见 [CHANGELOG.md](CHANGELOG.md)。pi 大版本升级后如果出现错位或残留英文，欢迎提 issue。

package/extensions/footer.ts

@@ -0,0 +1,309 @@
+/**
+ * 中文 footer：逐行复刻内置信息（pwd 行 / 统计行 / 扩展状态行），仅描述文案用中文。
+ */
+import { readFileSync } from "node:fs";
+import { homedir } from "node:os";
+import { join, relative } from "node:path";
+import type { AssistantMessage } from "@earendil-works/pi-ai";
+import {
+  CONFIG_DIR_NAME,
+  getAgentDir,
+  type ExtensionContext,
+} from "@earendil-works/pi-coding-agent";
+import { truncateToWidth, visibleWidth } from "@earendil-works/pi-tui";
+import { zh } from "./zh.ts";
+
+/**
+ * 安装中文 footer（仅 TUI 模式，其他模式返回 undefined）。
+ *
+ * footer 逐行复刻内置信息结构：
+ * 1. pwd 行 —— 当前目录（~ 缩写）+ git 分支 + 会话名；
+ * 2. 统计行 —— 左侧为输入/输出 token、缓存读写与命中率、费用、上下文
+ *    占比（按阈值变色），右侧为 provider • 模型 • 思考等级（放不下时省略）；
+ * 3. 扩展状态行 —— 各扩展 `setStatus` 的文本。
+ * 仅描述文案用中文，数据格式与 built-in 一致。
+ *
+ * @param ctx 当前会话上下文
+ * @returns 切换函数：第一次调用恢复内置 footer，再调用切回中文 footer；
+ *          非 TUI 模式下为 undefined
+ */
+export function setupChineseFooter(ctx: ExtensionContext): (() => void) | undefined {
+  if (ctx.mode !== "tui") return undefined;
+
+  let usingZhFooter = true;
+
+  const applyZhFooter = () => {
+    usingZhFooter = true;
+    // 自动压缩标记：全局设置为基准，受信任项目的本地设置优先。
+    // 一秒缓存避免流式渲染时频繁读文件，同时能跟随 /settings 的运行时修改。
+    const settingsPaths = [join(getAgentDir(), "settings.json")];
+    if (ctx.isProjectTrusted())
+      settingsPaths.push(join(ctx.cwd, CONFIG_DIR_NAME, "settings.json"));
+    let autoCompactEnabled = true;
+    let autoCompactCheckedAt = 0;
+    /**
+     * 返回自动压缩标记文案。设置读取带 1 秒缓存：避免流式渲染时每次
+     * 重绘都读文件，同时仍能跟随 /settings 的运行时修改。全局设置为基准，
+     * 受信任项目的本地设置优先覆盖。
+     */
+    const getAutoCompactSuffix = () => {
+      const now = Date.now();
+      if (now - autoCompactCheckedAt >= 1000) {
+        autoCompactEnabled = true;
+        for (const settingsPath of settingsPaths) {
+          try {
+            const settings = JSON.parse(readFileSync(settingsPath, "utf8"));
+            if (typeof settings?.compaction?.enabled === "boolean") {
+              autoCompactEnabled = settings.compaction.enabled;
+            }
+          } catch {
+            // 设置文件不存在或内容无效时忽略该层。
+          }
+        }
+        autoCompactCheckedAt = now;
+      }
+      return autoCompactEnabled ? zh.footer.autoCompactSuffix : "";
+    };
+
+    let unsubscribeBranch: (() => void) | undefined;
+
+    // footer 渲染器：onBranchChange 触发重绘；dispose 时取消订阅。
+    ctx.ui.setFooter((tui, theme, footerData) => {
+      unsubscribeBranch?.();
+      unsubscribeBranch = footerData.onBranchChange(() =>
+        tui.requestRender(),
+      );
+
+      const home = homedir();
+      return {
+        dispose() {
+          unsubscribeBranch?.();
+          unsubscribeBranch = undefined;
+        },
+        invalidate() {},
+        /** 汇总会话 usage 统计并渲染三行中文 footer，见模块级说明。 */
+        render(width: number): string[] {
+          let input = 0,
+            output = 0,
+            cacheRead = 0,
+            cacheWrite = 0,
+            cost = 0;
+          const addUsage = (t: {
+            input: number;
+            output: number;
+            cacheRead: number;
+            cacheWrite: number;
+            cost: { total: number };
+          }) => {
+            input += t.input;
+            output += t.output;
+            cacheRead += t.cacheRead;
+            cacheWrite += t.cacheWrite;
+            cost += t.cost.total;
+          };
+          let latestRate: number | undefined;
+
+          for (const e of ctx.sessionManager.getEntries()) {
+            if (e.type === "message" && e.message.role === "assistant") {
+              const u = (e.message as AssistantMessage).usage;
+              addUsage(u);
+              const promptTokens = u.input + u.cacheRead + u.cacheWrite;
+              latestRate =
+                promptTokens > 0
+                  ? (u.cacheRead / promptTokens) * 100
+                  : undefined;
+            } else if (
+              e.type === "message" &&
+              e.message.role === "toolResult" &&
+              e.message.usage
+            ) {
+              addUsage(e.message.usage as any);
+            } else if (
+              (e.type === "branch_summary" || e.type === "compaction") &&
+              (e as any).usage
+            ) {
+              addUsage((e as any).usage);
+            }
+          }
+
+          const fmt = (n: number) =>
+            n < 1e3
+              ? `${n}`
+              : n < 1e4
+                ? `${(n / 1e3).toFixed(1)}k`
+                : n < 1e6
+                  ? `${Math.round(n / 1e3)}k`
+                  : n < 1e7
+                    ? `${(n / 1e6).toFixed(1)}M`
+                    : `${Math.round(n / 1e6)}M`;
+
+          // 第 1 行：当前目录：~路径（分支）• 会话名
+          let pwd = ctx.sessionManager.getCwd();
+          const homeRelative = relative(home, pwd);
+          if (homeRelative === "") pwd = "~";
+          else if (
+            homeRelative &&
+            !homeRelative.startsWith("..") &&
+            !homeRelative.startsWith("/")
+          )
+            pwd = `~/${homeRelative}`;
+          const branch = footerData.getGitBranch();
+          if (branch) pwd += ` ${zh.footer.branchPrefix}(${branch})`;
+          const sessionName = ctx.sessionManager.getSessionName();
+          if (sessionName) pwd += ` • ${sessionName}`;
+          pwd = `${zh.footer.cwdPrefix}${pwd}`;
+
+          // 第 2 行左：严格按内置顺序：输入、输出、缓存、费用、上下文占比。
+          const clauses: string[] = [];
+          if (input > 0 || output > 0) {
+            const io: string[] = [];
+            if (input > 0) io.push(`${zh.footer.inputLabel}↑${fmt(input)}`);
+            if (output > 0)
+              io.push(`${zh.footer.outputLabel}↓${fmt(output)}`);
+            clauses.push(io.join("/"));
+          }
+
+          const cacheParts: string[] = [];
+          if (cacheRead > 0)
+            cacheParts.push(`${zh.footer.cacheReadLabel}${fmt(cacheRead)}`);
+          if (cacheWrite > 0)
+            cacheParts.push(
+              `${zh.footer.cacheWriteLabel}${fmt(cacheWrite)}`,
+            );
+          if (
+            (cacheRead > 0 || cacheWrite > 0) &&
+            latestRate !== undefined
+          ) {
+            cacheParts.push(
+              `${zh.footer.cacheHitLabel}${latestRate.toFixed(1)}%`,
+            );
+          }
+          if (cacheParts.length > 0) clauses.push(cacheParts.join(" "));
+
+          const provider = ctx.model
+            ? ctx.modelRegistry.getProvider(ctx.model.provider)
+            : undefined;
+          const usingSubscription =
+            ctx.model?.provider === "kimi-coding" ||
+            (!!ctx.model &&
+              ctx.modelRegistry.isUsingOAuth(ctx.model) &&
+              provider?.auth.oauth?.isSubscription === true);
+          if (cost > 0 || usingSubscription) {
+            clauses.push(
+              `${zh.footer.costLabel}$${cost.toFixed(3)}${usingSubscription ? zh.footer.subSuffix : ""}`,
+            );
+          }
+
+          // built-in 顺序的最后一项：上下文占比 / 上下文窗口（自动压缩）。
+          const cu = ctx.getContextUsage();
+          const windowSize =
+            cu?.contextWindow ?? ctx.model?.contextWindow ?? 0;
+          const pctValue = cu?.percent ?? 0;
+          // 与 built-in 一致：明确为 null 时显示未知；尚无 usage 时按 0.0% 显示。
+          const pctText =
+            cu?.percent === null ? "?" : `${pctValue.toFixed(1)}%`;
+          const contextClause = `${zh.footer.ratioLabel}${pctText}/${fmt(windowSize)}${getAutoCompactSuffix()}`;
+          const contextIndex = clauses.length;
+          clauses.push(contextClause);
+
+          // 占比按阈值变色（>90% 红、>70% 黄）；实验标记沿用 built-in 样式。
+          const statsLeft = clauses
+            .map((clause, index) => {
+              if (index === contextIndex) {
+                return pctValue > 90
+                  ? theme.fg("error", clause)
+                  : pctValue > 70
+                    ? theme.fg("warning", clause)
+                    : theme.fg("dim", clause);
+              }
+              return theme.fg("dim", clause);
+            })
+            .join(" ");
+
+          // 第 2 行右：provider • 模型 • 思考等级（等级映射为中文）
+          let rightSideWithoutProvider = ctx.model?.id ?? zh.footer.noModel;
+          if (ctx.model?.reasoning) {
+            const tl = ctx.thinkingLevel || "off";
+            const tlLabel =
+              tl === "off"
+                ? zh.footer.thinkingOff
+                : ((zh.footer.thinkingLevels as Record<string, string>)[
+                    tl
+                  ] ?? tl);
+            rightSideWithoutProvider = `${rightSideWithoutProvider} • ${tlLabel}`;
+          }
+          let rightSide = rightSideWithoutProvider;
+          if (footerData.getAvailableProviderCount() > 1 && ctx.model) {
+            rightSide = `(${ctx.model.provider}) ${rightSideWithoutProvider}`;
+            if (
+              visibleWidth(statsLeft) + 2 + visibleWidth(rightSide) >
+              width
+            ) {
+              rightSide = rightSideWithoutProvider;
+            }
+          }
+
+          let statsDisplay = statsLeft;
+          let statsWidth = visibleWidth(statsDisplay);
+          if (statsWidth > width) {
+            statsDisplay = truncateToWidth(statsDisplay, width, "...");
+            statsWidth = visibleWidth(statsDisplay);
+          }
+          const availableForRight = width - statsWidth - 2;
+          let statsLine = statsDisplay;
+          if (availableForRight > 0) {
+            const truncatedRight = truncateToWidth(
+              rightSide,
+              availableForRight,
+              "",
+            );
+            const padding = " ".repeat(
+              Math.max(
+                0,
+                width - statsWidth - visibleWidth(truncatedRight),
+              ),
+            );
+            statsLine = `${statsDisplay}${padding}${theme.fg("dim", truncatedRight)}`;
+          }
+
+          const lines = [
+            truncateToWidth(
+              theme.fg("dim", pwd),
+              width,
+              theme.fg("dim", "..."),
+            ),
+          ];
+          lines.push(statsLine);
+
+          // 第 3 行：各扩展的 setStatus 状态
+          const statuses = footerData.getExtensionStatuses();
+          if (statuses.size > 0) {
+            const statusLine = Array.from(statuses.entries())
+              .sort(([a], [b]) => a.localeCompare(b))
+              .map(([, text]) =>
+                text
+                  .replace(/[\r\n\t]/g, " ")
+                  .replace(/ +/g, " ")
+                  .trim(),
+              )
+              .join(" ");
+            lines.push(
+              truncateToWidth(statusLine, width, theme.fg("dim", "...")),
+            );
+          }
+          return lines;
+        },
+      };
+    });
+  };
+
+  applyZhFooter();
+  return () => {
+    if (usingZhFooter) {
+      usingZhFooter = false;
+      ctx.ui.setFooter(undefined);
+    } else {
+      applyZhFooter();
+    }
+  };
+}

package/extensions/header.ts

@@ -0,0 +1,52 @@
+/**
+ * 中文 header：复刻内置结构（标题 + 折叠提示行 + 引导语），
+ * 快捷键跟随用户键位配置。
+ */
+import {
+  keyHint,
+  keyText,
+  rawKeyHint,
+  VERSION,
+  type ExtensionContext,
+} from "@earendil-works/pi-coding-agent";
+import { zh } from "./zh.ts";
+
+/**
+ * 设置中文启动 header（仅 TUI 模式，其他模式无效果）。
+ *
+ * 复刻内置结构：logo + 折叠提示行（快捷键跟随用户键位配置）+
+ * 展开帮助语 + 引导文案。
+ *
+ * @param ctx 当前会话上下文
+ */
+export function setChineseHeader(ctx: ExtensionContext) {
+  if (ctx.mode !== "tui") return;
+  ctx.ui.setHeader((_tui, theme) => ({
+    render(_width: number): string[] {
+      const logo =
+        theme.bold(theme.fg("accent", "pi")) +
+        theme.fg("dim", ` v${VERSION}`);
+      const compact = [
+        keyHint("app.interrupt", zh.header.interrupt),
+        rawKeyHint(
+          `${keyText("app.clear")}/${keyText("app.exit")}`,
+          zh.header.clearExit,
+        ),
+        rawKeyHint("/", zh.header.commands),
+        rawKeyHint("!", "bash"),
+        keyHint("app.tools.expand", zh.header.more),
+      ].join(theme.fg("muted", " · "));
+      return [
+        logo,
+        compact,
+        theme.fg(
+          "dim",
+          `${zh.header.expandHelp} (${keyText("app.tools.expand")})`,
+        ),
+        "",
+        theme.fg("dim", zh.header.onboarding),
+      ];
+    },
+    invalidate() {},
+  }));
+}