dsh-diff-approval 0.30.1 → 0.32.0

package/README.md

@@ -4,6 +4,9 @@ English | [中文](README.zh.md)
 
 [![npm version](https://img.shields.io/npm/v/dsh-diff-approval)](https://www.npmjs.com/package/dsh-diff-approval)
 [![CI](https://img.shields.io/github/actions/workflow/status/9087/dsh-diff-approval/ci.yml)](https://github.com/9087/dsh-diff-approval/actions)
+[![Compat (supported releases)](https://img.shields.io/github/actions/workflow/status/9087/dsh-diff-approval/compat.yml?label=compat%20(supported))](https://github.com/9087/dsh-diff-approval/actions/workflows/compat.yml)
+[![Compat (newer published releases)](https://img.shields.io/github/actions/workflow/status/9087/dsh-diff-approval/compat-newer.yml?label=compat%20(newer))](https://github.com/9087/dsh-diff-approval/actions/workflows/compat-newer.yml)
+[![Release](https://img.shields.io/github/actions/workflow/status/9087/dsh-diff-approval/release.yml?label=release)](https://github.com/9087/dsh-diff-approval/actions/workflows/release.yml)
 
 A DeepSeek Harness (DSH) plugin for pending-change review: it automatically tracks every successful `edit`, `write`, and editor (`str_replace_editor`) mutation, folds them into a single pending list in the sidebar where each file's diff can be reviewed and kept/reverted — and it can also import the workspace's version-control repository's local changes (Git / SVN / Perforce) in one click.
 
@@ -23,23 +26,25 @@ For Markdown files, the source-line diff can also be shown as a rendered before/
 
 ## ✨ Features
 
-- **Diff view**: syntax-highlighted whole-file diff with +/− counts, an overview ruler on the scrollbar showing where changes sit, and an in-file search (`Ctrl+F`, step with `F3` / `Shift+F3`) that highlights matched words. Rows are virtualized, so huge files stay smooth.
+- **Diff view**: syntax-highlighted whole-file diff with +/− counts, an overview ruler on the scrollbar showing where changes sit, and an in-file search (`Ctrl+F`, step with `F3` / `Shift+F3`) that highlights matched words. Rows are virtualized, so huge files stay smooth. The line-number column keeps a surface of its own — a shade lighter than the code block, so the numbers read as a column rather than as part of the code — and stays pinned while the code scrolls sideways.
 - **Block navigation & decisions**: jump between change blocks with `Ctrl+↑/↓` (or the previous/next buttons) — the focused block flashes, navigation is anchored to the scroll position and wraps at the top/bottom. Hover a block to **Keep** or **Revert** just that block from a small actions frame that also shows its position (e.g. "2/5"); after a single-block decision, focus advances to the next block. The lead rows left above the jumped-to block are configurable in settings.
 - **Selection frame**: drag to select a range of lines and a frame appears to **Keep** / **Revert** exactly that range.
 - **Per-file and bulk decisions**: the files in the file list can be kept / reverted one at a time, or **Keep all** / **Revert all** from its footer.
-- **Resolved files stay listed**: once every change in a file has been kept/reverted, the entry remains in the list and the panel asks whether to remove it or keep it for later.
-- **Undo / Redo**: every keep, revert, and import is undoable with `Ctrl+Z` / `Ctrl+Shift+Z` (rebindable in Shortcuts; `Ctrl+Y` remains an alias), active while the panel is open — text inputs keep their own editing.
+- **Resolved files stay listed**: once every change in a file has been kept/reverted, the entry remains in the list and the panel asks whether to remove it or keep it there.
+- **Undo / Redo**: every keep, revert, import, and comment is undoable with `Ctrl+Z` / `Ctrl+Shift+Z` (rebindable in Shortcuts; `Ctrl+Y` remains an alias), active while the panel is open — text inputs keep their own editing.
 - **Quick summon & file cycling**: `Ctrl+D` (configurable in settings) toggles the review panel from anywhere and `Esc` closes it; the panel is also one click away from the sidebar-foot row and from a button in the Session header beside the app's own controls; `Ctrl+Tab` / `Ctrl+Shift+Tab` cycle through the pending files.
 - **Line references**: select text in the diff — the status bar shows its `(file:line)` / `(file:start-end)` reference; click it (or press `Ctrl+L`) to copy, and with the setting on it auto-pastes into the composer and focuses it. References in the composer and queued messages are **auto-aligned** when the referenced file changes: surviving lines re-map to their new range, and a fully-removed line becomes `(file:LINE_MISSING)`.
 - **Highlight language**: auto-detected from the file extension, or overridden from a dropdown.
 - **Auto-wrap**: a "Wrap lines" toggle beside the language selector wraps long lines for that language (CJK breaks between characters, Latin words stay whole), remembered per language.
 - **Side-by-side split view**: an opt-in two-column diff (left "before" | right "current"), line-aligned with per-side horizontal scrolling and a shared vertical scrollbar. Toggle it from the toolbar or in settings (default: single-column unified view). In split view, changed blocks are aligned by content similarity and changed lines show intra-line word diffs — whole words for Latin text, per-character for CJK.
 - **Markdown preview**: for Markdown files, toggle between the source-line diff and a rendered before/after preview (`Preview` / `Source`). The preview content max width is configurable.
-- **Customizable appearance**: from the "Diff view" settings group, adjust the diff's code font size (%), line height (px), and the added / removed line colors, with a live preview.
+- **Customizable appearance**: from the "Diff view" settings group, adjust the diff's code font size (%), line height (px), the added / removed line colors, and the tab width (2 / 4 / 8 spaces), with a live preview.
+- **Comments & annotations**: select any lines and write a comment. The card is anchored below the selected lines and holds the discussion with the agent. Comment mode is on by default and can be turned off in settings. The agent can comment on its own (annotate): asking it to annotate a piece of code is one way to read that code faster. Say "annotate this project's startup flow for me" and it marks the entry point, the initialisation order and the important branches, line by line, to be read in order. In the side-by-side view the comment quotes both sides of the change, the removed lines and the added ones, so the agent reads the whole replacement.
+- **File menu**: on by default (the "File menu" row in the "Diff view" group turns it off). It takes over the click on some file links: a file row in the shell's edited / produced lists, an `@file` reference or file link in a message, and a relative link in this plugin's Markdown preview, and offers: **Open as usual** (the shell's own behaviour, replayed), **View in the review panel**, and **Copy file path**.
+- **Bundled CJK code font**: the panel ships JetBrains Maple Mono, subset and sliced by `unicode-range`; it is on by default and can be turned off in settings.
 - **External changes**: files already in the pending list are monitored — if one is later modified outside the reviewed edits (another tool, an editor), the panel adopts the new content and flags the divergence.
 - **Open / Reveal**: while reviewing a file's diff, open it in its default app or reveal it in the system file manager with one click.
 - **Import version-control changes**: when the list is empty, click the button to import the workspace's local changes from **Git / SVN / Perforce** — everything that is **not committed yet, staged or not** (Git is read against the last commit, the `git diff HEAD` view), plus deleted files and, opt-in, files the VCS has never seen (untracked / unversioned). The VCS root is found by walking up from the workspace, so a workspace inside a subdirectory works too.
-- **Settings**: a "Diff Approval" section in DeepSeek Harness settings, grouped into **Diff view** (code font size, line height, added / removed colors), **Shortcuts** (rebind the panel's keyboard chords), and **Floating coverage** (the same four edge switches the panel's own popover offers) plus preferences for auto-paste on copy, whether to include files version control has not seen when importing, the diff's tab width (2 / 4 / 8 spaces), the side-by-side split view, the block-jump lead rows, the Markdown preview default and width, and the quick-summon chord.
 - **Persistence**: pending state is stored per workspace at `<dshHome>/diff-approval/workspaces/<workspaceId>.json` and survives restarts — unhandled changes are still there when you come back, even in a fresh session.
 
 ## 📦 Install
@@ -87,21 +92,4 @@ Then restart `dsh web`.
 
 ## 🛠 Development
 
-```sh
-corepack pnpm install
-pnpm run typecheck   # tsc over both faces
-pnpm run build       # emits lib/index.js and lib/client.js
-pnpm test
-pnpm run fonts:check # the bundled code font: 138 slices, every range covered exactly once
-pnpm run fonts:plan  # what a page actually downloads, by how many hanzi it shows
-```
-
-The bundled font is [JetBrains Maple Mono](https://github.com/SpaceTimee/Fusion-JetBrainsMapleMono) (SIL OFL 1.1), subset and sliced by `scripts/fonts` — see [`assets/fonts/README.md`](assets/fonts/README.md) for the pipeline, the licence and what the slices cost.
-
-A `file:` profile install copies what the package's `files` list named *at install time*, so a checkout whose list grew needs a refresh before the host can hand the new files out:
-
-```sh
-npx @deepseek-ai/dsh plugin --profile web install   # then restart `dsh web`
-```
-
-Only the client half reloads on its own (its bundle is watched), so a client change shows up on a page refresh while a host-half change — like the route that serves the font — waits for the restart.
+Development setup, the command list, the two halves' reload rules and the font pipeline: [`DEVELOP.md`](DEVELOP.md).

package/README.zh.md

@@ -4,6 +4,9 @@
 
 [![npm 版本](https://img.shields.io/npm/v/dsh-diff-approval)](https://www.npmjs.com/package/dsh-diff-approval)
 [![CI](https://img.shields.io/github/actions/workflow/status/9087/dsh-diff-approval/ci.yml)](https://github.com/9087/dsh-diff-approval/actions)
+[![兼容性（声明范围内的已发布版本）](https://img.shields.io/github/actions/workflow/status/9087/dsh-diff-approval/compat.yml?label=compat%20(supported))](https://github.com/9087/dsh-diff-approval/actions/workflows/compat.yml)
+[![兼容性（比 latest 更新的已发布版本）](https://img.shields.io/github/actions/workflow/status/9087/dsh-diff-approval/compat-newer.yml?label=compat%20(newer))](https://github.com/9087/dsh-diff-approval/actions/workflows/compat-newer.yml)
+[![发布](https://img.shields.io/github/actions/workflow/status/9087/dsh-diff-approval/release.yml?label=release)](https://github.com/9087/dsh-diff-approval/actions/workflows/release.yml)
 
 一个 DeepSeek Harness（DSH）待处理改动审核插件：自动跟踪每次成功的 `edit` / `write` / 编辑器（`str_replace_editor`）改动，在侧边栏整合为一个待处理列表，可逐个文件查看完整差异并保留 / 回退，也可以把工作区里版本控制仓库的本地改动一键导入（Git / SVN / Perforce）。
 
@@ -28,18 +31,20 @@
 - **选区操作框**：拖动选中一段行，会浮现**保留 / 回退**该段行的操作框。
 - **整文件与批量操作**：文件列表里的文件可逐个保留 / 回退，也可在列表底部**全部保留** / **全部回退**。
 - **已处理文件保留在列表**：某文件的改动全部处理完后，条目仍保留在列表中，面板会询问是移除还是继续保留。
-- **撤销 / 重做**：每次保留、回退、导入都可以用 `Ctrl+Z` / `Ctrl+Shift+Z` 撤销 / 重做（可在「快捷键」中重绑，`Ctrl+Y` 仍作为别名），面板打开期间全局生效，输入框保留各自的编辑行为。
+- **撤销 / 重做**：每次保留、回退、导入与**评论**都可以用 `Ctrl+Z` / `Ctrl+Shift+Z` 撤销 / 重做（可在「快捷键」中重绑，`Ctrl+Y` 仍作为别名），面板打开期间全局生效，输入框保留各自的编辑行为。
 - **快速呼出与文件切换**：`Ctrl+D`（可在设置中修改）在任意位置开关面板，`Esc` 关闭；左侧栏底部那行、以及会话标题行里 App 自身操作旁的按钮，也都是一键入口；`Ctrl+Tab` / `Ctrl+Shift+Tab` 在待处理文件间切换。
 - **行引用**：选中 diff 文本后，底部状态栏显示其 `(文件:行号)` / `(文件:起-止)` 引用——点击（或按 `Ctrl+L`）即可复制，开启设置后还会自动粘贴到消息输入框并获得焦点。消息输入框和排队消息里的引用会随文件改动**自动对齐**：存活的行映射到新行号，整段被删的行变成 `(文件:LINE_MISSING)`。
 - **高亮语言**：默认按扩展名自动检测，也可通过下拉列表手动切换。
 - **自动换行**：语言下拉旁有个「Wrap lines / 自动换行」开关，按语言记住；CJK 逐字断行、拉丁词保持完整。
 - **双栏对比**：可选的双栏视图（左「改前」｜右「当前」），逐行对齐，两侧各自横向滚动、共享纵向滚动条。可在工具栏或设置中切换，默认是单栏（合并）视图。双栏视图按内容相似度对齐改动块，并对改动行做词级差异高亮——拉丁文字按整词、CJK 逐字。
 - **Markdown 预览**：对 Markdown 文件可在「源码」行差异与渲染后的「改前 / 改后」预览之间切换。预览内容最大宽度可配置。
-- **外观自定义**：在「差异视图」设置组里可调整差异代码字号（%）、行高（px）以及新增 / 删除行颜色，并带实时预览。
+- **外观自定义**：在「差异视图」设置组里可调整差异代码字号（%）、行高（px）、新增 / 删除行颜色，以及 Tab 宽度（2 / 4 / 8 空格），并带实时预览。
+- **评论与批注**：在任意行上选中一段并写下评论，评论卡片锚定在选中行下方，可以在卡片中与智能体直接探讨相关内容。评论模式默认开启，可以在设置中关闭。智能体可以主动评论（标注）：利用该功能可以要求智能体对相关代码进行标注，提高代码阅读效率。例如说一句「请帮我标注下这个项目的启动流程」，它会把入口、初始化顺序与关键分支的说明逐条标注到对应代码行上，顺着卡片读下来即可。双栏视图里评论会把这次改动的两侧都引用进去（删除行与新增行），智能体看到的是完整的替换。
+- **文件菜单**：默认开启（在「差异视图」组里的「文件菜单」一行可关）。它接管了如下一些文件链接的点击操作：外壳「已编辑 / 产出文件」列表里的文件行、消息里的 `@文件` 引用与文件链接、以及本插件 Markdown 预览里的相对链接，并提供：**默认方式打开**（重放外壳自己的行为）、**在审批面板中查看**、**复制文件路径**。
+- **内置 CJK 代码字体**：面板内置 JetBrains Maple Mono，按 `unicode-range` 子集化并切片，默认开启，设置中可以关闭。
 - **外部改动**：已纳入列表的文件若之后被外部修改（其它工具 / 编辑器），面板会跟进最新内容并标记分歧。
 - **打开 / 定位**：查看某个文件的差异时，可一键在默认应用中打开它，或在系统文件管理器中定位它。
 - **导入版本控制的改动**：列表为空时，点击按钮即可导入工作区里 **Git / SVN / Perforce** 的本地改动——**凡是没有提交的都算，add 过与否一样**（Git 以最后一次提交为基准，即 `git diff HEAD` 的口径），以及已删除文件，和（可选开启的）VCS 从未见过的文件（未跟踪 / 未版本化）。通过从工作区目录逐级向上查找 VCS 根目录，工作区在子目录里也能识别。
-- **设置**：在 DeepSeek Harness 设置里新增「改动审批」页，分为「差异视图」（代码字号、行高、新增 / 删除颜色）、「快捷键」（重绑面板各类按键组合）与「浮窗覆盖」（面板自身弹出菜单里的那四个边的开关）三组，另有复制后自动粘贴、导入时是否包含版本控制未跟踪文件、diff 的 Tab 宽度（2 / 4 / 8 空格）、双栏对比开关、差异跳转行距、Markdown 预览默认与宽度，以及快速呼出快捷键。
 - **持久化**：待处理状态按 workspace 落盘至 `<dshHome>/diff-approval/workspaces/<workspaceId>.json`，跨重启保留——回来时未处理的改动仍在，即便换了新会话。
 
 ## 📦 安装
@@ -87,21 +92,4 @@ npx @deepseek-ai/dsh plugin --profile web add dsh-diff-approval
 
 ## 🛠 开发
 
-```sh
-corepack pnpm install
-pnpm run typecheck   # 两个编译面的 tsc
-pnpm run build       # 产出 lib/index.js 与 lib/client.js
-pnpm test
-pnpm run fonts:check # 内置代码字体：138 个切片，每个码位恰好被覆盖一次
-pnpm run fonts:plan  # 页面上出现多少汉字时实际会下载多少
-```
-
-内置字体是 [JetBrains Maple Mono](https://github.com/SpaceTimee/Fusion-JetBrainsMapleMono)（SIL OFL 1.1），由 `scripts/fonts` 子集化并切片——流水线、许可证与各切片的体积见 [`assets/fonts/README.md`](assets/fonts/README.md)。
-
-`file:` 方式安装的 profile 只复制**安装当时** `files` 列出的文件，所以本地 checkout 后来新增的文件（如 `assets/fonts`）必须先刷新安装，宿主才拿得到：
-
-```sh
-npx @deepseek-ai/dsh plugin --profile web install   # 然后重启 `dsh web`
-```
-
-客户端那半会自己热更新（它的 bundle 被监听），所以客户端改动刷新页面即可；宿主那半的改动（例如提供字体的这条路由）要等重启才生效。
+开发环境、命令清单、两个半边各自的生效方式与字体流水线见 [`DEVELOP.md`](DEVELOP.md)。

package/assets/fonts/README.md

@@ -77,14 +77,16 @@ shell's stack>}`. `.lines` is the diff's code table, so the grid lands on the co
 and nothing else — comment bubbles, the file list and the panel's chrome keep the
 shell's font stack.
 
-**Off until asked for.** The switch is in the plugin's DSH Settings section
-(`等宽 CJK 字体` / "Monospaced CJK font"), stored as `diff-approval:code-font`, and
-it defaults to off because the slices are traffic the reader pays for: tens of
-kilobytes for ordinary Chinese, at most ~120 KB per slice for a rare character,
-33 KB for pure ASCII. Off means nothing is fetched at all — no manifest request,
-no `@font-face` — so the default panel is exactly what it was before this
-existed. A browser fetches a `@font-face` only when a rule uses it, which is what
-keeps an enabled pure-ASCII file down to the one Latin slice.
+**ON by default, and the switch still turns it off.** The switch is in the plugin's DSH Settings section
+(`等宽 CJK 字体` / "Monospaced CJK font"), stored as `diff-approval:mono-font`, and it defaults to ON
+(2026-10-06): the reader asked for existing profiles to be brought along rather than left off, and the cost
+is traffic that arrives ON DEMAND rather than with the page — tens of kilobytes for ordinary Chinese, at
+most ~120 KB per slice for a rare character, 33 KB for pure ASCII. Only an explicit `'0'` turns it off;
+the older `diff-approval:code-font` key is not read at all, so a profile that had turned the font off before
+that change comes back with it on (deliberate, recorded at the constant in `src/client/settings.ts`). Off
+means nothing is fetched at
+all — no manifest request, no `@font-face`. A browser fetches a `@font-face` only when a rule uses it, which
+is what keeps an enabled pure-ASCII file down to the one Latin slice.
 
 `font-display: swap` rather than `block`: the code is readable in the system font
 immediately, and swapping when the slices land changes the column width, never

package/assets/fonts/manifest.json

@@ -15,7 +15,7 @@
   "seedGlyphs": 300,
   "capBytes": 120000,
   "order": "ranked-hanzi.txt",
-  "gatedBy": "settings switch: diff-approval:code-font (off by default)"
+  "gatedBy": "settings switch: diff-approval:mono-font (on by default; an explicit '0' turns it off)"
  },
  "slices": [
   {