dsh-annotator 0.5.4 → 0.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +18 -16
- package/lib/client.js +1697 -296
- package/lib/index.js +146 -32
- package/lib/overlay.js +321 -46
- package/lib/session.js +586 -49
- package/lib/shared/annotation-markdown.js +174 -0
- package/lib/shared/auto-pick.js +29 -0
- package/lib/shared/binding-action.js +3 -0
- package/lib/shared/page-roles.js +365 -0
- package/lib/shared/tool-schema.js +21 -0
- package/package.json +9 -4
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# dsh-annotator
|
|
2
2
|
|
|
3
|
-
[](https://github.com/ZhongqiXiao/dsh-annotator/actions/workflows/ci.yml) [](https://www.npmjs.com/package/dsh-annotator) [](https://www.npmjs.com/package/dsh-annotator)
|
|
3
|
+
[](https://github.com/ZhongqiXiao/dsh-annotator/actions/workflows/ci.yml) [](https://www.npmjs.com/package/dsh-annotator) [](https://www.npmjs.com/package/dsh-annotator)
|
|
4
4
|
|
|
5
5
|
一个 [DeepSeek Harness](https://www.deepseek.com) Desktop 插件:在**真实的 Chrome / Edge / ego lite 页面**上拾取、标注、评论、截图页面元素,并把元素定位 + 评论 + 截图一并交给 agent —— 让 agent 按照「你实际看到的页面」做前端可视化修改。
|
|
6
6
|
|
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
- **元素拾取**:hover 高亮、点击拾取,拾取层不污染页面样式。
|
|
12
12
|
- **元素级信息**:唯一 CSS selector、页面 URL、坐标与尺寸、文本摘录、元素截图。
|
|
13
13
|
- **评论标注**:每个拾取元素可附评论,连同定位信息一起交给 agent。
|
|
14
|
+
- **参照模式(改动 ↔ 参照)**:照别人页面改自己页面时,把标注分成左右两栏——左栏「改动区」放要改的元素,右栏「参照区」放只读的样式与结构来源。一条改动可以挂多条参照(1:N),每条参照标明照哪些维度(布局、间距、配色、字号、圆角、交互、文案);页面不再有角色,同一页可以既有改动又有参照。插入的提示词带一句任务说明与编号「执行要求」:只改带 T 编号的那几处、带 R 编号的只准照不准动、改完逐条自检。
|
|
14
15
|
- **引用芯片**:点「插入」后,DSH GUI 输入框里出现 `标注 #pN` 芯片和元素截图附件;提交时自动展开为完整定位信息。芯片管线不可用时自动回退为纯文本插入。
|
|
15
16
|
- **浏览器长命复用**:首次「启动」拉起所选浏览器,之后每次都接回同一个实例——不丢登录态,断开连接也不关窗。默认不接管你的日常 Chrome;ego lite 是例外,它优先接管你已经开着的那个 ego lite,并在自己的「agent 空间」里干活。
|
|
16
17
|
- **一键清空与撤销**:底部「清空」一次清掉全部标注,提示条上的「撤销」可整批恢复。
|
|
@@ -24,13 +25,13 @@
|
|
|
24
25
|
|
|
25
26
|
## 安装
|
|
26
27
|
|
|
27
|
-
同一个包,桌面端与 Web
|
|
28
|
+
同一个包,桌面端与 Web 端都能装。`--profile` 填的不是随意的名字,而是 DeepSeek Harness 两种客户端形态各自对应的 profile:桌面 App 固定用 `desktop`(该 profile 由 Desktop 应用管理),浏览器端固定用 `web`(`dsh web` 等价于 `dsh --profile web`)。`ls ~/.dsh/profiles/` 下可能还会看到 `headless`、`tui` 等其他 profile——那是命令行形态,没有图形面板,装进去也看不见本插件。
|
|
28
29
|
|
|
29
30
|
### 方式 A:插件市场(图形界面)
|
|
30
31
|
|
|
31
32
|
**DSH 自带「插件」页**:侧栏 → **插件** → **添加插件**,输入准确包名 `dsh-annotator` → 安装。装完提供「立即启用」,需要重启时会提示。
|
|
32
33
|
|
|
33
|
-
|
|
34
|
+
**社区插件市场**:[dshmarket](https://dshmarket.com)(npm 包 `dshmarket`)收录了本插件,装上之后在市场里搜 `dsh-annotator` 即可安装;插件介绍与收录页见 [awesome-dsh-plugin](https://awesome-dsh-plugin.com/zh/p/ZhongqiXiao/dsh-annotator)。社区市场由第三方维护,收录不代表背书。
|
|
34
35
|
|
|
35
36
|
### 方式 B:命令行从 npm 安装(推荐)
|
|
36
37
|
|
|
@@ -49,7 +50,7 @@ dsh plugin --profile web add dsh-annotator
|
|
|
49
50
|
dsh web
|
|
50
51
|
```
|
|
51
52
|
|
|
52
|
-
钉版本写成 `dsh-annotator@0.
|
|
53
|
+
钉版本写成 `dsh-annotator@0.6.0`,从仓库装写成 `github:zhongqixiao/dsh-annotator`。
|
|
53
54
|
|
|
54
55
|
### 方式 C:本地目录(开发模式)
|
|
55
56
|
|
|
@@ -74,13 +75,13 @@ dsh web
|
|
|
74
75
|
|
|
75
76
|
重启 DSH 生效:Desktop 退出后重新打开;Web 端重新跑一次 `dsh web`。GUI 右侧边栏出现「元素标注」面板即安装成功;后续升级只需更新包再重启,面板会自动加载新版。
|
|
76
77
|
|
|
77
|
-
卸载与更新走同一套入口:侧栏「插件」页里可停用、更新、卸载,命令行则用 `dsh plugin --profile desktop remove dsh-annotator
|
|
78
|
+
卸载与更新走同一套入口:侧栏「插件」页里可停用、更新、卸载,命令行则用 `dsh plugin --profile desktop remove dsh-annotator`(Web 端把 `desktop` 换成 `web`,装进哪个 profile 就从哪个卸)。
|
|
78
79
|
|
|
79
80
|
## 使用流程
|
|
80
81
|
|
|
81
82
|
1. 打开 DSH GUI 右侧边栏的 **元素标注** 面板。
|
|
82
83
|
2. 输入地址(可以像浏览器地址栏那样只写域名:`gitee.com` 自动补成 `https://gitee.com/`,`localhost:5173` 补成 `http://`,带空格的一句会当成搜索词),按需在左侧选择浏览器(选过一次就记住),点击 **启动** —— 第一次会打开所选浏览器的真实窗口,之后都接回同一个实例;新地址在同一窗口新开标签页。选 ego lite 时会优先接管你已经开着的那个 ego lite,并在其中切到「agent 空间」。
|
|
83
|
-
3.
|
|
84
|
+
3. 启动成功后**自动进入拾取模式**——打开新网页、切标签页、切空间也一样,不用再点一次;hover 高亮元素,点击完成拾取。面板里把开关**关掉**之后,本次会话内不会再自动开启(手动再打开即恢复自动)。
|
|
84
85
|
4. 为该元素填写评论,点击卡片上的 **插入**(或底部 **全部插入(N 条)**)—— 输入框里出现引用芯片 + 元素截图附件。
|
|
85
86
|
5. 插入的同时,这些标注会从列表里移除(底部提示条可 **撤销** 恢复),所以下一轮标注天然从零开始,不用手动逐条清理。
|
|
86
87
|
6. 正常提交对话;agent 收到完整定位信息,随后即可对照页面修改前端代码。
|
|
@@ -132,16 +133,17 @@ dsh web
|
|
|
132
133
|
|
|
133
134
|
## 环境变量
|
|
134
135
|
|
|
135
|
-
| 变量 | 作用
|
|
136
|
-
| ------------------------------------------------ |
|
|
137
|
-
| `DSH_VISUAL_ANNOTATOR_CHROME` / `_EDGE` / `_EGO` | 覆盖对应浏览器的可执行文件路径
|
|
138
|
-
| `DSH_VISUAL_ANNOTATOR_WINDOW` | 标注窗口尺寸,如 `1440x900`(DIP);不设则最大化启动
|
|
139
|
-
| `DSH_VISUAL_ANNOTATOR_HEADLESS` | `1` 时无头启动,仅供插件自测
|
|
140
|
-
| `DSH_VISUAL_ANNOTATOR_BROWSER_ARGS` | 额外追加给浏览器的启动开关(逃生口,平时不需要)
|
|
141
|
-
| `DSH_VISUAL_ANNOTATOR_SANDBOX_FALLBACK` | 设 `0` 关掉「沙箱崩溃后自动改用 `--no-sandbox` 重试一次」
|
|
142
|
-
| `DSH_VISUAL_ANNOTATOR_ADOPT_RUNNING` | 设 `0` 不接管你已开着的 ego lite,改为自己起一个新实例
|
|
143
|
-
| `
|
|
144
|
-
| `
|
|
136
|
+
| 变量 | 作用 |
|
|
137
|
+
| ------------------------------------------------ | -------------------------------------------------------------- |
|
|
138
|
+
| `DSH_VISUAL_ANNOTATOR_CHROME` / `_EDGE` / `_EGO` | 覆盖对应浏览器的可执行文件路径 |
|
|
139
|
+
| `DSH_VISUAL_ANNOTATOR_WINDOW` | 标注窗口尺寸,如 `1440x900`(DIP);不设则最大化启动 |
|
|
140
|
+
| `DSH_VISUAL_ANNOTATOR_HEADLESS` | `1` 时无头启动,仅供插件自测 |
|
|
141
|
+
| `DSH_VISUAL_ANNOTATOR_BROWSER_ARGS` | 额外追加给浏览器的启动开关(逃生口,平时不需要) |
|
|
142
|
+
| `DSH_VISUAL_ANNOTATOR_SANDBOX_FALLBACK` | 设 `0` 关掉「沙箱崩溃后自动改用 `--no-sandbox` 重试一次」 |
|
|
143
|
+
| `DSH_VISUAL_ANNOTATOR_ADOPT_RUNNING` | 设 `0` 不接管你已开着的 ego lite,改为自己起一个新实例 |
|
|
144
|
+
| `DSH_VISUAL_ANNOTATOR_AUTO_PICK` | 设 `0` 关掉「启动 / 打开网页自动进入标注模式」,改成每次手动开 |
|
|
145
|
+
| `DSH_VISUAL_ANNOTATOR_DIR` | 覆盖临时文件根目录(默认系统临时目录下的同名目录) |
|
|
146
|
+
| `DSH_VISUAL_ANNOTATOR_CDP_URL` | 可选:改为连接该调试端点上的外部浏览器,如 `127.0.0.1:9222` |
|
|
145
147
|
|
|
146
148
|
插件**不往代码仓写文件**:浏览器 profile 与元素截图都在系统临时目录(macOS `$TMPDIR`、Linux `/tmp`、Windows `%TEMP%`)下的 `dsh-visual-annotator/`。面板带上会话 cwd 时,落点进一步细分到 `<项目名>-<cwd 哈希前 8 位>/`:不同项目各用一份 profile 与截图目录,不会串登录态,也不会互相覆盖。系统重启或临时目录清理后会自然消失,无需手动删除。
|
|
147
149
|
|