Skip to content
Back to search

dsh-popout-sidebar

A sidebar can pop out a separate browser tab (drag it to another monitor)

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/e2mcc--dsh-popout-sidebar/badge.svg)](/listings/e2mcc--dsh-popout-sidebar)

HTML

<a href="/listings/e2mcc--dsh-popout-sidebar"><img src="/api/listings/e2mcc--dsh-popout-sidebar/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 157 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. # 可弹出式侧边栏 · Popout Sidebar
  2. **可弹出式侧边栏**:侧边栏展示产物与文件树,支持多种文件预览形式;并可弹出为独立浏览器标签页(可拖至另一显示器上更大更清晰的观看);兼容其他 sidebar 插件,可以同时显示。
  3. > **Popout Sidebar**: a sidebar that lists the agent's artifacts and a file tree, with multiple preview formats, and pops out into a separate browser tab (drag it to another monitor for a larger, clearer view) — coexisting with other sidebar plugins at the same time.
  4. 给 [DeepSeek Harness](https://github.com/deepseek-ai/DeepSeek-Harness) Web UI 增加一个展示**产物(artifacts)**与**文件树**的侧边栏,并可一键弹出为**独立浏览器标签页**。
  5. ## 已上线 / Now available
  6. 本插件已收录进 DeepSeek Harness 插件生态:
  7. | 渠道 | 入口 |
  8. |---|---|
  9. | 插件精选列表 | [awesome-dsh-plugin.com](https://awesome-dsh-plugin.com/) · [详情页](https://awesome-dsh-plugin.com/zh/p/e2mcc/dsh-popout-sidebar/) |
  10. | 插件市场 | [dsh-market](https://github.com/dsh-market/dsh-market)(DSH 内:设置 → Plugin Market) |
  11. ### 一键安装(推荐)
  12. 先装市场:
  13. ```sh
  14. dsh plugin --profile web add dshmarket
  15. ```
  16. 重启 `dsh web` 后,打开 **设置 → Plugin Market**,搜索 **popout** 或 **sidebar**,点「安装」。
  17. 或直接按注册表命令安装:
  18. ```sh
  19. dsh plugin --profile web add github:e2mcc/dsh-popout-sidebar
  20. ```
  21. 装完**重启 `dsh web`** 并**硬刷新浏览器**(Cmd/Ctrl+Shift+R),界面右上角出现常驻「产物」图标按钮(无会话时也可见)。
  22. ## 特性 / Features
  23. - ↗️ **弹出为独立标签页**:一键把侧边栏弹出为独立网页标签页(`/popout-sidebar`),每 1.5s 自动刷新,可拖到另一块显示器上更大、更清晰地观看。
  24. - 🗂 **产物侧边栏**:实时列出代理通过 `write` / `edit` 创建或修改的文件,以及 `bash` / `pwsh` 命令在工作区里产生的文件(如脚本生成的图片);列表与预览区之间的分界线可拖动调整。
  25. - 🌳 **文件树**:侧边栏与独立标签页内都有「文件树」,可浏览当前工作区目录(懒加载展开,点击文件即预览),并**实时跟随工作区切换**。
  26. - 👀 **多类型预览**:按文件类型预览——代码 / 纯文本(语法高亮 + 行号)、Markdown 渲染、图片、PDF(浏览器原生查看器)、HTML(沙箱 iframe),超长内容自动截断。
  27. - 📝 **编辑差异**:`edit` 修改过的文件在预览里展示「删除 / 新增」改动片段对比。
  28. - 🔗 **复制 / 引用**:一键复制文件路径,或把 `@path` 引用写入会话输入框(悬浮在列表行)。
  29. - 🧭 **与其他 sidebar 兼容**:其他「侧边卡片」打开时,本侧边栏自动让位到其左侧,两者同时可见;DSH ≥0.1.7 自带的右侧边栏展开时,本侧边栏与右上角图标按钮自动让到其左侧,收起时其头部展开按钮也与本侧边栏的图标按钮并排不重叠。
  30. - ⚙️ **设置面板**:DSH 设置里新增「Popout Sidebar」选项卡,可开关默认展开、自动刷新、文件树,设置最短面板宽度(存于 `localStorage`);面板更宽可通过拖动左边缘调整。
  31. - 🗑 **清除模式**:右上角进入清除模式后,点击产物将其标红,再点红色 × 移除列表条目(仅移除条目,不动磁盘文件)。
  32. - ✖️ **关闭**:点击右上角「产物」图标按钮收起面板。
  33. ## 工作原理 / How it works
  34. - **Host(Node 进程)**
  35. - 监听 `tools/result` 事件,追踪 `write` / `edit` 的成功调用并提取 `file_path`(`edit` 额外记录 `old_string`/`new_string` 改动片段,并按扩展名标注预览类型)。
  36. - 监听 `tools/execute` 事件,对 `bash` / `pwsh` 这类「不透明」执行器做工作区前后快照对比(`fs.listDir` 递归 + 版本 token 指纹,跳过 `node_modules`/`.git` 等大目录),把命令间接新增/改写的文件并入产物列表。
  37. - 通过 `harness.handle` 暴露 RPC:`artifacts.list`、`artifacts.read`、`artifacts.remove`、`artifacts.listDir`。
  38. - 通过 `webServer.register` 提供路由:`/popout-sidebar`(页面)、`/popout-sidebar/data`(JSON)、`/popout-sidebar/content`(文本预览)、`/popout-sidebar/media`(二进制图片 / PDF)、`/popout-sidebar/remove`(移除条目)、`/popout-sidebar/listdir`(目录列表)。
  39. - **Client(浏览器)**
  40. - 在 `shell.overlay`(root 作用域)注册一个固定于**右上角**的常驻「产物」图标按钮,无会话时依然可见。
  41. - 在 `shell.overlay` 渲染浮动侧边栏面板。
  42. - 订阅 session store、并通过跨标签页 `localStorage` 同步当前会话,让侧边栏与独立标签页的**文件树实时跟随工作区切换**(行为一致)。
  43. ## 目录结构 / Layout
  44. ```
  45. .
  46. ├── README.md
  47. ├── LICENSE
  48. ├── package.json # 静态 bundle 元数据(main / exports ./client / dsh.bundle / dsh.client)
  49. ├── cordis.patch.yml # bundle 挂载补丁(dsh plugin add 自动识别)
  50. ├── scripts
  51. │ ├── build.js # 组装脚本:把 src/{shared,host,client} 拼成下面的两个单文件 bundle
  52. │ └── precommit.sh # 提交前守护:自动重建 bundle,产物过期则拦截提交
  53. └── src
  54. ├── index.js # 静态 Host 入口(ESM):求值 host.js 主体并导出给 loader
  55. ├── host.js # ⚙️ 生成产物:Host 单文件(由 scripts/build.js 生成,勿手改)
  56. ├── client.js # ⚙️ 生成产物:Client 单文件 bundle(由 scripts/build.js 生成,勿手改)
  57. ├── shared/ # 两端共享的可复用纯函数(可移植 JS,无模板字符串)
  58. │ ├── ext.js # 扩展名 → 预览类型(extType / fileExt)
  59. │ ├── markdown.js # 极简 Markdown → HTML(含代码块高亮)
  60. │ └── highlight.js # 零依赖语法高亮器(tok-* token)
  61. ├── host/ # Host 半模块(Node 进程)
  62. │ ├── body.js # 骨架:inject / apply + 占位符
  63. │ ├── core.js # 常量 + 产物追踪 + 文件操作 + RPC
  64. │ ├── page.js # 独立标签页 HTML(内联 script 引用 shared)
  65. │ └── routes.js # /popout-sidebar/* HTTP 路由
  66. └── client/ # Client 半模块(浏览器)
  67. ├── body.js # 骨架:__ModuleLoader__ 工厂 + 占位符
  68. ├── core.js # store / settings / 会话辅助
  69. ├── styles.js # 注入的 CSS
  70. ├── icons.js # 内联 SVG 图标
  71. ├── preview.js # renderPreview / CodeView / diff
  72. └── components.js # FileTree / ArtifactsPanel / 设置面板
  73. ```
  74. > 修改 `src/shared/`、`src/host/`、`src/client/` 里的源码后,运行 `npm run build`(或 `node scripts/build.js`)重新生成 `src/host.js` 与 `src/client.js`,再提交。运行时 DSH 只加载这两个生成产物。
  75. >
  76. > 建议安装提交前守护(一次即可):`ln -sf ../../scripts/precommit.sh .git/hooks/pre-commit`。之后每次 `git commit` 会自动重建 bundle,若产物与源码不同步会直接拦截提交,杜绝「源码新、产物旧」。
  77. ## 使用 / Usage
  78. 本插件同时支持**静态安装**(推荐,持久生效)与**动态加载**(临时)。
  79. ### 静态安装(推荐)
  80. 前置:DSH 已装好(`dsh web` 能正常运行)。
  81. ```sh
  82. # 通过注册表(GitHub 源码)
  83. dsh plugin --profile web add github:e2mcc/dsh-popout-sidebar
  84. # 或通过 dsh-market 市场:装好市场后在 设置 → Plugin Market 里一键安装
  85. ```
  86. 装完**重启 DSH 服务**(host 半加载)并**硬刷新浏览器**(Cmd/Ctrl+Shift+R),界面右上角即出现常驻「产物」图标按钮。
  87. - 包内 `cordis.patch.yml`(`dsh.bundle.patch`)让 CLI 自动把它挂进 `dsh.profile.bundles`;
  88. - client 半由 `package.json` 的 `dsh.client.platform: "web"` + `exports["./client"]` 自动发现并加载;
  89. - 本地开发用 `dsh plugin --profile web add /绝对路径/dsh-popout-sidebar` 会安装为符号链接,改 `src/` 后重启服务 / 硬刷新即可生效。
  90. ### 动态加载(临时,进程级)
  91. `src/host.js` 与 `src/client.js` 的 `return { ... }` 主体仍可直接传给 `cordis_define`:
  92. 1. 在 Harness 会话中调用 `cordis_define`:`code.host` 填 `src/host.js` 的 `return { ... }` 主体;`code.client` 填 `src/client.js` 的 `return { ... }` 主体。
  93. 2. 调用 `cordis_run` 激活返回的 `pluginId` / `packageId`。
  94. 3. 点击「产物」按钮;点面板右上角 ↗ 打开独立标签页。
  95. > 两种模式下 host 与 client 都通过 `/popout-sidebar/*` HTTP 路由通信(动态模式另保留 `harness.handle` RPC 兼容),因此行为一致。
  96. ## 设置 / Settings
  97. 在 DSH 设置面板(左下角 ⚙️)里会多出一个「**Popout Sidebar**」选项卡:
  98. | 设置 | 默认 | 说明 |
  99. |---|---|---|
  100. | 默认展开 | 开 | 页面加载后侧边栏默认展开;关闭则默认收起 |
  101. | 自动刷新 | 开 | 面板打开时每 2s 拉取最新产物列表 |
  102. | 文件树 | 开 | 在侧边栏显示「文件树」标签页,浏览工作区目录 |
  103. | 最短面板宽度 | 20% | 面板最小宽度(占窗口宽度的百分比,20–60%);更宽可拖动面板左边缘调整 |
  104. | 预览区默认高度 | 70% | 预览区占面板高度的百分比(20–80),决定预览区与列表区分界线的位置;仍可拖动分界线临时调整 |
  105. > 右上角的「产物」图标按钮、独立标签页按钮(↗)、以及「自动让位到其他侧边栏左侧」均为常驻行为,无需开关。
  106. 设置保存在浏览器 `localStorage`(键 `dsh-popout-sidebar:settings`),刷新后仍然生效。
  107. ## 主题 / Theming
  108. - 侧边栏**面板**跟随主界面浅色 / 深色主题(使用 `--dsw-alias-*` 主题变量)。
  109. - 独立**标签页**刻意固定为浅色配色(保证在另一显示器上内容清晰稳定);如需深色,可在地址后手动加 `?scheme=dark`。
  110. ## 更新 / Updates
  111. - 本插件从 **GitHub 源码**安装(未发布 npm),更新按 **commit 比对**:`dsh-market` 的「更新」会自动比对本地锁定的 commit 与仓库当前 HEAD,检测到新提交即提示「更新可用」,点一下即可升级。
  112. - 命令行更新:`dsh plugin --profile web update dsh-popout-sidebar`(或重新 `add`),随后重启 `dsh web` 并硬刷新浏览器。
  113. ## License
  114. [MIT](./LICENSE)

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.