DeepSeek Harness Plugin

wingsky-1/dsh-plugin-hub#packages/dsh-web-file-preview

Stars ★ 0 Category Tools & Capabilities Added 2026-08-18 npm @wingsky-1/dsh-web-file-preview

Preview conversation file links in the web UI (images / text / Markdown / highlighted code / git diff) — click a link to open a preview modal instead of the desktop opener; loopback-fenced routes with weak ETag/304 caching and DOMPurify sanitization.

Install

# from npm (prebuilt)

dsh plugin --profile web add @wingsky-1/dsh-web-file-preview

# from GitHub (first run asks for allowBuilds approval — follow the hint, retry)

dsh plugin --profile web add github:wingsky-1/dsh-plugin-hub#path:/packages/dsh-web-file-preview

Any plugin you install runs third-party code with your own permissions — it can read your files, use your credentials, and reach the network, and tool approvals don’t sandbox it. GitHub-sourced plugins also run build scripts at install time. Only install sources you trust, and pin a commit (github:owner/repo#sha).

README

This plugin publishes its README in Chinese only.

点击对话中的文件链接,在 web 端直接预览文件内容(图片 / 文本 / Markdown / 代码 / git Diff)。

DSH 自带的“可点击文件引用”在点击产出文件 chip / 行内文件引用时走的是桌面原生打开器——桌面可用,但纯 Web(局域网浏览器 / iPad / iPhone,或 nativeOpen:false 部署)没有 Web 端预览。本插件补上这一环:点击对话中可点击的文件链接,改为在对话框内弹出预览 Modal,图片直接 <img> 显示、文本以等宽 <pre> 渲染,明暗主题自适应。

能力

  • 图片预览png / jpg / jpeg / gif / webp / svg / avif / bmp;点击进入灯箱放大/平移(滚轮缩放 + 拖拽)。
  • Markdown 预览.md / .markdown 默认渲染预览(marked + GFM 常用能力),可切「原始」。
  • 代码语法高亮js/ts/py/java/… 等 25+ 语言(highlight.js 子集)高亮,可切「原始」。
  • 文本预览txt / log / csv / conf … 等宽展示。
  • Diff 视图(git).md/代码/文本 若在 git 仓库且有未提交变更,顶栏多出第 3 个 Diff tab,红/绿展示 git diff HEAD -- <file>(未跟踪新文件给提示)。
  • Modal 内动作:预览/原始/Diff复制路径在新标签打开关闭(Esc / 点遮罩)。
  • 加载错误态:错误细分 + 「在新标签打开」兜底。
  • 缓存:不设 JS 内存缓存(文件常被修改,永久缓存会显示陈旧内容);改用浏览器 HTTP 缓存 + 宿主弱 ETag(Cache-Control: no-cache + If-None-Match)自动协商——未变 304 秒回、已变自动拿最新。

实现

  • 宿主端GET /api/dsh-file-preview/file?cwd=&path=(loopback 围栏,非回环 403 / 方法非 GET 405),按 resolve(cwd, path) 定位读取(~/~/ 前缀用 untildify 展开为用户主目录);后缀分组:图片/文本/Markdown/代码直出,其余 415。GET /api/dsh-file-preview/diff?cwd=&path= 计算 git diff;GET /api/dsh-file-preview/health 健康检查。
  • 客户端:双机制拦截(workspaces.openPath 调用点收口 + document 捕获静态拦截)+ 分组渲染(renderGroupFor)+ 三 tab(预览/原始/Diff,Diff 仅 git 有变更才显示)。md 用 marked、代码用 highlight.js 子集、Diff 用 diff2html
  • 后缀分组单一事实源src/grouping.ts 供宿主 mime.ts 与客户端 renderer.ts/client.ts 共用,杜绝双端各写一份后缀表导致漂移。
  • 依赖marked / highlight.js / diff2html / untildify 为构建期打包依赖(宿主/客户端分别内联进 lib/index.jslib/client.js),运行时零 npm 依赖;Content-Type 用内置小型映射(无需 mime-db 大表,避免宿主第三方依赖内联的 ESM/CJS 兼容问题)。
  • 构建体积:客户端 esbuild --minifyclient.js min 后约 226KB(gzip ~68KB)。

安装

已安装 DeepSeek Harness 且 dsh web 可正常启动的前提下:

dsh plugin --profile web add @wingsky-1/dsh-web-file-preview

安装后重启一次 dsh web 生效(客户端 bundle 需页面刷新加载)。

配置

Key 默认 说明
enabled true 关闭则不注册任何路由

验证

pnpm build && pnpm test                 # 仓库内:构建 + smoke
curl http://127.0.0.1:3080/api/dsh-file-preview/health

安全模型

  • 保留 loopback 围栏:所有 /api 路由强制校验回环来源(跨站 / DNS 重绑定防护),与平台既有约定一致;health 之外的 /file、/diff 也仅允许 GET(方法不符 405)。
  • 不做重复兜底:本插件的语义是“能打开 dsh web 页面即已持有高权限”,因此不做任意文件访问强校验、会话鉴权、敏感名拦截——访问控制由平台/用户负责,本插件不重复实现每一套。
  • 路径定位/fileresolve(cwd, path) 直接定位,不做“逃出 cwd”拦截(任意文件访问由平台/用户负责)。~/~/ 前缀展开为用户主目录。
  • 渲染安全:Markdown / 代码渲染输出为 HTML 呈现层,marked / highlight.js 对正文做转义;本插件不承诺对渲染结果做 XSS 消毒——预览内容来自会话已见的文件,安全边界同“能打开 dsh web 即高权限”。

已知限制

  • 文本类一次性整读全文(未做截断/大文件流式/虚拟滚动)。
  • 可点击范围较宽(凡路径 title / 本地 href / 内联路径文本都可能进预览),后续可收窄到产出引用。
  • client bundle 含 marked + highlight.js 子集 + diff2html,min 后约 226KB(gzip ~68KB)。
  • 多会话切换以当前活跃会话 cwd 为准。

Content from the project README on GitHub ↗

Links

More in this category

View the whole category →