# dsh-my-plugins
[](README.md)
[](README_en.md)
DeepSeek Harness（DSH）插件管理面板：在「设置 → 插件」页新增「我的插件」标签，集中查看插件版本、启停、GitHub 更新检查与二次确认移除。
[](LICENSE)
[](package.json)
[](https://github.com/deepseek-ai/deepseek-harness)
---
## 📑 目录
- [📸 界面预览](#-界面预览)
- [✨ 功能特性](#-功能特性)
- [🚀 快速开始](#-快速开始)
- [📖 使用说明](#-使用说明)
- [🔧 工作原理](#-工作原理)
- [🧪 开发与测试](#-开发与测试)
- [⚠️ 已知限制](#️-已知限制)
- [🤝 贡献](#-贡献)
- [📄 许可证](#-许可证)
---
## 📸 界面预览
「设置 → 插件 → 我的插件」页：插件卡片列表（含版本、安装来源、配置与 Cordis 状态），my-plugins 卡片已展开显示启停 / 更新 / 移除操作。
---
## ✨ 功能特性
| 功能 | 说明 |
|------|------|
| **「我的插件」标签页** | 在「设置 → 插件」页新增独立标签（`mine`），集中展示用户安装的插件 |
| **插件卡片** | 每个插件一张卡片：名称、版本、介绍、安装来源（GitHub / 本地 / Registry / 手工 patch） |
| **状态展示** | 配置状态（已启用/已停用）与 Cordis 挂载阶段（未挂载 / 等待依赖 / 加载中 / 已挂载 / 挂载失败 / 卸载中） |
| **搜索** | 按插件名称或介绍实时过滤 |
| **启停管理** | 一键禁用 / 启用插件，状态写入 profile 托管的 patch 覆盖块，重启 `dsh web` 后完全生效 |
| **GitHub 更新检查** | 对 GitHub 来源插件检查上游 Release，判断是否可安全更新（版本对比 + Git commit 确认） |
| **立即更新** | 通过官方 `dsh plugin` CLI 更新 GitHub 来源插件；更新前校验 profile 内的本地依赖是否失效（v1.3.6 起），避免更新破坏安装 |
| **二次确认移除** | 移除插件前弹出确认弹窗；通过官方 `dsh plugin remove` 执行，同时清理本插件托管的禁用状态块，重启后完成卸载 |
| **双语言界面** | 中英文界面，跟随 DSH 活动语言 |
---
## 🚀 快速开始
### 前提条件
- 已安装 DSH CLI 与 pnpm（`dsh plugin` 内部转发到 pnpm）
### 安装
```sh
# 方式一：从 GitHub 安装
dsh plugin --profile web add github:Ycet/dsh-my-plugins
# 方式二：从本地源码安装（开发）
dsh plugin --profile web add dsh-my-plugins@file:
```
包声明了 `dsh.bundle` 补丁层，`dsh plugin` 会自动把加载项合入 profile 的 bundle 层，无需手动编辑 `cordis.patch.yml`。
> [!NOTE]
> `file:` 安装是快照：更新源码后需重新执行安装命令，再重启 `dsh web` 生效（bundle 层变更不热加载）。
### 启动
1. 重启网页应用：`dsh web`
2. 打开 http://127.0.0.1:3080，进入「设置 → 插件」
3. 切换到「我的插件」标签查看全部用户安装的插件
---
## 📖 使用说明
1. 打开「设置 → 插件 → 我的插件」；
2. **搜索**：在顶部输入框按名称或介绍过滤插件；
3. **启停**：点击卡片上的「禁用插件 / 启用插件」，按提示重启 `dsh web` 后生效；
4. **更新**（GitHub 来源）：点击「检查更新」查看上游是否有新版本；有更新时点击「立即更新」，完成后重启 `dsh web` 生效；
5. **移除**：点击「移除插件」，在二次确认弹窗中点击「确认移除」，重启 `dsh web` 后完成卸载。
> [!NOTE]
> 更新与移除均通过官方 `dsh plugin` CLI 执行；操作完成提示出现在页面右下角 toast 中，之后需在终端重启 `dsh web` 使改动完全生效。
---
## 🔧 工作原理
双面插件（宿主 + 浏览器）。宿主在 `webServer` 注册 `/my-plugins/api` 前缀路由（仅接受同源信任请求的 `POST`，按路径段分发方法）：
| 方法 | 路径 | 用途 |
| --- | --- | --- |
| `POST` | `/my-plugins/api/list` | 返回全部插件卡片（版本、来源、配置状态、Cordis 挂载阶段、可执行操作） |
| `POST` | `/my-plugins/api/toggle` | 禁用 / 启用插件（写入 profile `cordis.patch.yml` 的托管状态块） |
| `POST` | `/my-plugins/api/check-update` | 检查 GitHub 上游 Release 与版本对比 |
| `POST` | `/my-plugins/api/update` | 通过 `dsh plugin` 更新 GitHub 来源插件 |
| `POST` | `/my-plugins/api/remove` | 通过 `dsh plugin remove` 移除插件并清理托管状态 |
关键机制：
- **托管状态块**：启停覆盖写入 profile 的 `cordis.patch.yml`，用 `# >>> dsh-my-plugins managed states >>>` 标记边界，由宿主维护，避免与手工补丁混淆；
- **来源判定**：根据包元数据识别 GitHub（`git+https://github.com/…` 等）、本地（`file:` 路径）、Registry（npm 版本规格）与手工 patch 四种来源，并据此决定是否支持自动更新；
- **更新安全性**：`check-update` 做版本语义比较并确认已安装 commit；`update` 前校验 profile 内被引用的本地安装包是否失效（v1.3.6 起），存在失效依赖时拒绝更新并提示先修复安装来源；
- **移除清理**：`remove` 成功后同步清理该插件入口对应的托管禁用状态，保持 profile 补丁文件整洁。
---
## 🧪 开发与测试
```bash
npm test # node --test test/*.test.mjs
```
`test/metadata.test.mjs` 覆盖纯函数契约：包根解析（`packageRootOf`）、来源判定（`sourceOf`）、GitHub 元数据与版本比较（`githubRepoOf` / `compareVersions`）、patch 插入块扫描（`scanPatchInsertIds`）、托管状态读写（`readManagedStates` / `writeManagedStates`）、更新参数构造（`updateArgsFor`）与失效本地依赖检测（`missingLocalDependency`）。
---
## ⚠️ 已知限制
- **自动更新仅限 GitHub 来源**：Registry、本地安装与手工 patch 来源不支持自动更新，卡片会显示对应原因（`upstreamAhead` 表示 GitHub 上游已有新 Release，但当前 npm 安装源尚未发布可安装更新）。
- **固定引用无法跟踪**：插件固定在 tag 或 commit 时无法检查分支更新；无法确认已安装 Git commit 时不会安全判断更新。
- **操作需重启生效**：启停、更新与移除均在重启 `dsh web` 后完全生效（bundle 层不热加载）。
- **移除即卸载**：移除操作从当前 profile 删除插件依赖，属于不可逆操作，请谨慎使用。
---
## 🤝 贡献
欢迎提交 Issue 与 Pull Request：发现问题请携带 DSH 版本、插件版本与复现步骤到 [Issues](https://github.com/Ycet/dsh-my-plugins/issues) 反馈；改进请按 Fork → 分支 → PR 流程提交，并在提交前运行 `npm test` 确保契约测试通过。
---
## 📄 许可证
本项目使用 [MIT](LICENSE) 许可证。