@nonamelego/dsh-catppuccin 0.5.1 → 0.5.3-beta.0

package/README.en.md

@@ -30,9 +30,9 @@
 - [💝 Credits](#-credits)
 
 <p align="center">
-	<img src="assets/previews/combined.png" width="100%" alt="DeepSeek Harness under the four Catppuccin flavours"/>
+	<img src="https://raw.githubusercontent.com/NoNameLeGo/dsh-catppuccin-theme/main/assets/previews/combined.png" width="100%" alt="DeepSeek Harness under the four Catppuccin flavours"/>
 	<br/><br/>
-	<img src="assets/previews/glass-combined.png" width="100%" alt="Glass skin · Latte & Mocha"/>
+	<img src="https://raw.githubusercontent.com/NoNameLeGo/dsh-catppuccin-theme/main/assets/previews/glass-combined.png" width="100%" alt="Glass skin · Latte & Mocha"/>
 </p>
 
 ## Introduction
@@ -58,7 +58,9 @@ Catppuccin theme automatically.
 - 🧩 Registered into the official theme system, on a par with the built-in light / dark / system themes
 - 🎯 Full-UI colour coverage — not just one or two accent colours
 - ⚙️ One-click switch in Settings, persisted and restored across restarts
-- 🌐 Bilingual UI (Chinese / English, follows the system language)
+- 🔧 **Custom token overrides**: override individual colour tokens with `--dsw-* var: value` pairs (e.g. turn comments blue); persisted alongside the selected flavour
+- 🖍️ **Code-block highlight style**: default / italic-comments shiki themes
+- 🌐 Seven UI languages (Chinese / English / Japanese / Korean / Spanish / French / German, follows the system language)
 - 🪟 **Glass skin**: frosted glass for the top bar / sidebar / composer / stats line /
   trajectory view / chat bubbles / new-session button, one-click toggle in Settings;
   mica & compatibility modes, adjustable blur, frost and backdrop brightness
@@ -68,7 +70,8 @@ Catppuccin theme automatically.
   content softens as it scrolls under the panes
 - 🎨 Glass colours follow the current Catppuccin theme
 - 🔄 **Update check**: one-click "Check for updates" in Settings compares the latest npm
-  version and gives you a copyable upgrade command
+  version and gives you a copyable upgrade command; **auto-check is on by default** (once at
+  startup, then every 6 hours) and the release channel switches between stable and beta
 - 💻 **dsh-TUI terminal themes**: one command installs into dsh-TUI; the four themes sync to
   `~/.dsh-tui/themes/` automatically (see [Installation · dsh-TUI](#dsh-tui-terminal-themes))
 
@@ -78,19 +81,19 @@ Actual screenshots from a local GUI (the header image is a diagonal blend of the
 
 <details>
 <summary>🌻 Latte (light)</summary>
-<img src="assets/previews/latte.png"/>
+<img src="https://raw.githubusercontent.com/NoNameLeGo/dsh-catppuccin-theme/main/assets/previews/latte.png"/>
 </details>
 <details>
 <summary>🪴 Frappé (dark)</summary>
-<img src="assets/previews/frappe.png"/>
+<img src="https://raw.githubusercontent.com/NoNameLeGo/dsh-catppuccin-theme/main/assets/previews/frappe.png"/>
 </details>
 <details>
 <summary>🌺 Macchiato (dark)</summary>
-<img src="assets/previews/macchiato.png"/>
+<img src="https://raw.githubusercontent.com/NoNameLeGo/dsh-catppuccin-theme/main/assets/previews/macchiato.png"/>
 </details>
 <details>
 <summary>🌿 Mocha (dark)</summary>
-<img src="assets/previews/mocha.png"/>
+<img src="https://raw.githubusercontent.com/NoNameLeGo/dsh-catppuccin-theme/main/assets/previews/mocha.png"/>
 </details>
 
 ### Glass skin (Mica mode)
@@ -101,11 +104,11 @@ past the page edges; the background is the theme's solid base colour:
 
 <details>
 <summary>🌻 Latte (light glass)</summary>
-<img src="assets/previews/glass-latte.png"/>
+<img src="https://raw.githubusercontent.com/NoNameLeGo/dsh-catppuccin-theme/main/assets/previews/glass-latte.png"/>
 </details>
 <details>
 <summary>🌿 Mocha (dark glass)</summary>
-<img src="assets/previews/glass-mocha.png"/>
+<img src="https://raw.githubusercontent.com/NoNameLeGo/dsh-catppuccin-theme/main/assets/previews/glass-mocha.png"/>
 </details>
 
 ## Installation
@@ -146,8 +149,13 @@ The same package covers the TUI. Install it into the dsh-tui profile:
 dsh plugin --profile dsh-tui add @nonamelego/dsh-catppuccin
 ```
 
-Installing from the repository works the same way (use the git form while the npm release
-is pending). The package ships a tiny theme-sync plugin row
+Installing from the repository works the same way:
+
+```sh
+dsh plugin --profile dsh-tui add https://github.com/NoNameLeGo/dsh-catppuccin-theme
+```
+
+The package ships a tiny theme-sync plugin row
 (`dsh-catppuccin-tui-themes`, no service dependencies): on every dsh-TUI start it syncs the
 four theme JSONs to `~/.dsh-tui/themes/`, so upgrades pick up the new palettes. After
 installing, launch `dsh --profile dsh-tui` and pick the theme with `/theme` —
@@ -178,6 +186,15 @@ installing, launch `dsh --profile dsh-tui` and pick the theme with `/theme` —
 4. Choosing **Follow system** reverts to the official theme — it restores the preference
    you had before enabling Catppuccin (light / dark / follow system) instead of forcing a reset.
 
+### Other options in the Catppuccin row
+
+- **Code highlight style**: default / **italic comments** — affects only the shiki colours used
+  in code blocks and diffs.
+- **Custom overrides** (collapsible; the button shows the entry count): override individual tokens
+  with `--dsw-* var: value` pairs, e.g. `--dsw-static-blue-500` → `#89b4fa`. The **key** commits on
+  blur and must start with `--` (otherwise the entry is dropped); the **value** also commits on blur,
+  and an **empty value deletes the entry**; ✕ removes the row. Overrides persist with the flavour.
+
 ### Glass skin
 
 Right below the **Catppuccin theme** row in **Settings → General** you'll find the **Glass** row:
@@ -201,6 +218,8 @@ In **Settings → General**, right below the **Glass** row:
 - Clicking **Check for updates** compares the latest npm version with the installed one:
   up to date → shows the current version; newer → shows the new version plus a copyable
   upgrade command (the profile name is detected automatically, falling back to `web`).
+- **Auto-check**: on by default — once after startup, then every 6 hours (switch it off on this row);
+  the **Channel** picks **Stable** (follows `latest` only) or **Beta** (prereleases too).
 - Locally linked / source installs (`link:` / `file:` / git) don't show an npm upgrade
   command — you'll be told to `git pull` or rebuild instead.
 - Channel policy: stable builds follow the `latest` tag; prereleases follow both `latest`
@@ -233,9 +252,10 @@ What this plugin does:
 
 ```sh
 pnpm install
-pnpm typecheck   # tsc --noEmit type check
-pnpm test        # vitest palette-coverage tests
-pnpm build       # tsdown build -> lib/index.js (host) + lib/client.js (browser)
+pnpm typecheck       # tsc --noEmit: type check for src
+pnpm typecheck:tests # tsc --noEmit: type check for the specs (vitest transpiles, it never type checks)
+pnpm test            # vitest palette-coverage tests
+pnpm build           # tsdown build -> lib/index.js (host) + lib/client.js (browser)
 ```
 
 Palettes are produced by a generator script — after editing
@@ -253,6 +273,17 @@ pnpm changelog:gen            # print the draft since the last tag
 pnpm changelog:gen -- --write # write it into the [Unreleased] section
 ```
 
+TypeDoc docs for the public API (`./client`, `./tui-themes` subpath exports) are generated
+locally on demand into `docs/api/` (that directory is **not** committed — it's in
+`.gitignore`; wire up CI Pages publishing later if an online copy is ever wanted):
+
+```sh
+pnpm docs:api
+```
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for the contribution guide and
+[docs/state-migrations.md](docs/state-migrations.md) for the state versioning contract.
+
 ### Local link debugging
 
 Clone the repo, link it into a profile and add it to the bundles (use your own paths):
@@ -301,4 +332,8 @@ Then add `@nonamelego/dsh-catppuccin` to the profile's `package.json`
 
 <p align="center">
 	Copyright &copy; 2021-present <a href="https://github.com/catppuccin/catppuccin" target="_blank">Catppuccin Org</a>
+</p>
+
+<p align="center">
+	<a href="https://github.com/catppuccin/catppuccin/blob/main/LICENSE"><img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=License&message=MIT&logoColor=d9e0ee&colorA=363a4f&colorB=b7bdf8"/></a>
 </p>

package/README.md

@@ -28,9 +28,9 @@
 - [💝 致谢](#致谢)
 
 <p align="center">
-	<img src="assets/previews/combined.png" width="100%" alt="Catppuccin 四主题下的 DeepSeek Harness"/>
+	<img src="https://raw.githubusercontent.com/NoNameLeGo/dsh-catppuccin-theme/main/assets/previews/combined.png" width="100%" alt="Catppuccin 四主题下的 DeepSeek Harness"/>
 	<br/><br/>
-	<img src="assets/previews/glass-combined.png" width="100%" alt="玻璃质感 · Latte & Mocha"/>
+	<img src="https://raw.githubusercontent.com/NoNameLeGo/dsh-catppuccin-theme/main/assets/previews/glass-combined.png" width="100%" alt="玻璃质感 · Latte & Mocha"/>
 </p>
 
 ## 简介
@@ -55,6 +55,8 @@ Catppuccin 主题。
 - 🧩 接入官方主题系统，与内置浅色 / 深色 / 跟随系统主题平级
 - 🎯 全界面配色覆盖，不只是一两个强调色
 - ⚙️ 设置页一行切换，选择自动保存、重启自动恢复
+- 🔧 **自定义 token 覆盖**：按「`--dsw-* 变量: 值`」逐条覆盖单个配色 token（例如把注释色换成蓝色），与所选风味一起持久保存
+- 🖍️ **代码块高亮风格**：默认 / 注释斜体（italic-comments）两套 shiki 风格可选
 - 🌐 中 / 英 / 日 / 韩 / 西 / 法 / 德七语文案（跟随系统语言）
 - 🪟 **玻璃质感**：顶栏 / 侧边栏 / 输入框 / 统计行 / 轨迹视图 / 聊天气泡 /
   新会话按钮磨砂玻璃效果，设置里一键开关；云母 / 兼容双模式，模糊度、磨砂度、
@@ -62,7 +64,7 @@ Catppuccin 主题。
 - 🌫️ **玻璃拟态细节**：页面上下边缘渐变模糊、折叠侧边栏悬浮玻璃、
   纯色背景跟随主题底色——内容滚入视口边缘时柔化穿过，层次更立体
 - 🎨 玻璃配色自动跟随当前 Catppuccin 主题
-- 🔄 **检查 Catppuccin 插件更新**：设置页一键检测本插件（dsh-catppuccin）在 npm 上的最新版本，发现新版直接给出可复制的升级命令
+- 🔄 **检查 Catppuccin 插件更新**：设置页一键检测本插件（dsh-catppuccin）在 npm 上的最新版本，发现新版直接给出可复制的升级命令；**默认开启自动检查**（启动后一次 + 每 6 小时），更新渠道可选稳定版 / Beta
 - 💻 **dsh-TUI 终端主题**：一条安装命令装进 dsh-TUI，四套主题自动同步到 `~/.dsh-tui/themes/`，见[安装 · dsh-TUI](#dsh-tui-终端版主题)
 
 ## 预览
@@ -71,19 +73,19 @@ Catppuccin 主题。
 
 <details>
 <summary>🌻 Latte（浅色）</summary>
-<img src="assets/previews/latte.png"/>
+<img src="https://raw.githubusercontent.com/NoNameLeGo/dsh-catppuccin-theme/main/assets/previews/latte.png"/>
 </details>
 <details>
 <summary>🪴 Frappé（深色）</summary>
-<img src="assets/previews/frappe.png"/>
+<img src="https://raw.githubusercontent.com/NoNameLeGo/dsh-catppuccin-theme/main/assets/previews/frappe.png"/>
 </details>
 <details>
 <summary>🌺 Macchiato（深色）</summary>
-<img src="assets/previews/macchiato.png"/>
+<img src="https://raw.githubusercontent.com/NoNameLeGo/dsh-catppuccin-theme/main/assets/previews/macchiato.png"/>
 </details>
 <details>
 <summary>🌿 Mocha（深色）</summary>
-<img src="assets/previews/mocha.png"/>
+<img src="https://raw.githubusercontent.com/NoNameLeGo/dsh-catppuccin-theme/main/assets/previews/mocha.png"/>
 </details>
 
 ### 玻璃质感（Mica 云母模式）
@@ -92,16 +94,13 @@ Catppuccin 主题。
 聊天气泡、输入框与统计行都是玻璃卡片，消息滚过页面边缘时被柔化，
 背景为主题底色的纯色（截图来自本地 GUI）：
 
-<p align="center">
-</p>
-
 <details>
 <summary>🌻 Latte（浅色玻璃）</summary>
-<img src="assets/previews/glass-latte.png"/>
+<img src="https://raw.githubusercontent.com/NoNameLeGo/dsh-catppuccin-theme/main/assets/previews/glass-latte.png"/>
 </details>
 <details>
 <summary>🌿 Mocha（深色玻璃）</summary>
-<img src="assets/previews/glass-mocha.png"/>
+<img src="https://raw.githubusercontent.com/NoNameLeGo/dsh-catppuccin-theme/main/assets/previews/glass-mocha.png"/>
 </details>
 
 ## 安装
@@ -143,7 +142,7 @@ dsh plugin --profile web add https://github.com/NoNameLeGo/dsh-catppuccin-theme
 dsh plugin --profile dsh-tui add @nonamelego/dsh-catppuccin
 ```
 
-从仓库安装同理（npm 版尚未发版时可用 git 形式，效果一致）：
+从仓库安装同理（也可用 git 形式，效果一致）：
 
 ```sh
 dsh plugin --profile dsh-tui add https://github.com/NoNameLeGo/dsh-catppuccin-theme
@@ -171,6 +170,13 @@ dsh plugin --profile dsh-tui add https://github.com/NoNameLeGo/dsh-catppuccin-th
 4. 选择 **跟随系统** 则回退到官方主题——会还原你启用 Catppuccin 之前
    的官方偏好（浅色 / 深色 / 跟随系统），而不是强制重置。
 
+### Catppuccin 行里的其它选项
+
+- **代码高亮风格**：默认 / **注释斜体**（italic-comments）——只影响代码块与 diff 的 shiki 高亮配色。
+- **自定义覆盖**（折叠区，按钮上显示已有条数）：按「`--dsw-* 变量: 值`」逐条覆盖单个 token，
+  例如 `--dsw-static-blue-500` → `#89b4fa`。**键名**失焦生效（必须以 `--` 开头，否则该条会被丢弃）；
+  **值**同样失焦生效、**清空值即删除该条**；✕ 删除整行。覆盖持久保存，与所选风味一起生效。
+
 ### 玻璃质感
 
 在 **设置 → 常规** 的 **Catppuccin 主题** 正下方找到 **玻璃质感** 行：
@@ -196,6 +202,8 @@ dsh plugin --profile dsh-tui add https://github.com/NoNameLeGo/dsh-catppuccin-th
 - 点击 **检查更新** 即对比 npm 上的最新版与当前版本：已是最新 → 显示当前
   版本号；发现新版 → 显示新版本号并给出可复制的升级命令（命令中的 profile
   名自动探测，无需手动替换；探测失败才回退为 `web`）。
+- **自动检查**：默认开启——启动后检查一次、之后每 6 小时一次（该行可关闭）；
+  **渠道**可选 **稳定版**（只跟 `latest`）或 **Beta 版**（连预发布一起跟）。
 - 本插件为本地链接 / 源码安装（`link:` / `file:` / git）时不显示 npm 升级
   命令，会提示改用 `git pull` 或重新构建。
 - 通道策略：正式版只跟随 `latest` 标签；预发布版同时跟随 `beta`（升级命令
@@ -224,9 +232,10 @@ dsh plugin --profile dsh-tui add https://github.com/NoNameLeGo/dsh-catppuccin-th
 
 ```sh
 pnpm install
-pnpm typecheck   # tsc --noEmit 类型检查
-pnpm test        # vitest 跑配色表 / 契约 / e2e 覆盖测试
-pnpm build       # tsdown 构建 -> lib/index.js（服务端）+ lib/client.js（浏览器）
+pnpm typecheck       # tsc --noEmit：src 的类型检查
+pnpm typecheck:tests # tsc --noEmit：tests 的类型检查（vitest 跑 esbuild，不做类型检查）
+pnpm test            # vitest 跑配色表 / 契约 / e2e 覆盖测试
+pnpm build           # tsdown 构建 -> lib/index.js（服务端）+ lib/client.js（浏览器）
 ```
 
 配色表由生成器脚本产出——修改 `scripts/generate-palettes.mjs` 后重跑
@@ -237,8 +246,15 @@ pnpm build       # tsdown 构建 -> lib/index.js（服务端）+ lib/client.js
 node scripts/generate-palettes.mjs [--pin <upstream-sha>]
 ```
 
-对外 API（`./client`、`./tui-themes` 子路径导出）的 typedoc 文档生成到
-`docs/api/`（GitHub Pages 发布交给 maintainer）：
+CHANGELOG 草稿由 conventional 提交生成（提交正文里的 `EN:` 行会被渲染成英文摘要）：
+
+```sh
+pnpm changelog:gen            # 打印上一 tag 之后的草稿
+pnpm changelog:gen -- --write # 直接写入 [Unreleased] 节
+```
+
+对外 API（`./client`、`./tui-themes` 子路径导出）的 typedoc 文档**按需本地生成**到
+`docs/api/`（该目录不入库、已进 `.gitignore`；哪天真需要在线版本再接 CI 发布）：
 
 ```sh
 pnpm docs:api