dsh-unidoc

dsh-unidoc — 通用文档中心（Universal Document Center）

🌐 中文 | English

DeepSeek Harness 的文档预览 / 编辑 / 管理插件。在 DSH Web GUI 中提供一个

VSCode 风格的「文档中心」工作台：左侧文件树，点击即预览，代码与 Markdown

支持编辑与 Ctrl/Cmd+S 保存；同时为 Agent 暴露 doc_read / doc_edit /

doc_create 三个文档工具，让模型可以通过自然语言读写工作区文档。

功能总览

1. 文件预览与编辑（验收标准对照）

2. 界面入口

• 侧边栏底部「📝 铅笔文件」图标按钮（sidebar.footer.action，纯图标无文字，Font Awesome fa-file-pen）——打开/关闭工作台；
• 全屏工作台（shell.overlay）：
• 顶部显示标题与当前工作区根目录路径（自动识别当前 DSH 会话工作区，切换 Agent / 会话时自动感知——打开时先刷新根目录并重载文件树，运行期每 5s 感知切换；每次上报「当前选中会话」工作区作为权威信号（hintCwd），切换到任意工作区（含早已创建的历史会话）都能精确命中，不再残留旧根；切换后文件树完全重置：清空缓存、重置展开状态、选中路径与滚动位置到根目录、关闭预览，顶部路径与文件树内容始终一致）；
• 左侧为文件区：
• 文件树顶部显示工作区根目录；文件树支持懒加载、点击目录展开/折叠、文件大小，文件图标按扩展名映射 Font Awesome 标准图标（代码/文档/图片/PDF/Office/压缩包/音视频等）；
• 「展开全部」：一键递归展开工作区全部目录（含 .git、.github、.vscode、node_modules 等隐藏目录），异步分批加载并每层让出主线程，超大仓库不卡页面；「折叠全部」一键收起并释放缓存；
• 刷新 / 展开全部 / 折叠全部 / 选项 / 关闭操作键统一排列在文件区下方（左下角），从布局上避免与其他插件悬浮按钮（如 better-sidebar 的折叠侧边栏图标）在右上角位置重合；
• 右侧为预览/编辑面板：所有视图工具栏均有「外部打开」按钮（点击 → 浮现编辑器选择菜单 → 选择 → 跳转打开，并记住上次选择的编辑器），HTML 预览另有「新标签页」按钮（window.open raw 路由 URL）；
• 运行卡片（tool.view.cordis）：显示插件激活状态与一键打开按钮；
• Toast 反馈：加载 Loading 状态、保存成功/失败提示；
• 选项面板（会话级内存配置，从文件区下方「⚙ 选项」键向上弹出）：代码编辑开关、Markdown 双模式开关、「暂不支持」提示卡开关、外部编辑器列表（增删改，自定义名称与命令，默认 VS Code / Sublime Text / Atom / Notepad++ / Vim / Neovim / Typora）。

3. Agent 集成工具

所有路径均相对文档中心根目录（当前会话工作区），并经 fs.contains 校验， 杜绝目录穿越。

技术架构

双端结构（DSH 动态 Cordis 插件）

• Host 半端（src/host.js，运行于 DSH Node 进程）
• 依赖声明：inject: ['fs', 'webServer', 'sandboxPolicy']
• 根目录解析（优先级从高到低）：

1. Client hintCwd（权威信号）：Client 从 DSH 客户端运行时 sessions 服务读取

「当前选中会话」的工作区 cwd（sessions.manager.selected → sessions.list.getSnapshot().byId[id].cwd），随每次 unidoc.root(hintCwd) 上报， Host 校验为目录后直接作为根目录——无论切换到新建会话还是早已创建的历史会话， 都能精确命中当前工作区，杜绝「永远显示旧工作区」；

1. 当前发起者 Agent 的会话 cwd（agents.currentInitiator() → session.header.cwd）——

仅在 Agent 工具调用上下文有效，浏览器 RPC 位于 initiator 边界外时返回 undefined；

1. 在线 Agent 列表的会话 cwd（agents.list()，注册顺序旧在前新在后）——

从最新注册向旧遍历，刚激活的会话最可能是当前工作区；

1. sessionQuery.listSessions() 中 live 会话 按 createdAt 降序——

排除持久化「幽灵」会话（历史会话 createdAt 可能最大，却早已不是当前工作区）；

1. sessionQuery.listSessions() 全部（含 persisted）按 createdAt 降序；
2. 兜底 sandboxPolicy.workspaceRoot（每次动态读取）。

工具执行时额外以调用者 Agent（exec.agent）的会话 cwd 为准，保证精准命中当前工作区； unidoc.root 支持 refresh: true 丢弃缓存重新解析，供 Client 感知工作区切换。

• 写入策略：插件上下文中 fs 后端默认沙箱根不是会话工作区，所有写路径（保存/创建/编辑）

显式传递 SandboxExecutionPolicy（workspaceRoot = 解析出的工作区；工具调用尊重会话模式覆盖， 如 read-only 会话拒绝写入）；

• 提供 Client RPC：unidoc.root / unidoc.list / unidoc.read / unidoc.save / unidoc.create

/ unidoc.openExternal（返回 raw 路由 URL，供客户端新标签页打开）/ unidoc.openWithEditor （child_process.spawn 启动外部编辑器：editorCmd 严格校验防注入、路径经 fs.contains 防目录穿越、detached + stdio: ignore + unref 不阻塞 Host）

• 注册 HTTP 路由（前缀随机、经 ctx.effect 自动回收）：GET <rawPrefix>?p=<相对路径>，

为图片 / PDF / HTML 提供原始字节，HTML 附带 Content-Security-Policy（禁脚本/禁连接） 与 X-Content-Type-Options: nosniff

• 通过 harness.defineTool + harness.registerTool 注册 3 个动态工具，注册挂载在

插件 Fiber（ctx.effect）上，停止/更新时自动注销

• Client 半端（src/client.js，运行于浏览器页面）
• 依赖声明：inject: ['slots', 'timer']
• 纯 React.createElement（无 JSX、无打包器），样式经 styles.insert 注入

并使用 --dsw-alias-* 主题 token（自动适配亮/暗主题）

• 自研轻量 Markdown 渲染器与代码分词高亮器（行内解析全部转义，防 XSS）
• 文件树图标内嵌 Font Awesome 6 Free Solid 官方 SVG path（按扩展名映射，含入口

fa-file-pen 图标），不依赖 GUI 是否内置 FA 字体

• 工作区识别：打开工作台时与运行期间（每 5s）经 unidoc.root(refresh) 感知工作区切换，

自动重置文件树（清缓存、重置展开/选中/滚动位置）并重新加载当前工作区文件结构； 每次上报均携带「当前选中会话」的工作区 cwd（hintCwd，来自运行时 sessions 服务）， 使 Host 精确命中当前工作区——即使切换到早已创建的历史会话也不残留旧根； 无 hint 时 Host 走候选兜底（在线 Agent 新→旧 → live 会话 → 持久化会话 → 兜底根）； 「展开全部」异步分批递归加载（含隐藏目录），超大仓库不卡页面

• 所有文件 IO 经 host.call 走 Host 半端，不直接触碰页面全局

生命周期

• 插件停止 / 更新 / 移除时：工具注册、HTTP 路由、Slot 注册、样式、定时器全部自动回收

（Cordis Fiber 效应与 disposer 机制）；

• 文档中心打开状态与选项为会话级内存状态，随插件卸载消失（动态插件不落盘）。

安装与运行

本仓库是 dsh-unidoc 的源码与文档仓库；插件以 DSH 静态 Cordis 插件包发布（lib/ 为构建产物，已随包提交）， 也可直接作为 DSH profile 依赖安装：

# 作为 DSH profile 依赖安装（lib/ 已包含在包内，prepare 也会自动构建）
npm install git+https://github.com/Che-Year/dsh-unidoc

开发调试（源码 → 产物）：

# 1. 安装构建依赖（esbuild）
npm install

# 2. 语法冒烟检查（与 DSH define-time 预检同构）
npm run check

# 3. 构建产物到 lib/（esbuild 打包 host + 自定义 bundler 打包 client）
npm run build

# 4. 在会话中部署：使用 cordis_define 提交两端源码（code.host / code.client），
#    再 cordis_run 激活（Client 端首次激活需要批准）

激活后：

• 侧边栏底部出现纯图标入口（Font Awesome 铅笔文件图标，悬停显示说明）；
• Agent 侧出现 doc_read / doc_edit / doc_create 工具。

持久化部署：如需随 Harness 启动自动加载，可将两端源码迁移为静态插件包

（dsh-web-ui 全家桶风格），或放入 ~/.dsh/.agent-presets 对应的预设中。

配置说明

外部编辑器以列表形式配置（会话级内存状态，随插件卸载消失）：

• 打开文档中心 → 左下角「⚙ 选项」→「外部编辑器列表」；
• 默认内置：VS Code（code）、Sublime Text（subl）、Atom（atom）、

Notepad++（notepad++）、Vim（vim）、Neovim（nvim）、Typora（typora）；

• 支持增删改：每一行可修改名称与命令，✕ 删除，末行「＋」添加新编辑器；
• 点击视图工具栏「外部打开」时弹出选择菜单，选择后调用 unidoc.openWithEditor

打开文件，并记住上次选择的编辑器作为下次默认；

• 命令约束：仅允许命令名或可执行文件路径（不含空格、不含 shell 元字符），

且需在系统 PATH 中（如 VSCode 的 code 命令需先执行「Install 'code' command」）； 目标文件路径一律经 fs.contains 校验，杜绝目录穿越。

更新日志

完整变更记录见 CHANGELOG.md。

开发与测试

• node scripts/check.js：两端源码语法冒烟测试；
• node tests/root-resolution.test.mjs：自动化测试（42 项断言）——根目录解析与工作区

隔离（hintCwd 权威信号 / 候选顺序 / 路径安全 / Agent 工具）；

• tests/verification.md：手工 E2E 验证清单（挂载、文件树、各格式预览、保存、

Toast、工具调用、边界用例）；

• 开发规范：不修改 ~/.dsh/source/current/ 下任何官方源码；只通过动态插件

机制挂载；复用官方 Service/Slot 能力（fs、webServer、slots、timer）。

来源与许可

本插件基于/复用了 dsh-better-sidebar 的架构能力，感谢原作者的贡献。

• 本插件采用 MIT 许可证发布，LICENSE 文件中保留上游（dsh-better-sidebar

及 DSH 核心框架，均遵循 MIT 许可证）的完整版权声明与许可条款；

• 本仓库绝不修改、复制或混入 ~/.dsh/source/current/ 下的任何官方源码，

仅在运行时通过 DSH 官方动态插件机制挂载能力，避免衍生品混淆与合规风险。