@nonamelego/dsh-catppuccin 0.4.3 → 0.5.0-beta.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.en.md CHANGED
@@ -271,11 +271,13 @@ Then add `@nonamelego/dsh-catppuccin` to the profile's `package.json`
271
271
  A: The stock Appearance row only lists the built-in light / dark / follow-system
272
272
  preferences. The four flavours live in the **Catppuccin** row right below it.
273
273
  - **Q: "How is my theme choice remembered?"**
274
- A: The choice persists in `catppuccin-state.json` under the DSH home (shared across
275
- every DSH instance on the machine), with localStorage as an in-browser cache and
276
- cross-tab sync. So plain `dsh web`, `dsh web --port <custom>`, and **DSH Desktop**
277
- (which boots on a fresh random loopback port every launch) all restore the preference
278
- automatically. The glass switch and every knob persist the same way.
274
+ A: The choice persists in DSH's official settings document (the `catppuccin` namespace,
275
+ stored under the DSH home, shared across every DSH instance on the machine), with
276
+ localStorage as an in-browser cache and cross-tab sync. So plain `dsh web`,
277
+ `dsh web --port <custom>`, and **DSH Desktop** (which boots on a fresh random loopback
278
+ port every launch) all restore the preference automatically. The glass switch and every
279
+ knob persist the same way. Since 0.5.0, a legacy `catppuccin-state.json` is migrated
280
+ into the settings document once on first launch (the file is kept as a rollback copy).
279
281
  - **Q: "How do I know if this plugin has a new version?"**
280
282
  A: Settings → General → **Check Catppuccin plugin updates** compares against npm in one
281
283
  click and gives a copyable upgrade command; or run
package/README.md CHANGED
@@ -55,7 +55,7 @@ Catppuccin 主题。
55
55
  - 🧩 接入官方主题系统,与内置浅色 / 深色 / 跟随系统主题平级
56
56
  - 🎯 全界面配色覆盖,不只是一两个强调色
57
57
  - ⚙️ 设置页一行切换,选择自动保存、重启自动恢复
58
- - 🌐 中英文双语文案(跟随系统语言)
58
+ - 🌐 中 / 英 / 日 / 韩 / 西 / 法 / 德七语文案(跟随系统语言)
59
59
  - 🪟 **玻璃质感**:顶栏 / 侧边栏 / 输入框 / 统计行 / 轨迹视图 / 聊天气泡 /
60
60
  新会话按钮磨砂玻璃效果,设置里一键开关;云母 / 兼容双模式,模糊度、磨砂度、
61
61
  背景亮度自由调节(交互参考 [DSH-Transparent-UI-Plugin](https://github.com/WYH66666666/DSH-Transparent-UI-Plugin))
@@ -225,16 +225,28 @@ dsh plugin --profile dsh-tui add https://github.com/NoNameLeGo/dsh-catppuccin-th
225
225
  ```sh
226
226
  pnpm install
227
227
  pnpm typecheck # tsc --noEmit 类型检查
228
- pnpm test # vitest 跑配色表覆盖测试
228
+ pnpm test # vitest 跑配色表 / 契约 / e2e 覆盖测试
229
229
  pnpm build # tsdown 构建 -> lib/index.js(服务端)+ lib/client.js(浏览器)
230
230
  ```
231
231
 
232
- 配色表由生成器脚本产出——修改 `scripts/generate-palettes.mjs` 后重跑:
232
+ 配色表由生成器脚本产出——修改 `scripts/generate-palettes.mjs` 后重跑
233
+ (`--pin <sha>` 可把上游 commit SHA 写进 `palettes.ts` 头部,见
234
+ `docs/plugin-improvements.md` 的 L 项):
233
235
 
234
236
  ```sh
235
- node scripts/generate-palettes.mjs
237
+ node scripts/generate-palettes.mjs [--pin <upstream-sha>]
236
238
  ```
237
239
 
240
+ 对外 API(`./client`、`./tui-themes` 子路径导出)的 typedoc 文档生成到
241
+ `docs/api/`(GitHub Pages 发布交给 maintainer):
242
+
243
+ ```sh
244
+ pnpm docs:api
245
+ ```
246
+
247
+ 贡献指南见 [CONTRIBUTING.md](CONTRIBUTING.md);状态契约的版本迁移约定见
248
+ [docs/state-migrations.md](docs/state-migrations.md)。
249
+
238
250
  ### 本地链接调试
239
251
 
240
252
  克隆到本地后,把包链接进 profile 并加入 bundles(路径换成你自己的):
@@ -253,11 +265,12 @@ pnpm --dir C:\Users\LeGo\.dsh\profiles\web add link:D:\Vibe-Coding\dsh-catppucci
253
265
  A: 官方外观行只列出内置的浅色/深色/跟随系统偏好。四个主题在它正下方的
254
266
  **Catppuccin** 行里。
255
267
  - Q: **_"我的主题选择是怎么记住的?"_**
256
- A: 选择持久保存在 DSH home 下的 `catppuccin-state.json`(同一台机器的
257
- DSH 共享这份偏好),浏览器 localStorage 作为即时缓存与多标签页同步。
258
- 因此普通 `dsh web`、`dsh web --port` 自定义端口,以及 **DSH Desktop**
259
- (每次启动用随机回环端口)都能跨重启自动恢复;玻璃质感开关与各旋钮同样
260
- 持久保存。
268
+ A: 选择持久保存在 DSH 的官方 settings 文档(`catppuccin` namespace,存于
269
+ DSH home 下,同一台机器的 DSH 共享这份偏好),浏览器 localStorage 作为
270
+ 即时缓存与多标签页同步。因此普通 `dsh web`、`dsh web --port` 自定义端口,
271
+ 以及 **DSH Desktop**(每次启动用随机回环端口)都能跨重启自动恢复;玻璃质感
272
+ 开关与各旋钮同样持久保存。0.5.0 起旧版 `catppuccin-state.json` 会在首次
273
+ 启动时一次性迁移进 settings 文档(文件保留作回退)。
261
274
  - Q: **_"怎么知道这个插件有没有新版本?"_**
262
275
  A: 设置 → 常规 → **检查 Catppuccin 插件更新** 一键检测本插件在 npm 上的最新版本,
263
276
  发现新版会给出可复制的升级命令;也可以随时手动执行