dsh-pluginmarket-plus 0.1.0 → 0.2.1

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.md CHANGED
@@ -1,10 +1,16 @@
1
- # dsh-pluginmarket-plus · 插件市场缓存
1
+ # dsh-pluginmarket-plus · 插件市场增强
2
2
 
3
- 把「插件 → 发现」读取的索引 JSON 缓存到本地磁盘:手动刷新、每几小时自动刷新,并让发现页直接读本地镜像,绕开上游索引超时。
3
+ 给 DSH 的插件页加两个能力:**插件源缓存**(把插件索引 JSON 落到本地磁盘,发现页不再被上游超时拖垮)和**可更新**(集中检查已安装插件的新版本,支持单包、多选与一键更新)。
4
+
5
+ 安装后,插件页(Plugins)会出现两个新 tab:
6
+
7
+ ```
8
+ [已安装] [发现] [插件源缓存] [可更新]
9
+ ```
4
10
 
5
11
  ## 安装
6
12
 
7
- 从 npm(发布后):
13
+ 从 npm:
8
14
 
9
15
  ```sh
10
16
  dsh plugin --profile web add dsh-pluginmarket-plus
@@ -16,43 +22,105 @@ dsh plugin --profile web add dsh-pluginmarket-plus
16
22
  dsh plugin --profile web add github:jiyuchen1/dsh-pluginmarket-plus
17
23
  ```
18
24
 
19
- 安装后重启 `dsh web`(或在桌面应用的插件页安装并重启),然后打开 **设置 → 插件市场缓存**。
25
+ 安装后重启 `dsh web`(或在桌面应用里安装并重启),然后打开 **Plugins → 插件源缓存 / 可更新**。
20
26
 
21
- ## 为什么需要它
27
+ ## 功能一:插件源缓存
28
+
29
+ ### 为什么需要它
22
30
 
23
31
  官方插件市场(`plugin-market` 服务)读取索引时单次抓取限时 **15 秒**、失败不落盘,也不会沿用上一份成功的结果。真实索引很大,实测(2026-11-14,本机直连):
24
32
 
25
33
  | 索引 | 大小 | 插件数 | 抓取耗时 |
26
34
  |---|---|---|---|
27
- | `cdn.dsh.so/market/index.json` | 8.4 MB | 11,141 | ≈ 64 s |
28
- | `api.dshfind.com/market/dsh-index.json` | 4.7 MB | 8,321 | ≈ 34 s |
29
- | `gcore.jsdelivr.net/.../dsh-market-zh` | 0.7 MB | 597 | ≈ 4 s |
35
+ | `https://cdn.dsh.so/market/index.json` | 8.4 MB | 11,141 | ≈ 64 s |
36
+ | `https://api.dshfind.com/market/dsh-index.json` | 4.7 MB | 8,321 | ≈ 34 s |
37
+ | `https://gcore.jsdelivr.net/gh/yueyexiayu/dsh-market-zh@main/index.json` | 0.7 MB | 597 | ≈ 4 s |
38
+ | `https://cdn.jsdelivr.net/npm/dsh-plugin-catalog/index.json` | 4.6 MB | 5,643 | ≈ 1 s |
39
+
40
+ 前两个都远超 15 秒,于是「发现」页搜索经常直接失败,报索引超时或搜不出来。
30
41
 
31
- 前两个都远超 15 秒,于是搜索经常直接失败,报「索引超时」或「搜索不出来」。
42
+ ### 可添加的索引源
32
43
 
33
- 本插件做三件事:
44
+ 下面四个地址可以直接复制,粘贴到 **插件源缓存 → 添加**,或 **发现 → 索引源**:
45
+
46
+ ```text
47
+ https://cdn.dsh.so/market/index.json
48
+ https://gcore.jsdelivr.net/gh/yueyexiayu/dsh-market-zh@main/index.json
49
+ https://api.dshfind.com/market/dsh-index.json
50
+ https://cdn.jsdelivr.net/npm/dsh-plugin-catalog/index.json
51
+ ```
52
+
53
+ > 这些索引由社区维护,地址或格式可能变化;添加后可在「插件源缓存」里点「刷新」验证是否可用。
54
+
55
+ 本功能做三件事:
34
56
 
35
57
  1. **落盘缓存**:用更长的超时(默认 2 分钟)在后台抓取索引,校验格式 1 的基本结构,原子写入 `<profile>/.pluginmarket-plus/index-<id>.json`;失败保留上一份成功副本。
36
58
  2. **本地镜像**:通过本机 Web 服务提供 `http://127.0.0.1:<port>/pluginmarket-plus/index/<id>.json`,抓取是毫秒级。
37
59
  3. **接管发现页**:把 `plugin-market` 的 `indexes` 从上游地址切换成本地镜像(只替换已经缓存成功的源),搜索随即恢复正常。
38
60
 
39
- ## 使用
61
+ ### 使用
40
62
 
41
- 安装并启用后,打开 **设置 → 插件市场缓存**:
63
+ 打开 **Plugins → 插件源缓存**:
42
64
 
43
65
  - 「全部刷新」「刷新」:立即重新抓取并落盘。
44
66
  - 「自动刷新」「刷新间隔」:默认每 4 小时刷新一次(另有插件启动时补一次过期/缺失的源)。
45
- - 「让发现页使用本地缓存」:接管 `plugin-market` 的索引源。关掉即还原为上游地址。
67
+ - 「让发现页使用本地缓存」:接管 `plugin-market` 的索引源;关掉即还原为上游地址。
46
68
  - 索引源列表:可添加/移除源,可复制每个源的本地镜像地址。
47
69
 
48
- ## 行为与限制
70
+ ### 行为与限制
49
71
 
50
72
  - 缓存目录:`<profile>/.pluginmarket-plus/`(可用 `cacheDir` 改)。
51
73
  - 镜像路由必须免登录:`pluginMarket` 在 Host 进程里用裸 `fetch` 读取索引,不带浏览器 Cookie;路由只提供公开的索引 JSON,且 Web 服务默认只绑定回环地址。
52
74
  - 接管只替换已缓存成功的源;尚未缓存成功的源继续直连上游,不会因为镜像 404 而整体失败。
53
75
  - 索引里的相对 `icon` 会在落盘时改写为相对上游地址的绝对地址,避免在镜像源下解析到 localhost。
54
76
  - 详情页(README/长描述)仍由官方 `plugin-market` 按版本的 npm/Git 源读取,不受本缓存影响;上游仓库不可达时详情页仍可能失败。
55
- - 禁用/卸载插件前建议先在设置页关闭「让发现页使用本地缓存」,否则发现页会保留指向本机镜像的索引地址。
77
+ - 禁用/卸载插件前建议先关闭「让发现页使用本地缓存」,否则发现页会保留指向本机镜像的索引地址。
78
+
79
+ ## 功能二:可更新
80
+
81
+ ### 它能做什么
82
+
83
+ 「可更新」把已安装插件里**有新版本**的集中列出来,并允许:
84
+
85
+ - 单项「更新」
86
+ - 勾选多个后「更新已选」
87
+ - 一次「更新全部」(按当前设置开关选取)
88
+ - 批量按顺序执行;**某一项失败会继续下一项**,最后汇总成功/失败/需重启
89
+ - 实时进度(检查 → 移除 → 安装 → 回滚)、可展开 pnpm 日志、可取消当前项
90
+ - 不兼容版本显示与「版本豁免」流程
91
+ - 齿轮设置里三个开关:
92
+ - 「显示检查失败的项」:显示检查失败 / 无法检查 / 未检查的条目
93
+ - 「包含预发布 / 已废弃版本」:把这两类目标版本也纳入列表与「更新全部」
94
+ - 「包含已禁用的插件」:把已禁用但可更新的插件也纳入列表
95
+
96
+ 默认列表只显示「有更新的项」:可更新 + 暂不推荐(预发布/已废弃未开启时)+ 不兼容(需先豁免);检查失败类条目默认隐藏。
97
+
98
+ ### 检查更新从哪里来
99
+
100
+ - **npm 包**:调用 DSH 官方的 `pluginManager.listVersions(name)`,由 pnpm / registry 查询新版本,返回 `prerelease`、`deprecated`、是否声明 `dsh.bundle`、与当前 DSH 的兼容性。
101
+ - **Git 包**(固定 40 位 commit):官方不查 GitHub,本插件读**插件源缓存里的市场索引**,取该包最新版本的 `source.commit` 与已安装 commit 比较;索引里没有就标记「无法检查」,不会去调 GitHub API。
102
+ - 以下不进列表:官方自带 bundle、`link:` / `file:` 本地目录、`npm:` 别名、分支/标签等未固定 commit 的 Git 安装。
103
+
104
+ ### 更新怎么执行
105
+
106
+ 复用 DSH 官方的 `pluginManager.updateBundle()`:校验目标版本与 DSH 兼容性 → 移除旧版 → 安装新版;失败时尝试装回旧版本(结果在 `restore` 里),回滚也失败则包处于未安装状态。需要 build script 批准的新版本会更新失败并回滚,官方路径是「移除后重新安装并批准脚本」。
107
+
108
+ ### 版本豁免
109
+
110
+ 如果目标版本声明的 `engines.dsh` / peers 与当前 DSH 不匹配,官方会在检查阶段拒绝更新。对确实想用的版本,可以在不兼容行点「版本豁免」:
111
+
112
+ 1. 勾选「我接受风险:可能崩溃或数据丢失」
113
+ 2. 再点一次「豁免此版本并更新」二次确认
114
+
115
+ 确认后调用 `setVersionExemption(pkg@version, runtimeVersion, true, acceptRisk: true)`,写入 profile 的本地豁免记录,然后自动发起更新。豁免只对「这个包的这一个版本 × 当前这个 DSH 版本」生效,插件或 DSH 升级后自动失效。
116
+
117
+ ### 行为与限制
118
+
119
+ - 检查更新需要网络;registry 走 pnpm 配置的源(npmjs、npmmirror 或私有源)。
120
+ - Git 包的检查依赖「插件源缓存」里的索引;缓存被禁用或为空时,Git 项会显示「无法检查」。
121
+ - 官方自带 bundle 跟随 DSH 版本升级,不参与这里的单包更新。
122
+ - 一次只跑一个更新(顺序队列);批量可随时取消当前项。
123
+ - 部分插件更新后需要重启 DSH 才能完全生效(结果里会标「需重启」)。
56
124
 
57
125
  ## 配置(cordis.patch.yml)
58
126
 
@@ -66,14 +134,28 @@ dsh plugin --profile web add github:jiyuchen1/dsh-pluginmarket-plus
66
134
  | `maxBytes` | `67108864` | 单个索引正文上限 |
67
135
  | `retries` | `2` | 失败重试次数 |
68
136
  | `cacheDir` | `.pluginmarket-plus` | 缓存目录(相对 profile) |
137
+ | `updatesIncludeDisabled` | `false` | 「可更新」是否包含已禁用的插件 |
138
+ | `updatesIncludePrerelease` | `false` | 「可更新」是否包含预发布/已废弃版本 |
139
+ | `updatesShowFailed` | `false` | 「可更新」是否显示检查失败 / 无法检查 / 未检查的条目 |
69
140
 
70
141
  ## 文件
71
142
 
72
- - `lib/index.js` — Host:缓存编排、镜像路由、`/api/pluginmarket-plus/*`、定时器、发现页接管。
143
+ - `lib/index.js` — Host:缓存编排、镜像路由、定时器、发现页接管;「可更新」桥接与队列。
73
144
  - `lib/store.js` — 磁盘缓存与状态清单(原子写)。
74
145
  - `lib/refresh.js` — 抓取、最小格式校验、相对 icon 改写。
75
- - `client.js` — 设置页(无构建步骤,React 来自宿主模块表)。
146
+ - `lib/updates.js` — 「可更新」纯逻辑:版本比较、候选筛选、检查、顺序队列、结果归一。
147
+ - `client.js` — 两个 tab(插件源缓存 / 可更新),无构建步骤,React 来自宿主模块表。
148
+ - `tools/` — 自测与独立验证脚本(`npm test` 跑 `tools/updates-selftest.mjs`)。
149
+
150
+ ## 开发与测试
151
+
152
+ ```sh
153
+ npm test # updates-selftest
154
+ node tools/updates-integration.mjs # Host 集成(假 ctx + 假 pluginManager)
155
+ node tools/client-selftest.mjs # 客户端纯逻辑与交互
156
+ node tools/client-bundle-check.mjs # 客户端装载/渲染冒烟
157
+ ```
76
158
 
77
159
  ## License
78
160
 
79
- MIT © 2026 jiyuchen1
161
+ MIT © 2026 jiyuchen1