dsh-explorer-editor

Readme

<p align="center">
  <img src="docs/logo-transparent.svg" alt="dsh-explorer-editor logo" width="120" />
</p>

<p align="center">
  <a href="https://github.com/oneirictouch/dsh-explorer-editor">GitHub</a> ·
  <a href="#安装">安装</a> ·
  <a href="#themes">主题导入导出</a> ·
  <a href="#常见问题">FAQ</a> ·
  <a href="https://github.com/oneirictouch/dsh-explorer-editor/issues">反馈 Issues</a> ·
  <a href="https://github.com/oneirictouch/dsh-explorer-editor/releases">Releases</a>
</p>

<p align="center">
  <a href="https://github.com/oneirictouch/dsh-explorer-editor/releases"><img alt="version" src="https://img.shields.io/badge/version-0.10.2-0969da?style=flat" /></a>
  <a href="LICENSE"><img alt="license" src="https://img.shields.io/badge/license-MIT-blue.svg?style=flat" /></a>
  <img alt="DeepSeek Harness" src="https://img.shields.io/badge/DeepSeek%20Harness-plugin-4dabf7?style=flat" />
  <a href="https://github.com/oneirictouch/dsh-explorer-editor"><img alt="stars" src="https://img.shields.io/github/stars/oneirictouch/dsh-explorer-editor?style=flat&label=stars" /></a>
  <img alt="editor" src="https://img.shields.io/badge/editor-Monaco-7ee787?style=flat" />
  <img alt="workspace" src="https://img.shields.io/badge/workspace-current%20conversation-green?style=flat" />
</p>

<p align="center"><a href="README.en.md">English</a> · <b>简体中文</b></p>

---

# dsh-explorer-editor

> DeepSeek Harness 的 VS Code 风格文件管理器插件：在 Web 侧边栏浏览当前对话工作区的文件，在中间主区域编辑。
> 
> A VS Code-style file manager plugin for DeepSeek Harness Web: browse the current conversation's workspace from the sidebar and edit files in the center column.

## 截图

<p align="center">
  <img src="docs/screenshot.jpg" alt="dsh-explorer-editor 使用界面：左侧文件树，中间 Monaco 编辑器" width="100%" />
</p>

侧边栏文件树浏览工作区，点击文件后在中间列「文件」视图中编辑（Monaco 编辑器，语法高亮）。

## 安装

```sh
# 在 clone 下来的 dsh-explorer-editor 目录内执行（不是父目录）
cd /path/to/dsh-explorer-editor
dsh plugin --profile web add .
```

`dsh plugin add` 会把包 pnpm-link 进 profile 并追加到 `dsh.profile.bundles`。**重启 `dsh web` 生效**（client 插件元数据按名缓存，重启后重新扫描）。

### 桌面端（DSH Desktop）安装

桌面端是 [deepseek-harness-desktop](https://github.com/anywhere-labs/deepseek-harness-desktop) 项目（包名 `dsh-plugin-desktop`）。它与 `dsh web` 使用**互相独立的 profile**（桌面端用 `desktop`，`dsh web` 用 `web`），插件**不会自动共享**——只装进 `web` profile 的插件在桌面端不会出现，设置 → 插件列表里也不会显示：

```sh
# 同样在 dsh-explorer-editor 目录内执行
cd /path/to/dsh-explorer-editor
dsh plugin --profile desktop add .
```

安装后**完全退出并重启桌面端**（退出应用，不是关窗口），`dsh-explorer-editor` 才会出现在侧边栏"工作区 / 文件"页签和设置 → 插件列表中。

> 注意：不要往 `~/.dsh/profiles/desktop/cordis.yml` 里添加插件——桌面端每次启动都会把它重写为空列表 `[]`。插件的正确入口是 profile `package.json` 的 `dsh.profile.bundles` + `dependencies`（`dsh plugin add` 做的正是这件事）。

### 从 npm 安装

```sh
dsh plugin --profile web add dsh-explorer-editor
```

或从 [Releases](https://github.com/oneirictouch/dsh-explorer-editor/releases) 页面下载 tarball 后本地安装（桌面端把 `--profile web` 换成 `--profile desktop`）：

```sh
dsh plugin --profile web add ./dsh-explorer-editor-0.10.2.tgz
```

### 配置

`cordis.patch.yml` 中的 `root` 只是**无会话时的兜底根目录**（默认 `process.cwd()`）。文件管理器打开时，浏览器会解析当前对话的工作区目录并通过 `setRoot` 重新固定根目录，因此一般无需改动：

```yaml
- insert:
    - id: dsh-explorer-editor
      name: 'dsh-explorer-editor'
      config:
        root: !!js process.cwd()   # 仅作为打开文件管理器前的兜底根目录
        allowArbitraryRoot: true   # 是否允许 setRoot 越出 root（见下）
```

> **安全边界**：`allowArbitraryRoot` 默认 `true`，此时 `setRoot` 跟随当前会话的工作区（可能位于 `root` 之外）。若想限制 `setRoot` 只能把根固定到 `root` 之下（防止通过 RPC 越界读取工作区以外的文件），请把它设为 `false`。所有文件操作仍受「工作区边界」约束——路径一旦逃逸出当前固定的根即被拒绝（含 symlink 逃逸）。

## 功能

- **侧边栏"工作区 / 文件"页签**：页签条渲染在工作区浏览器头部（替换原"工作区"文字标签）；点"文件"把侧边栏主体切换为文件管理器（文件树），点"工作区"切回工作区/会话列表
- **工作区跟随当前对话**：文件管理器打开时自动解析当前会话的工作区目录（`SessionHeader.cwd`），通过 `setRoot` 重新固定网关根目录——不再是启动 `dsh web` 的目录
- **中间列编辑器（视图标签）**：编辑器注册为中间栏 `conversation.view` 视图（"文件"标签，与"对话/轨迹"并列）。点击文件后在**页面内的会话滚动区**（非弹窗）显示并编辑：Monaco Editor（VS Code 同款内核，从 CDN 加载）按扩展名自动语法高亮；CDN 不可达时降级为纯文本 textarea
- **Markdown 预览**：`.md` 文件默认以**源码模式打开（可直接编辑）**，工具栏"主题"按钮旁有 VS Code 风格的**预览/源码切换按钮**（仅 Markdown 文件显示），点击可切换到**只读渲染预览**（marked + GFM：标题/列表/表格/任务列表/代码块）；模式选择自动记住（localStorage），下次打开沿用
- **主题设置（VS Code 风格）**：编辑器工具栏"主题"按钮打开设置面板——默认浅色，预设主题用**下拉框**选择（浅色/深色/One Dark/GitHub），可自定义背景色/文字色/字号（10–28px），实时应用到 Monaco 与编辑器面板（工具条/状态条/标签随背景联动），自动持久化到 localStorage
- **主题导入/导出**：像 VS Code 一样把主题保存为 JSON 文件、从文件恢复，方便在不同环境间迁移配色（详见[主题导入/导出](#themes)）
- **编辑与保存**：Ctrl+S 或编辑器内"保存"按钮，dirty 标记（●）；打开多个文件可在顶部标签条切换、每个标签带 ✕ 关闭
- **文件操作**：新建文件、新建目录、重命名、删除（删除需确认，非空目录拒绝）
- **键盘导航**：文件树支持方向键（↑/↓ 移动选中、→ 展开目录、← 收起目录）、Enter/空格 打开文件或切换目录——贴近 VS Code 资源管理器的键盘体验
- **右键上下文菜单（VS Code 风格）**：右键文件/目录弹出菜单——**剪切 / 复制 / 重命名 / 删除 / 复制路径 / 复制相对路径**；右键目录或树空白区额外提供**粘贴**（剪切→移动、复制→拷贝，目录递归，目标已存在不覆盖）。删除需二次确认、非空目录拒绝。剪切源行淡化提示，剪贴板在面板切换间保留（刷新页面丢失）
- **编码自动识别**：文本文件优先按 UTF-8 读取，UTF-8 非法时自动回退 **GBK/GB2312**（Windows 生成的日志/导出常见；非 full-ICU 环境再兜底 latin1），中文不再乱码；编辑保存后文件统一转为 UTF-8
- **会话恢复（刷新保留）**：打开的文件标签与**未保存的编辑内容**自动持久化到 localStorage——刷新页面后自动恢复上次的标签与未保存修改（>256KB 的大文件只恢复标签、内容重新从磁盘读取；切换工作区不串标签；仅浏览器内保留）
- **目录树实时刷新（SSE 推送）**：宿主端 `fs.watch` 递归监听工作区，文件系统变更通过 SSE 毫秒级推送到浏览器，目录树只刷受影响目录（贴近 VS Code 资源管理器）；窗口重新聚焦时全量兜底刷新
- **工作区边界**：所有路径解析相对当前固定的 `root`，越界路径被 host 拒绝（含 symlink 逃逸防护）
- **中英双语界面**：所有 UI 文案通过 locale 字典本地化（`dshFile` 命名空间，zh / en），随 DSH 语言切换；不再出现中英混杂

## 主题导入/导出

<a id="themes"></a>

主题设置面板（编辑器工具栏"主题"按钮）支持把当前主题导出为 JSON 文件，或从 JSON 文件导入恢复——和 VS Code 的主题文件机制一致，方便换机器、换环境时迁移你的配色。

### 导出主题

1. 打开文件编辑器（中间列"文件"视图）。
2. 点击工具栏 **主题** 按钮，打开主题设置面板。
3. 点击 **导出主题**，浏览器会下载一个 `dsh-explorer-editor-theme-YYYY-MM-DD.json` 文件。

导出的 JSON 同时包含本插件字段与 VS Code workbench `colors` 字段：

```json
{
  "name": "dsh-explorer-editor · One Dark",
  "type": "dsh-explorer-editor-theme",
  "version": 1,
  "background": "#282c34",
  "foreground": "#abb2bf",
  "fontSize": 13,
  "colors": {
    "editor.background": "#282c34",
    "editor.foreground": "#abb2bf"
  }
}
```

### 导入主题

1. 打开主题设置面板。
2. 点击 **导入主题**，选择 JSON 文件。

支持的格式：

- **本插件导出的格式**（`background` / `foreground` / `fontSize`）；
- **VS Code 主题 JSON**：读取 `colors["editor.background"]` 与 `colors["editor.foreground"]`（`tokenColors` 暂不参与，语法高亮沿用 Monaco 内置配色）。

导入成功后配色立即应用并持久化到 localStorage；文件不是有效 JSON 或缺少有效颜色时，面板会给出错误提示。

## 架构

插件由两半组成，共用包名 `dsh-explorer-editor`：

|        | Host 半（Node 进程）                                                      | Client 半（浏览器 React）                           |
| ------ | -------------------------------------------------------------------- | --------------------------------------------- |
| 源码     | `src/index.ts`                                                       | `src/client/`                                 |
| 构建产物   | `dist/index.js`（tsc，保留标准装饰器）                                         | `dist/client.js`（esbuild，ModuleLoader bundle） |
| 职责     | 文件系统 RPC                                                             | 侧边栏文件树 + 中间列编辑器视图                             |
| 关键 API | `class FileManagerGateway extends TypertRemoteService` + `@Remote()` | `ctx.slots.register()`、`ctx.remote.$mount()`  |

### Host ↔ Client 通信（Typert Remote）

浏览器不能直接访问文件系统，所以 host 半把文件操作暴露为 RPC 端点（namespace `fileManager`：`listDir` / `readText` / `readDataUrl` / `writeText` / `createFile` / `createDirectory` / `rename` / `copy` / `delete` / `stat` / `resolve` / `getRoot` / `setRoot`）。客户端通过 `ctx.remote.$mount(TYPERT_REMOTE)` 挂载调用面，再用 `ctx.get('remote.fileManager')` 解析服务后调用。`setRoot` 用于把网关根目录重新固定到当前会话的工作区目录。

**关键约束（SRC descriptor 契约）**：Typert gateway 用 `Function.prototype.toString` 从方法签名提取 wire 参数名——所以 host 方法必须用**扁平参数**（`listDir(path: string)`，不是 `listDir(input: {...})`），参数名即客户端发送的字段名。两半的命名必须一致。

### 面板切换机制

侧边栏主区域是 `sidebar.workspaces` 单席位 slot（被工作区浏览器以 priority 0 占用）。插件在 `sidebar.workspaces.tabs` 槽注册「工作区 / 文件」视图页签条——渲染在工作区浏览器头部行内、替换原「工作区」文字标签，与搜索/操作图标同一行；点「文件」时插件以 `priority: -1` 注册自己的 shadow 条目，单席位 slot 渲染 priority 最低的条目，文件管理器成为 winner；切回「工作区」时注销条目，工作区浏览器自动恢复。文件树点击文件后，编辑器在 `conversation.view` 注册的"文件"视图里渲染——即中间列会话滚动区（与 chat / trajectory 并列），点会话头部的"文件"标签进入，非弹窗。

**依赖基础包补丁**：`sidebar.workspaces.tabs` 槽需要工作区浏览器 bundle（`@deepseek-ai/dsh-client-ui-workspace/lib/client.js`）承载——在 `sidebar.workspaces` 注册的 `children` 中声明该子槽、在 `browserInjected` 注入槽的 subscribe/getSnapshot、并在 `WorkspaceBrowser` 头部用 `useSyncExternalStore` 判断 `hasTabs` 后渲染槽替换 sectionLabel。dsh 升级会覆盖该文件，升级后需重打补丁（本机备份参照 `dsh-tools/backup/` 下 `dsh-client-ui-workspace.client.js.bak-*`）。未打补丁时插件自动回退为底栏「文件」按钮。

### 依赖解析（重要）

`@deepseek-ai/*` 包**不能**在插件自己的 `node_modules` 里安装副本：`@Remote` 装饰器标记存在模块级 WeakMap 中，若插件与 api-gateway 各持一份 `dsh-typert-protocol` 实例，标记互不可见（RPC 会 404）。必须让 Node 解析到 dsh 安装目录的同一实例：

```sh
# 本地开发（本机 dsh 通过 npx 安装时）：
ln -s ~/.dsh/profiles/node_modules/@deepseek-ai node_modules/@deepseek-ai
```

`dsh` 启动时会维护 `$DSH_HOME/profiles/node_modules` 的扁平 symlink 回退（`healProfilesModuleFallback`），指向 dsh 安装目录的每个包。生产发布时插件将 `@deepseek-ai/*` 声明为 `peerDependencies`，由 profile 提供。

**桌面端（deepseek-harness-desktop）注意**：

- 桌面端启动时会把 `~/.dsh/profiles/node_modules/@deepseek-ai` 重指向 **Desktop.app 打包目录**（`/Applications/DSH Desktop.app/.../app.asar.unpacked/node_modules`），该目录**裁剪了 `.d.ts`**——保持上面的 symlink 指向 `profiles` 即可保证运行时与桌面端 api-gateway 同一实例（RPC 正常）。
- 但 tsc 构建会因缺类型失败。`tsconfig.json` 用 `paths` 把 `@deepseek-ai/*` 的**编译期类型查找**映射到全局 dsh 安装（有完整 `.d.ts`）；运行时 Node 解析不受影响（仍走 node_modules symlink → profiles → 桌面端实例）。若全局 dsh 路径不同，按 `tsconfig.json` 注释调整。
- **不要在插件目录里跑 `npm install`**：npm 会把 `node_modules/@deepseek-ai` symlink 解引用成真实目录并破坏 profiles 的 symlink 结构，导致 `dsh` 启动报 "exists and is not a symlink"。需要装新依赖时，装完重新执行上面的 `ln -s`。

## 开发

```sh
npm install                       # esbuild + typescript + 类型
node build.mjs                    # 构建 host (tsc) + client bundle (esbuild)
node build.mjs --watch            # watch host (tsc --watch) + client (esbuild)
```

构建产物：

- `dist/index.js` — host 半（Node ESM，tsc 编译以保留标准 stage-3 装饰器；esbuild 会把 `@Remote` 降级为 legacy 形式导致运行时崩溃）
- `dist/client.js` — client 半（`window.__ModuleLoader__.load({id, factory})` 格式，react 等 seed 词 external）

## 调试

```sh
dsh --profile web --dump-config | grep -A4 dsh-explorer-editor   # 确认插件层已组合
# 测试 RPC（需 dsh web 运行中）
curl -X POST http://127.0.0.1:3080/api/fileManager/getRoot \
  -H 'Content-Type: application/json' \
  -d '{"type":"client-request","rpcId":"t","method":"fileManager/getRoot","payload":{"args":{}}}'
```

## 常见问题

- **RPC 返回 not found**：几乎总是 `@deepseek-ai/dsh-typert-protocol` 双实例问题——检查插件 `node_modules/@deepseek-ai` 是否是 symlink（`ls -la node_modules/@deepseek-ai`），不是则按上文建立链接后重启。
- **编辑器空白**：Monaco 从 CDN 加载（jsDelivr → unpkg → Fastly 依次回退，可用 localStorage 键 `dsh-explorer-editor:monaco-mirror` 指定私有镜像），全部不可达时降级为纯文本 textarea。
- **打开的是错误的目录**：确认当前会话的工作区目录正确（侧边栏标题显示目录名）。文件管理器打开时自动 `setRoot` 到当前会话的 `cwd`；若打开前无会话，则回退到 `cordis.patch.yml` 的 `root`。
- **插件改了不生效**：host 半改动需重启 `dsh web`；client 半 bundle 改动后刷新页面即可（rev 变化触发重新加载）。

## License

[MIT](LICENSE)