dsh-github-flow 0.1.6 → 0.1.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.en.md +200 -67
- package/README.md +199 -65
- package/docs/architecture.md +66 -15
- package/docs/images/1.png +0 -0
- package/docs/images/2.png +0 -0
- package/docs/images/3.png +0 -0
- package/lib/api/routes.d.ts +3 -1
- package/lib/api/routes.js +208 -13
- package/lib/client/panel.js +28 -1
- package/lib/client.js +1002 -43
- package/lib/commands/gh.d.ts +2 -1
- package/lib/commands/gh.js +40 -3
- package/lib/executor.d.ts +6 -5
- package/lib/executor.js +42 -15
- package/lib/main.d.ts +11 -0
- package/lib/main.js +41 -3
- package/lib/tools/api.js +2 -1
- package/lib/tools/issue.js +13 -8
- package/lib/tools/pr.js +14 -9
- package/lib/tools/repo.js +6 -4
- package/lib/tools/run.js +12 -7
- package/lib/types.d.ts +87 -9
- package/lib/updater.d.ts +41 -0
- package/lib/updater.js +160 -0
- package/lib/upgrade-manager.d.ts +54 -0
- package/lib/upgrade-manager.js +299 -0
- package/lib/version.d.ts +13 -0
- package/lib/version.js +13 -0
- package/lib/workspace.d.ts +6 -3
- package/lib/workspace.js +24 -9
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -5,11 +5,12 @@
|
|
|
5
5
|
<a href="https://www.npmjs.com/package/dsh-github-flow"><img src="https://img.shields.io/npm/dm/dsh-github-flow.svg?style=flat-square&color=2ea043" alt="npm downloads" /></a>
|
|
6
6
|
<a href="./LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square" alt="license" /></a>
|
|
7
7
|
<a href="https://deepseek-harness.github.io/deepseek-harness/"><img src="https://img.shields.io/badge/Cordis-Compatible-8957e5.svg?style=flat-square" alt="Cordis" /></a>
|
|
8
|
+
<img src="https://img.shields.io/badge/Platform-macOS%20%7C%20Windows%20%7C%20Linux-informational.svg?style=flat-square" alt="Platform" />
|
|
8
9
|
</p>
|
|
9
10
|
|
|
10
11
|
<p align="center">
|
|
11
|
-
<b
|
|
12
|
-
|
|
12
|
+
<b>让 DeepSeek Harness Agent 拥有操作 GitHub 的原生手和脚,为人机协作打造沉浸式 GitHub 工作台。</b><br>
|
|
13
|
+
原生复用宿主机 <code>gh</code> CLI 安全登录凭据,告别 Personal Access Token 泄露;深度打通本地 Git 工作区与云端仓库协作,兼具 <b>5 大领域 Agent 核心工具</b>、<b>人类 Slash 快捷指令</b>、<b>Web UI 全景工作台</b> 与 <b>一键自动跨平台无缝升级</b>。
|
|
13
14
|
</p>
|
|
14
15
|
|
|
15
16
|
<p align="center">
|
|
@@ -18,133 +19,266 @@
|
|
|
18
19
|
|
|
19
20
|
---
|
|
20
21
|
|
|
21
|
-
##
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
22
|
+
## 🎯 为什么需要 `dsh-github-flow`?
|
|
23
|
+
|
|
24
|
+
在日常使用 AI Agent 辅助编程与工程研发时,开发者经常遭遇以下断层痛点:
|
|
25
|
+
|
|
26
|
+
| 研发协作场景 | 传统方式(痛点重重) | `dsh-github-flow`(原生体验) |
|
|
27
|
+
| :--- | :--- | :--- |
|
|
28
|
+
| **Agent 提 PR & 代码评审** | 用户必须手动在网页复制分支、点开 GitHub 网页点鼠标提交 PR,无法实现自主研发闭环。 | **Agent 原生提单与评审**:对 Agent 说“帮我把当前分支提个 PR”,Agent 调用 `github_pr` 自动完成提交与代码 diff 审查。 |
|
|
29
|
+
| **CI / Actions 构建报错修复** | 构建挂了后,开发者在网页翻几十页 Actions 日志,复制报错贴给 Agent 调试。 | **精准抓取报错**:对 Agent 说“看下 CI 为什么失败”,Agent 调 `github_run(log_failed)` 秒级定位失败步骤并自动修复代码。 |
|
|
30
|
+
| **安全性与鉴权维护** | 必须在插件配置文件里贴明文 GitHub Token(PAT),面临权限失控与密钥泄漏风险。 | **0 密钥泄露风险**:直接复用机器本地已认证的 `gh auth login` 凭据,使用系统安全 Keyring。 |
|
|
31
|
+
| **多任务切屏困扰** | 必须在 VS Code、浏览器 GitHub 标签页和 DSH 聊天窗之间反复切屏,上下文频繁丢失。 | **内置沉浸式全景工作台**:DSH 内部常驻 PR 门禁、CI 流水线、三维待办 Issue 矩阵,一目了然。 |
|
|
32
|
+
| **首屏加载与性能等待** | 每次打开全景驾驶舱全屏白屏卡死转圈 8~15 秒,等待所有网络与子进程请求返回。 | **SWR 0ms 瞬间秒开**:打开立即呈现本地持久化快照,后台静默重验;提供专属设置面板自主调节拉取间隔与纯手动模式。 |
|
|
33
|
+
| **插件维护与升级** | 插件更新全靠开发者去 npm 碰运气看版本号,命令复杂不敢升。 | **闲时静默探测 + Web 一键自动升级**:双源极速探测,自动适配 Mac/Windows 跨平台命令,界面点击即升。 |
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
## 🤖 核心工具集 (Agent Tools):给 Agent 装上 GitHub 的手和脚
|
|
38
|
+
|
|
39
|
+
本插件精选聚合为 **5 大领域核心工具**,拒绝几十个无用微型工具撑爆 Agent 上下文,原生搭载 **Token 防溢出保护(默认 24KB 智能二分截断)** 与 **零参数 CWD 智能绑定**。
|
|
40
|
+
|
|
41
|
+
### 1. `github_pr`:PR 全生命周期管理与自动化代码审查
|
|
42
|
+
> **典型对话指令**:
|
|
43
|
+
> - *"帮我检查当前仓库有没有需要我审查的 PR?"*
|
|
44
|
+
> - *"帮我把当前特性分支创建一个 PR,标题叫 'feat: add dark mode',附带简明改动说明"*
|
|
45
|
+
> - *"审查 PR #12 的代码差异并给出安全重构建议"*
|
|
46
|
+
> - *"检查 PR #8 的 CI 检查通过了吗?通过的话帮我 Squash 合并并删除源分支"*
|
|
47
|
+
|
|
48
|
+
* **支持操作 (`action`)**:
|
|
49
|
+
* `list`:列出当前仓库开放的 PR(带作者、审查判定、CI 门禁状态);
|
|
50
|
+
* `view`:查看指定 PR 详情、描述与元数据;
|
|
51
|
+
* `diff`:获取 PR 的完整代码差异(内置智能防溢出截断保护);
|
|
52
|
+
* `checks`:审查指定 PR 的 CI 门禁状态与检查套件结果;
|
|
53
|
+
* `create`:一键自动创建 PR(支持 draft 草稿模式与 `--dry-run` 预演);
|
|
54
|
+
* `review`:提交代码审查意见(`APPROVE`, `REQUEST_CHANGES`, `COMMENT`);
|
|
55
|
+
* `merge`:自动执行合并(支持 `squash` / `merge` / `rebase`,可指定 `delete_branch`)。
|
|
56
|
+
|
|
57
|
+
---
|
|
58
|
+
|
|
59
|
+
### 2. `github_run`:CI 流水线排查与失败定位神器(Agent 自动修 Bug 核心)
|
|
60
|
+
> **典型对话指令**:
|
|
61
|
+
> - *"最近一次 Actions 工作流为什么挂了?提取失败步骤日志并帮我修复"*
|
|
62
|
+
> - *"看一下当前仓库最近 5 次 CI 构建的状态"*
|
|
63
|
+
> - *"重新运行刚才失败的工作流"*
|
|
64
|
+
|
|
65
|
+
* **支持操作 (`action`)**:
|
|
66
|
+
* `log_failed`(🔥 **核心杀手锏**):**专供 Agent 快速诊断**,自动抓取并剥离无关日志,精准提取失败 Step 的关键错误堆栈,供 Agent 直击问题修复代码;
|
|
67
|
+
* `list`:查看当前仓库的 Workflow 运行历史与结论;
|
|
68
|
+
* `view`:查看指定 run_id 的详细阶段(Jobs & Steps);
|
|
69
|
+
* `rerun`:重新触发失败的 CI 运行;
|
|
70
|
+
* `cancel`:取消在途的工作流。
|
|
71
|
+
|
|
72
|
+
---
|
|
73
|
+
|
|
74
|
+
### 3. `github_issue`:缺陷跟踪与待办任务闭环
|
|
75
|
+
> **典型对话指令**:
|
|
76
|
+
> - *"把刚才复现的内存泄漏 Bug 提一个 Issue,打上 'bug' 和 'backend' 标签"*
|
|
77
|
+
> - *"查看指派给我的所有待办 Issue"*
|
|
78
|
+
> - *"给 Issue #45 追加评论:'已经在 master 分支修复,等待发版验证'"*
|
|
79
|
+
> - *"把 Issue #45 关闭"*
|
|
80
|
+
|
|
81
|
+
* **支持操作 (`action`)**:
|
|
82
|
+
* `list`:多条件检索 Issue 列表;
|
|
83
|
+
* `view`:查看 Issue 正文与评论历史;
|
|
84
|
+
* `create`:创建新 Issue(支持标题、正文、标签、指派人);
|
|
85
|
+
* `comment`:在指定 Issue 中追加排查进展或评论;
|
|
86
|
+
* `close` / `reopen`:开启或关闭 Issue。
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
|
|
90
|
+
### 4. `github_repo`:仓库探索与跨代码库检索
|
|
91
|
+
> **典型对话指令**:
|
|
92
|
+
> - *"在当前关联的 GitHub 仓库里搜索使用到 'createPrTool' 的代码行"*
|
|
93
|
+
> - *"在 GitHub 上检索关于 'dsh-plugin' 的优秀开源项目"*
|
|
94
|
+
> - *"查看仓库 cli/cli 的基本信息与星标数"*
|
|
95
|
+
|
|
96
|
+
* **支持操作 (`action`)**:
|
|
97
|
+
* `view`:查看当前或目标仓库的元数据(默认分支、星标、描述、Visibility);
|
|
98
|
+
* `search_code`:跨仓库或当前仓库检索特定代码符号;
|
|
99
|
+
* `search_repos`:跨全站检索 GitHub 开源仓库。
|
|
100
|
+
|
|
101
|
+
---
|
|
102
|
+
|
|
103
|
+
### 5. `github_api`:底层的灵活“逃生门”
|
|
104
|
+
> **典型对话指令**:
|
|
105
|
+
> - *"调用 GitHub API 获取当前仓库最新的 Release 列表,用 jq 提取 tag 名称"*
|
|
106
|
+
|
|
107
|
+
* **核心优势**:直接复用本地认证环境调用任意 REST / GraphQL API,支持 `--jq` 预过滤与 `raw` 原始响应模式,绝不因插件未封装特定接口而受限。
|
|
44
108
|
|
|
45
109
|
---
|
|
46
110
|
|
|
47
|
-
##
|
|
111
|
+
## 🖥️ 原生 Web UI 沉浸式工作台与同步设置
|
|
48
112
|
|
|
49
|
-
### 全局全景驾驶舱 (Global Cockpit)
|
|
50
|
-
|
|
113
|
+
### 1. 全局全景驾驶舱 (Global Cockpit)
|
|
114
|
+
|
|
115
|
+
点击 DSH 左侧主导航的 GitHub 图标进入:
|
|
116
|
+
* **⚡ 0ms 瞬间秒开直出 (SWR 本地持久化缓存)**:利用客户端本地持久化快照,告别每次进入转圈等待 8~15 秒的烦躁感,打开瞬间完整渲染全部卡片与列表;
|
|
117
|
+
* **📦 实时数据新鲜度胶囊**:标题栏旁直观展示数据状态(`[📦 本地快照 (21分钟前)]` ➔ `[⏳ 后台同步中...]` ➔ `[✅ 已是最新 (15:30)]` ➔ `[⚠️ 同步超时已保留缓存]`);
|
|
118
|
+
* **账号全景概览**:实时透视名下所有 GitHub 仓库、默认分支与 Star 状态;
|
|
119
|
+
* **本地工作区联动矩阵**:自动探测本机所有打开的项目,显示当前工作区与远程 GitHub 仓库的关联状态;
|
|
120
|
+
* **三维待办 Issue 矩阵**:智能划分「📥 用户提单(反馈到我名下仓库)」、「🎯 指派待办(分配给我)」与「✍️ 我发起的」,支持一键药丸过滤;
|
|
121
|
+
* **升级提示横幅**:检测到新版本时在顶部优雅滑出,提供一键自动升级与更新日志直达。
|
|
51
122
|
|
|
52
123
|
<p align="center">
|
|
53
124
|
<img src="./docs/images/1.png" alt="GitHub 全景驾驶舱" width="100%" />
|
|
54
125
|
</p>
|
|
55
126
|
|
|
56
|
-
### 会话右侧栏工作区面板 (Session Workspace Panel)
|
|
57
|
-
|
|
127
|
+
### 2. 会话右侧栏工作区面板 (Session Workspace Panel)
|
|
128
|
+
位于每个对话工作区的右侧抽屉栏:
|
|
129
|
+
* **当前仓库上下文绑定**:自动锁定当前会话的 Git 仓库,无需选择;
|
|
130
|
+
* **数据新鲜度胶囊对齐**:标题旁紧凑呈现 `[📦 本地快照 (2分钟前)]` 与 `[🔄 刷新]` 按钮,与主页规则 100% 保持一致,首屏 0ms 瞬间直出;
|
|
131
|
+
* **PR 门禁状态药丸**:展示当前开放 PR,悬停查看 Checks 结果与审核意见;
|
|
132
|
+
* **当前仓库 Open Issues 列表**:直接在侧边栏审查待办任务并提供直达链接;
|
|
133
|
+
* **最新 Actions 构建流水线**:实时关注 CI 状态;
|
|
134
|
+
* **快捷操作网格**:一键在浏览器打开仓库、直达 Issues/PRs、一键创建 PR。
|
|
58
135
|
|
|
59
136
|
<p align="center">
|
|
60
137
|
<img src="./docs/images/2.png" alt="右侧栏工作区面板" width="100%" />
|
|
61
138
|
</p>
|
|
62
139
|
|
|
140
|
+
### 3. 数据同步与缓存偏好设置 (Sync Settings Modal)
|
|
141
|
+
点击全景驾驶舱右上角 **`[⚙️ 同步设置]`** 即可随时调优数据拉取节奏:
|
|
142
|
+
* **三种刷新策略随心选**:
|
|
143
|
+
* **⚡ 秒开模式 (SWR, 推荐)**:打开驾驶舱立即展示上次本地缓存(0ms秒开),后台静默同步最新状态;
|
|
144
|
+
* **📋 仅在手动点击时拉取 (Manual Only)**:打开只浏览本地缓存,绝不自动触发后台 gh 进程,最省电、最省资源;
|
|
145
|
+
* **⏱️ 定时自动轮询 (Auto Poll)**:驾驶舱打开期间,按照设定间隔在后台自动轮询。
|
|
146
|
+
* **自定义后台拉取间隔**:支持选择 1 分钟 / 5 分钟 (默认) / 15 分钟 / 30 分钟 (推荐节能) / 1 小时 / 从不自动刷新;
|
|
147
|
+
* **本地缓存可视化管理**:透明查看本地快照体积与保存时间戳,支持一键 `[🗑️ 清空缓存]` 重置。
|
|
148
|
+
|
|
149
|
+
<p align="center">
|
|
150
|
+
<img src="./docs/images/3.png" alt="数据同步与缓存设置弹窗" width="85%" />
|
|
151
|
+
</p>
|
|
152
|
+
|
|
63
153
|
---
|
|
64
154
|
|
|
65
155
|
## 🚀 安装指南
|
|
66
156
|
|
|
67
|
-
|
|
157
|
+
### 步骤 1:前置准备(若已安装可跳过)
|
|
158
|
+
确保你的机器上已安装 GitHub CLI (`gh`) 并已登录:
|
|
159
|
+
```bash
|
|
160
|
+
# Windows 安装
|
|
161
|
+
winget install --id GitHub.cli
|
|
162
|
+
|
|
163
|
+
# macOS 安装
|
|
164
|
+
brew install gh
|
|
165
|
+
|
|
166
|
+
# 登录认证(仅需执行一次)
|
|
167
|
+
gh auth login
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
### 步骤 2:安装插件到 DSH
|
|
171
|
+
|
|
172
|
+
在 DSH 终端根据你的使用环境执行对应命令:
|
|
68
173
|
|
|
69
174
|
```bash
|
|
70
|
-
#
|
|
175
|
+
# 场景 A:DSH 桌面版 (Desktop Profile)
|
|
71
176
|
dsh plugin --profile desktop add dsh-github-flow
|
|
72
177
|
|
|
73
|
-
#
|
|
74
|
-
dsh plugin
|
|
178
|
+
# 场景 B:DSH Web / CLI 工程环境
|
|
179
|
+
pnpm dsh plugin add dsh-github-flow
|
|
75
180
|
```
|
|
76
181
|
|
|
77
182
|
---
|
|
78
183
|
|
|
79
|
-
##
|
|
184
|
+
## ⚡ 智能升级与版本检查机制
|
|
185
|
+
|
|
186
|
+
再也不用担心错过新功能!`dsh-github-flow` 内置了工业级的版本管理机制:
|
|
187
|
+
|
|
188
|
+
1. **业务优先,闲时静默后置**:
|
|
189
|
+
- 打开 Web 界面时,**核心 PR / Issue 数据 100% 毫秒级优先拉取渲染**;
|
|
190
|
+
- 在所有业务数据渲染就绪后,前端延迟 1.5 秒利用空闲时间发起后台探针,**对主业务 0 阻塞、0 抢占**。
|
|
191
|
+
2. **国内双源智能加速**:
|
|
192
|
+
- 默认第一顺位走 **阿里云/淘宝 npm 镜像**(国内延迟仅 50~150ms),超时自动无缝回退官方 npmjs 兜底。
|
|
193
|
+
3. **跨平台一键自动升级**:
|
|
194
|
+
- **界面直升**:在全景驾驶舱或右侧栏点击 **`[⚡ 一键自动升级]`**,插件在后台安全执行拉取;
|
|
195
|
+
- **智能适配**:自动识别 macOS、Windows 与桌面版 Profile,Mac 环境下自动补全 Homebrew 环境变量;
|
|
196
|
+
- **源码保护防线**:检测到本地 Git 源码软链接模式(`link:`)时自动阻止覆盖,防止破坏开发工作区;
|
|
197
|
+
- **成功自愈提示**:升级成功后明确提醒重启 DSH 服务以激活后端新工具,也可点击按钮立即刷新页面预览新界面。
|
|
198
|
+
|
|
199
|
+
---
|
|
200
|
+
|
|
201
|
+
## ⏱️ SWR 秒开缓存与数据拉取节奏控制
|
|
202
|
+
|
|
203
|
+
为什么以前打开全景驾驶舱需要等待好几秒?因为全景数据要并发调用十余次 `gh` 进程扫描多个仓库与工作区。本插件引入了 **Stale-While-Revalidate (SWR)** 缓存体系,并把控制权完全交还给用户:
|
|
204
|
+
|
|
205
|
+
```
|
|
206
|
+
首次渲染 (0ms) ──────────> 恢复本地持久化快照,瞬间完整上屏
|
|
207
|
+
│
|
|
208
|
+
├── SWR 模式: 延迟 300ms 后台静默拉取,平滑对齐最新数据
|
|
209
|
+
├── 手动模式: 仅浏览本地快照,点击「🔄 刷新」才发起拉取
|
|
210
|
+
└── 轮询模式: 按设定间隔 (如 5m/30m) 自动后台轮询
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
### 三种刷新策略对比与选用建议:
|
|
80
214
|
|
|
81
|
-
|
|
|
82
|
-
|
|
83
|
-
|
|
|
84
|
-
|
|
|
85
|
-
|
|
|
86
|
-
|
|
87
|
-
|
|
215
|
+
| 刷新模式 | 运行机制 | 适用人群与场景 |
|
|
216
|
+
| :--- | :--- | :--- |
|
|
217
|
+
| **⚡ 秒开模式 (SWR, 默认)** | 打开驾驶舱 **0ms 立即呈现** 上次保存的本地离线快照,随后后台静默更新。 | **强烈推荐所有开发者**。消灭白屏转圈,体验最顺畅丝滑。 |
|
|
218
|
+
| **📋 仅手动刷新 (Manual Only)** | 仅浏览本地已有数据,绝对不自动发起任何后台 `gh` 网络拉取。 | **笔记本电池供电、低配设备或弱网环境**。极致节能,杜绝无谓后台开销。 |
|
|
219
|
+
| **⏱️ 定时自动轮询 (Auto Poll)** | 打开驾驶舱后,按照选定的时间间隔(1m~1h)在后台自动轮询。 | **维护者工作站、实时监控大屏**。始终保持第一手待办同步。 |
|
|
220
|
+
|
|
221
|
+
* **离线韧性保障 (Fail-Safe)**:即使完全断网或后台请求超时,**界面依然完整保留本地快照供您浏览与检索,绝不发生白屏或红字崩溃报错!**
|
|
88
222
|
|
|
89
223
|
---
|
|
90
224
|
|
|
91
|
-
## 💬 人类 Slash
|
|
225
|
+
## 💬 人类 Slash 指令速查
|
|
226
|
+
|
|
227
|
+
在 DSH 任意聊天窗口输入:
|
|
92
228
|
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
229
|
+
* `/gh status`:一键诊断当前 GitHub CLI 账号认证状态、作用域、当前工作区关联仓库及插件版本;
|
|
230
|
+
* `/gh upgrade`:主动检测 npm 最新版本,自适应输出当前操作系统(macOS / Windows / Linux)的最佳升级指引;
|
|
231
|
+
* `/gh help`:查看帮助说明与 Agent 典型对话范例。
|
|
96
232
|
|
|
97
233
|
---
|
|
98
234
|
|
|
99
|
-
## ⚙️
|
|
235
|
+
## ⚙️ 配置项说明 (`cordis.patch.yml`)
|
|
100
236
|
|
|
101
|
-
|
|
237
|
+
插件具备开箱即用的默认行为,也可在 `cordis.patch.yml` 或 Profile 中按需调优:
|
|
102
238
|
|
|
103
239
|
```yaml
|
|
104
240
|
- insert:
|
|
105
241
|
- id: github-flow
|
|
106
242
|
name: dsh-github-flow
|
|
107
243
|
config:
|
|
108
|
-
ghPath: 'gh' # GitHub CLI
|
|
109
|
-
defaultTimeoutMs: 30000 #
|
|
110
|
-
maxOutputChars: 24000 #
|
|
111
|
-
maxOutputBytes: 96000 #
|
|
112
|
-
cacheTtlMs: 15000 #
|
|
113
|
-
|
|
244
|
+
ghPath: 'gh' # GitHub CLI 可执行程序路径(内网特定环境可指定绝对路径)
|
|
245
|
+
defaultTimeoutMs: 30000 # 命令执行超时时间(毫秒,默认 30 秒)
|
|
246
|
+
maxOutputChars: 24000 # 单次命令安全返回字符数上限(Token 防溢出保护)
|
|
247
|
+
maxOutputBytes: 96000 # 单次命令 UTF-8 字节数硬上限,默认 maxOutputChars × 4
|
|
248
|
+
cacheTtlMs: 15000 # 单仓库概览缓存时长(毫秒,默认 15 秒)
|
|
249
|
+
checkUpdate: true # 是否开启新版本自动检查提示(默认开启)
|
|
250
|
+
updateCheckIntervalMs: 86400000 # 检查更新间隔(毫秒,默认 24 小时)
|
|
251
|
+
registryUrl: '' # 自定义私有 npm 镜像地址(留空则自动选用 npmmirror 与 npmjs)
|
|
114
252
|
```
|
|
115
253
|
|
|
116
|
-
> 关于 Web 面板的刷新节奏:全局驾驶舱每次刷新要执行十余次 `gh`(本机实测 8-13 秒),
|
|
117
|
-
> 因此它按 5 分钟缓存,并在你点击「🔄 刷新全局数据」时强制重取。
|
|
118
|
-
> 工作区矩阵只读取本地 `.git/config` 识别仓库归属,不发起网络请求。
|
|
119
|
-
> `/gh status` 命令始终绕过认证缓存,保证你 `gh auth login` 后立刻能看到真实状态。
|
|
120
|
-
|
|
121
254
|
---
|
|
122
255
|
|
|
123
256
|
## 🔌 生态服务扩展 (Cordis Service)
|
|
124
257
|
|
|
125
|
-
|
|
258
|
+
本插件提供标准 Cordis 原生服务 `ctx.github`。其他 DSH 插件只需声明依赖即可复用:
|
|
126
259
|
|
|
127
|
-
```
|
|
260
|
+
```typescript
|
|
128
261
|
import type { Context } from '@deepseek-ai/cordis';
|
|
129
262
|
|
|
130
263
|
export const inject = ['github'];
|
|
131
264
|
|
|
132
265
|
export function apply(ctx: Context) {
|
|
133
|
-
//
|
|
266
|
+
// 直接调用经过安全包装的底层执行引擎
|
|
134
267
|
const auth = await ctx.github.checkAuth();
|
|
135
268
|
const repo = await ctx.github.getRepoMetadata();
|
|
269
|
+
const prs = await ctx.github.run(['pr', 'list', '--json', 'number,title']);
|
|
136
270
|
}
|
|
137
271
|
```
|
|
138
272
|
|
|
139
273
|
---
|
|
140
274
|
|
|
141
|
-
## 📚
|
|
275
|
+
## 📚 相关开发文档
|
|
142
276
|
|
|
143
|
-
- [npm
|
|
277
|
+
- [npm 发布与自动化 CI 发版指南](./docs/npm-publish-guide.md)
|
|
144
278
|
- [架构设计与技术规范](./docs/architecture.md)
|
|
145
279
|
|
|
146
280
|
---
|
|
147
281
|
|
|
148
282
|
## 📄 开源协议 (License)
|
|
149
283
|
|
|
150
|
-
本项目基于 [MIT License](./LICENSE)
|
|
284
|
+
本项目基于 [MIT License](./LICENSE) 协议完全开源。欢迎提交 PR 与 Issue!
|
package/docs/architecture.md
CHANGED
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
│ │
|
|
13
13
|
│ ┌────────────────────────┐ ┌──────────────────────────┐ │
|
|
14
14
|
│ │ Cordis Context (ctx) │ │ PluginConfig │ │
|
|
15
|
-
│ │
|
|
15
|
+
│ │ - inject: tools, cmd │ │(Schemastery 运行时校验) │ │
|
|
16
16
|
│ └───────────┬────────────┘ └─────────────┬────────────┘ │
|
|
17
17
|
│ │ │ │
|
|
18
18
|
│ ▼ ▼ │
|
|
@@ -20,18 +20,23 @@
|
|
|
20
20
|
│ │ GitHubService (ctx.github 原生服务) │ │
|
|
21
21
|
│ │ - checkAuth(cwd) - getRepoMetadata(cwd) │ │
|
|
22
22
|
│ │ - run<T>(args, opts) [execFile 数组隔离 + 24KB 智能截断] │ │
|
|
23
|
+
│ │ │ │
|
|
24
|
+
│ │ - UpdateChecker (双源极速探测 + 24h 缓存 + Fail-Safe) │ │
|
|
25
|
+
│ │ - UpgradeManager (跨平台自适应 + 互斥锁 + macOS PATH 补全) │ │
|
|
23
26
|
│ └──────┬───────────────────────┬────────────────────────┬──────┘ │
|
|
24
27
|
│ │ │ │ │
|
|
25
28
|
│ ▼ ▼ ▼ │
|
|
26
29
|
│ ┌──────────────────┐ ┌──────────────────┐ ┌───────────────────────┐ │
|
|
27
30
|
│ │ 5 大 Agent 工具 │ │ 人类 Slash 指令 │ │ Host HTTP WebServer │ │
|
|
28
|
-
│ │ (defineTool DSL)│ │ /gh status
|
|
29
|
-
│ │ - pr │
|
|
30
|
-
│ │ - issue │
|
|
31
|
-
│ │ - run │
|
|
32
|
-
│ │ - repo │
|
|
33
|
-
│ │ - api (逃生门) │
|
|
34
|
-
│ └──────────────────┘
|
|
31
|
+
│ │ (defineTool DSL)│ │ /gh status │ │ (Effect Disposer 清理)│ │
|
|
32
|
+
│ │ - pr │ │ /gh upgrade │ │ - /api/github/overview│ │
|
|
33
|
+
│ │ - issue │ │ /gh help │ │ - /api/github/action │ │
|
|
34
|
+
│ │ - run │ └──────────────────┘ │ - /api/github/refresh │ │
|
|
35
|
+
│ │ - repo │ │ - /check-update (闲时)│ │
|
|
36
|
+
│ │ - api (逃生门) │ │ - /upgrade (一键自动) │ │
|
|
37
|
+
│ └──────────────────┘ └──────────┬────────────┘ │
|
|
38
|
+
│ │ │
|
|
39
|
+
│ │ HTTP API │
|
|
35
40
|
└─────────────────────────────────────────────────────────────┼───────────────┘
|
|
36
41
|
│
|
|
37
42
|
┌─────────────────────────────────────────────────────────────┼───────────────┐
|
|
@@ -41,7 +46,11 @@
|
|
|
41
46
|
│ │ 全局驾驶舱 (Main Slot) │ │ 右侧栏面板 (Right Sidebar) │ │
|
|
42
47
|
│ │ - 账号全局所有 GitHub 仓库 │ │ - 当前会话工作区关联仓库 │ │
|
|
43
48
|
│ │ - 本地工作区矩阵透视 │ │ - PR 列表与 CI Checks 药丸 │ │
|
|
44
|
-
│ │ -
|
|
49
|
+
│ │ - 三维待办 Issues (药丸筛选) │ │ - 仓库 Open Issues 任务列表│ │
|
|
50
|
+
│ │ - 用户提单 / 分配待办 / 我发起 │ │ - 快捷操作网格 (直达入口) │ │
|
|
51
|
+
│ │ - 顶部升级通知横幅 (Banner) │ │ - 紧凑微型升级指示条 │ │
|
|
52
|
+
│ │ - 动态数据新鲜度胶囊与 SWR 缓存│ │ - 本地快照胶囊 (对齐规则) │ │
|
|
53
|
+
│ │ - 数据同步设置弹窗 (Modal) │ │ │ │
|
|
45
54
|
│ └──────────────────────────────────┘ └─────────────────────────────┘ │
|
|
46
55
|
└─────────────────────────────────────────────────────────────────────────────┘
|
|
47
56
|
```
|
|
@@ -62,20 +71,62 @@
|
|
|
62
71
|
|
|
63
72
|
### 2.3 上下文 Token 保护与防御性输出包装 (Token Budget Guard)
|
|
64
73
|
- 所有的 `gh` 查询原生采用 `--json <fields>` 结构化投影;
|
|
65
|
-
- 对长文本输出(如大型 PR 的完整 `diff`、CI 失败步骤日志)设置安全截断阈值(默认 24KB
|
|
66
|
-
- 所有 Agent
|
|
74
|
+
- 对长文本输出(如大型 PR 的完整 `diff`、CI 失败步骤日志)设置安全截断阈值(默认 24KB),采用码点安全切割与二分查找字节截断,保留头尾关键上下文并添加显式截断标记,杜绝撑爆模型上下文;
|
|
75
|
+
- 所有 Agent 工具的输出统一经过归一化,列表自动打包为 `{ items, count }`,标量打包为 `{ result }`,100% 严丝合缝契合 DSH 工具网关模式约束。
|
|
67
76
|
|
|
68
|
-
### 2.4
|
|
77
|
+
### 2.4 原生浅色/深色主题自适应与快捷操作网格
|
|
69
78
|
- 全面对齐 DSH 官方 DSW 语义设计变量,基于 `body[data-ds-dark-theme]` 驱动无闪烁双模式切换;
|
|
70
|
-
-
|
|
79
|
+
- 右侧栏快捷操作栏彻底废弃失效的阻塞弹窗,全面采用官方直达模式(查看所有 Issues、查看 PRs、Compare / New Issue),享有 100% 官方富文本体验。
|
|
71
80
|
|
|
72
81
|
### 2.5 Cordis 微内核标准规范
|
|
73
|
-
-
|
|
82
|
+
- **按需依赖声明**:显式声明核心必需服务 `['tools', 'commands']`,防止因无头运行环境缺少 `webServer` 或 `workspaceRegistry` 导致插件陷入 `PENDING` 假死状态;
|
|
83
|
+
- **优雅动态探测**:通过 `if (ctx.webServer)` 探测环境,有 Web UI 服务时动态挂载路由,无 Web 环境时无缝降级为纯 CLI 工具;
|
|
74
84
|
- **生命周期 Effect 闭环**:所有 HTTP 路由与命令注册均持有 Disposer 清理函数,插件热重载或重新挂载时自动彻底注销,零内存泄漏;
|
|
75
85
|
- **配置自校验与服务暴露**:基于 Standard Schema 规范实现强类型校验与默认值注入,通过 `ctx.provide('github', executor)` 向生态插件暴露单例服务。
|
|
76
86
|
|
|
77
87
|
### 2.6 三态环境诊断与交互引导状态机 (Setup & Authentication Lifecycle Guard)
|
|
78
88
|
- **三态状态模型 (Three-State Machine)**:将环境就绪判定严格划分为 `NOT_INSTALLED`(未安装 CLI)、`NOT_LOGGED_IN`(已安装未登录)、`AUTHENTICATED`(已认证)三态,彻底消除“把未安装当作未登录”的状态屏蔽隐患;
|
|
79
89
|
- **平台自适应安装策略**:后端探测到 `ENOENT` 时根据 `process.platform` 组装对应平台的安装命令(Windows: `winget`,macOS: `brew`,Linux: `apt/dnf`)与官方安装包地址;
|
|
80
|
-
- **安全辅助与白名单终端唤起**:Web 端提供一键命令复制,后端 `/api/github/action`
|
|
90
|
+
- **安全辅助与白名单终端唤起**:Web 端提供一键命令复制,后端 `/api/github/action` 提供安全白名单唤起接口,避免在前端模拟复杂交互式 PTY 的脆弱性;
|
|
81
91
|
- **焦点感知自愈 (Focus Auto-Recovery)**:前端挂载 `window.focus` 事件监听,用户在外部浏览器或终端完成认证后切回 DSH 界面,自动静默重新探测并无缝更新 UI,实现零摩擦闭环体验。
|
|
92
|
+
|
|
93
|
+
### 2.7 多维 Issue 身份判定与并发聚合引擎 (Multi-Dimensional Issue Engine)
|
|
94
|
+
- **多重身份决策矩阵**:基于当前登录用户 `currentUser`(`auth.user`)对 Issue 执行身份归类:
|
|
95
|
+
- `reported`(用户提单):`repoOwner === currentUser && author != currentUser`(外部访客在本人维护的仓库中提出的反馈);
|
|
96
|
+
- `assigned`(分配待办):`assignees.includes(currentUser)`(指派给本人的任务,跨仓库通用);
|
|
97
|
+
- `created`(我发起的):`author === currentUser`(本人亲自创建的 Issue)。
|
|
98
|
+
- **三路并发搜索与 URL 去重**:后端在 `/api/github/global-overview` 中通过 `Promise.all` 同时发起 `--owner=@me`、`--assignee=@me`、`--author=@me` 检索,按 URL 唯一性合并去重并按最后更新时间统一降序排列;
|
|
99
|
+
- **双端视图无缝打标**:驾驶舱提供四态响应式药丸筛选(全部/用户提单/指派待办/我发起的),右侧栏直接常驻展现当前工作区所属 Issue 任务清单与状态徽章。
|
|
100
|
+
|
|
101
|
+
### 2.8 智能版本检测与跨平台一键升级引擎 (Update & Upgrade Engine)
|
|
102
|
+
- **业务优先与闲时解耦**:
|
|
103
|
+
- 核心业务接口 `/overview` 仅读取内存缓存,耗时 0ms,绝不阻塞首屏;
|
|
104
|
+
- 前端在 gh 数据完全加载就绪后,延迟 1.5 秒通过 `requestIdleCallback` 触发独立更新探针 `/check-update`,对主流程零干扰。
|
|
105
|
+
- **国内双 Registry 极速容灾**:
|
|
106
|
+
- 默认第一顺位请求国内淘宝镜像 `https://registry.npmmirror.com`(2.5 秒超短超时,50~150ms 响应);
|
|
107
|
+
- 失败时自动静默回退官方 npmjs 兜底,并支持配置私有源;网络故障 100% Fail-Safe 吸收。
|
|
108
|
+
- **跨平台 Shell 调度与 macOS PATH 自愈**:
|
|
109
|
+
- **Windows**:采用 `cmd.exe /d /s /c`,彻底规避 PowerShell 5.1 不支持 `||` 导致的语法崩溃,启动仅 ~10ms;
|
|
110
|
+
- **macOS / Linux**:采用用户 Default Shell(`/bin/zsh` 或 `/bin/bash`);
|
|
111
|
+
- **macOS PATH 智能补全**:针对 Mac 桌面端由 GUI (Finder/Dock) 启动不继承 `.zshrc` 的痛点,自动将当前 Node 目录、Apple Silicon `/opt/homebrew/bin` 及 Intel `/usr/local/bin` 动态注入 PATH 前端,确保 100% 发现 npm/pnpm。
|
|
112
|
+
- **环境自省与源码保护防线 (Dev-Link Safe)**:
|
|
113
|
+
- 自动识别当前是否处于本地 Git 源码软链接模式(`link:`),若是则自动阻止 npm 覆盖,保护工作区源码;
|
|
114
|
+
- 自动识别桌面版 Profile 目录,无全局 CLI 时直接在 `~/.dsh/profiles/desktop` 下就地更新,无需用户具备终端知识。
|
|
115
|
+
- **并发互斥锁与重启提示闭环**:
|
|
116
|
+
- 内存互斥锁防止连续点击导致包管理器 lockfile 竞争;
|
|
117
|
+
- 升级完成后明确提醒用户重启 DSH 服务以完全加载最新后端模块,同时支持立即刷新页面预览新界面。
|
|
118
|
+
|
|
119
|
+
### 2.9 客户端持久化与 SWR (Stale-While-Revalidate) 极速直出架构
|
|
120
|
+
- **0ms 首屏瞬间直出机制**:
|
|
121
|
+
- 在全景驾驶舱组件挂载时,`data` 初始值直接通过 `React.useMemo` 从 `localStorage` 读取上一次保存的历史快照;
|
|
122
|
+
- 消除传统加载时全屏阻塞卡顿,彻底抹平每次打开等待 8~15 秒的痛点,达到即开即用的丝滑体感。
|
|
123
|
+
- **透明数据新鲜度与状态胶囊 (SyncStatusBadge)**:
|
|
124
|
+
- 胶囊状态精准映射:`[⏳ 后台同步中...]`、`[✅ 已是最新 (15:30)]`、`[📦 本地快照 (X分钟前)]`、`[⚠️ 同步超时已保留缓存]`;
|
|
125
|
+
- 支持人性化相对时间推导(刚刚、X分钟前、X小时前、X天前),消除用户对数据时效性的疑虑。
|
|
126
|
+
- **全景驾驶舱偏好设置面板 (GlobalSyncSettingsModal)**:
|
|
127
|
+
- **三态刷新模式自主选择**:`⚡ 秒开模式 (SWR, 默认)`、`📋 仅手动刷新 (Manual Only)`、`⏱️ 定时自动轮询 (Auto Poll)`;
|
|
128
|
+
- **自定义后台轮询周期**:提供 1m / 5m / 15m / 30m / 1h 多档位配置;
|
|
129
|
+
- **快照容量透明与一键重置**:展示本地快照体积与保存时间戳,支持一键清空重置。
|
|
130
|
+
- **离线极端容灾保护 (Fail-Safe Offline Guard)**:
|
|
131
|
+
- 后台静默重验若遭遇断网、弱网或进程超时,界面平滑降级,**100% 保持旧数据完整可用**,绝不回退至空白占位或报错中断。
|
|
132
|
+
|
package/docs/images/1.png
CHANGED
|
Binary file
|
package/docs/images/2.png
CHANGED
|
Binary file
|
|
Binary file
|
package/lib/api/routes.d.ts
CHANGED
|
@@ -1,7 +1,9 @@
|
|
|
1
1
|
import type { GhExecutor } from '../executor.js';
|
|
2
|
+
import { UpdateChecker } from '../updater.js';
|
|
3
|
+
import { UpgradeManager } from '../upgrade-manager.js';
|
|
2
4
|
/**
|
|
3
5
|
* 由用户配置推导全局驾驶舱的缓存时长。
|
|
4
6
|
* 抽成导出的纯函数:TTL 的推导规则是测试断言的对象,埋在闭包里就只能靠猜。
|
|
5
7
|
*/
|
|
6
8
|
export declare function globalCacheTtlMs(cacheTtlMs: number): number;
|
|
7
|
-
export declare function registerApiRoutes(ctxOrWebServer: any, executor: GhExecutor, workspaceRegistry?: any, cacheTtlMs?: number): void;
|
|
9
|
+
export declare function registerApiRoutes(ctxOrWebServer: any, executor: GhExecutor, workspaceRegistry?: any, cacheTtlMs?: number, updateChecker?: UpdateChecker, upgradeManager?: UpgradeManager): void;
|