dsh-prompt-rewriter 1.7.1 → 1.8.0

package/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 记录每个**已发布**版本对使用者可见的变化。插件内只维护中文条目；对外发布（GitHub Release / npm）的双语正文由发布方据此撰写，其中中文以本文件为准。
 
+## 1.8.0
+
+**中文**
+
+- **增强规则可选**：设置页新增三套规则。**旧版**逐字沿用 1.7.1 发布的规则原文，手感与老版本一致；**意图优先**先推断你真正想干什么，再把话写明白、写全；**WorkBuddy** 逐字沿用 WorkBuddy 随包发布的原始提示词。三套都只调用一次模型，区别只在改写力度；每套的定位与取舍在设置页里可直接对照。
+- **输入框里的附件会被读取**：增强时可参考当前输入框中最多 2 个非图片附件（每个不超过 5 MiB；文本类发送 6000 字符预览），关闭开关后只读文件名、不读内容。图片参考的开关与行为不变。
+- **改写不再反问你**：模型若在改写旁边夹了问句，问句会被就地删掉、改写保留；若整条回复只有问句，会用旧版规则再跑一次；仍不行就保留原草稿——问句不会出现在结果里。
+- **修复：发送消息时点增强不再失败**：此前在改写进行中按了发送，输入框处于冻结态会拒绝写入，改写被丢弃并提示「输入框没有接受替换，草稿保持不变」；现在会等到输入框空闲后自动写入，并照常提供「回退」。
+- **修复：增强按钮被同槽位的第三方控件覆盖约 4px**（#4）：去掉了「右邻一定是宿主自己的模型触发器」这一负边距假设，改用不参与布局的 7px 视觉偏移。
+- **设置页顶部改为反馈入口**：原来那句「只影响增强提示词按钮」的说明换成「遇到问题？到 GitHub 提 issue ↗」，点开直接进本项目的 issue 列表；版本号仍在同一行右侧。
+- **设置页顶部新增 Star 入口**：第一行改为「点个 Star ⭐ · 遇到问题？提 issue ↗」，整行沿用次要色与 13px 字号，只有行尾的 ⭐ 自带颜色；版本号仍在右侧，不新增设置项。
+- **文档：两半的加载方式写明**——只改客户端（按钮、交互、提示文案）由 Harness 的 client HMR 自动替换，不必重启；宿主侧（增强接口与提示词规则）改动仍需重启一次。
+
 ## 1.7.1
 
 **中文**

package/README.en.md

@@ -35,7 +35,7 @@ The third column is not something you wrote. It read your sentence and filled it
 ## How to use it
 
 1. Type any draft in the composer — shorter is fine.
-2. Click the **whale-tail icon just left of the model name**. It isn't there when the box is empty.
+2. Click the **whale-tail icon** in the right-hand control group of the composer (a small blue dot means it will use conversation context). It shares that group with the model picker and send button, and other plugins may add controls between them. It isn't there when the box is empty.
 3. A second later the draft is replaced with the rewritten prompt.
 4. Not what you wanted? `Ctrl+Z`, or click the undo arrow the button turned into.
 
@@ -107,21 +107,25 @@ Only images **currently sitting in the composer** — **never images from earlie
 
 ## Settings
 
-`Settings → Prompt Enhance`. Four switches and one dropdown, affecting **only this button, never normal sending**. The changelog sits at the bottom of the page.
+`Settings → Prompt Enhance`. Five switches, a model dropdown and a rule-set dropdown, affecting **only this button, never normal sending**. The changelog sits at the bottom of the page.
 
 ![Settings page](https://raw.githubusercontent.com/huaguoxingkong/dsh-prompt-rewriter/main/docs/images/03-settings-en.png)
 
 | Option | Default | What turning it on does |
 |---|---|---|
 | Use a fixed model | Off | Off: follow the model of the current conversation. On: always use the model picked below. |
+| Enhancement rule set | **Legacy (stable)** | Three choices: **Legacy** ships the 1.7.1 playbook verbatim (15 rows, 10 of them rules; about 1.2–3× the draft); **intent-first** works out what the user actually wants, then writes it out more clearly and more completely (the six dimensions are covered wherever the task needs them: goal / inputs / scope / method / output / quality bar; where the draft is silent the executor is told to decide and state its assumption; a sparse draft usually grows to 2–5× its length, never beyond 5×); **WorkBuddy** uses its shipped prompt verbatim (analyse objective, ambiguity, clarity and missing context, then rewrite against its seven principles; the cap is around 800 characters and this set has no verbatim-fact clause, so long drafts get compressed). |None of them answer the request itself; legacy and intent-first explicitly forbid asking the user, and any question WorkBuddy returns is dropped by the plugin. |
 | Reference the conversation | **On** | Read earlier turns. More accurate, but extra tokens and slower on long chats. |
 | Reference composer images | Off | Images in the composer take part. Earlier messages' images are never read. |
+| Reference attachment contents | **On** | On: reads up to 2 non-image files from the composer, up to 5 MiB each; text files send a preview capped at 6,000 characters. Off: file contents are not read or sent; up to 8 filenames may be included as context. |
 | Shortcut | Off | Lets the keyboard trigger a rewrite. Off by default, so no global key fires unasked. |
 
 - The model dropdown lists **the providers and models you actually have** — you can't type in one that doesn't exist.
 - Turning the model switch off does not clear your selection; flipping it back on shows the same choice.
-- Images still uploading are skipped, and the status area tells you how many were missed. A rewrite never fails because of an image.
+- Images still uploading or over the Host attachment service's per-image or per-message limit are skipped; the status area reports how many were missed. A rewrite never fails because of an image.
+- Files over the count or size limit are skipped and reported in the result status.
 - The **current version** sits in the top-right of the settings page; clicking it opens the project home page. Check it before reporting a problem — it makes the issue much easier to pin down.
+- The first row is the entry point: "Star ⭐ · problems? open an issue ↗", leading to the project home page and this project's issue list.
 - The **changelog** at the bottom folds by version, newest open by default; it is read from the shipped `CHANGELOG.md`, so it works offline.
 
 ## Install
@@ -163,7 +167,7 @@ Download the zip from [Releases](https://github.com/huaguoxingkong/dsh-prompt-re
 
 ## Configuration
 
-Every `config` key on the profile plugin line is optional. The first six are managed by the settings page; the last seven are operational ceilings and are not exposed in the UI.
+Every `config` key on the profile plugin line is optional. The first eight are managed by the settings page; the last seven are operational ceilings and are not exposed in the UI.
 
 ```yaml
 - id: dsh-prompt-rewriter
@@ -173,7 +177,9 @@ Every `config` key on the profile plugin line is optional. The first six are man
     useCustomModel: false      # pin enhanceProvider/enhanceModel
     enhanceProvider: ""        # empty = follow the session model
     enhanceModel: ""
+    ruleSet: legacy            # enhancement rule set: legacy / intent-first / workbuddy
     referenceImages: false     # read composer images
+    referenceFiles: true       # read composer file contents
     referenceContext: true     # read earlier turns
     shortcutEnabled: false     # keyboard shortcut (off by default)
 
@@ -209,7 +215,14 @@ Three designs worth calling out:
 
 ## Development
 
-The plugin has a Host half and a Client half. The Host depends only on host services such as `ctx.connection`, `ctx.llm` and `ctx.settings`; the Client registers slot components through `window.__ModuleLoader__`. Both halves load with the bundle at startup, so changes require a restart to verify.
+The plugin has a Host half and a Client half. The Host depends only on host services such as `ctx.connection`, `ctx.llm` and `ctx.settings`; the Client registers slot components through `window.__ModuleLoader__`. **The two halves load differently, so they are verified differently**:
+
+| What changed | How it takes effect | Host restart |
+| --- | --- | --- |
+| `client.js` (button, interaction, wording, styles) | Client HMR polls each front-end bundle every 500 ms and pushes the change over `/plugins/events`; the open window swaps that plugin entry in place | Not needed; refreshing the window is only a fallback |
+| `index.js`, `*-rules.mjs` (enhancement route, prompt rules, settings storage) | Imported once when the Host starts | Required |
+
+Client HMR comes from `@deepseek-ai/dsh-client-hmr`, which the Web composition always mounts. It is not the Host's `hmr`: this machine's profile sets the Host `hmr` to `disabled: true` (see the note in `cordis.patch.yml`), so Host **code** is not hot-reloaded. Settings changed in the UI still take effect immediately (they go through the settings service, not file watching); editing `cordis.patch.yml` by hand is what needs a restart.
 
 **Unit tests are not published with this repository.** Development-time tests depend on the host's private `@deepseek-ai/schemastery`, a copy of the host's React, and this machine's profile layout — publishing them would hand users files that cannot run.
 

package/README.md

@@ -36,7 +36,7 @@
 ## 怎么用
 
 1. 在输入框里写下草稿，多短都行。
-2. 点**模型名左边**那个鲸鱼尾巴图标。输入框为空时它不出现。
+2. 点输入栏右侧那一排控件里的**鲸鱼尾巴图标**（带蓝色小圆点表示会参考上下文）。它和模型名、发送按钮同属右侧控件区，中间可能还有其它插件的按钮；输入框为空时它不出现。
 3. 一秒多之后，草稿被换成改写后的提示词。
 4. 不满意？`Ctrl+Z`，或点按钮变成的回退箭头。
 
@@ -108,26 +108,30 @@
 
 ## 设置
 
-`设置 → 提示词增强`。四个开关一个下拉，**只影响这个按钮，不影响正常发送**。页面底部是更新日志。
+`设置 → 提示词增强`。五个开关、模型下拉和规则下拉，**只影响这个按钮，不影响正常发送**。页面底部是更新日志。
 
 ![设置页](https://raw.githubusercontent.com/huaguoxingkong/dsh-prompt-rewriter/main/docs/images/03-settings.png)
 
 | 选项 | 默认 | 打开会怎样 |
 |---|---|---|
 | 用哪个模型改写 | 关 | 关：跟随当前对话的模型。开：固定用下拉选定的模型。 |
+| 增强规则版本 | **旧版（稳定）** | 三选一：**旧版**逐字沿用 1.7.1 发布的规则原文（15 行、其中 10 条规则，约为原文 1.2–3 倍）；**意图优先**先推断用户真正想干什么，再把话写得更明白更全（六个维度按任务需要覆盖：目标 / 输入 / 范围 / 方法 / 输出 / 质量标准；草稿没说的地方交给执行者自己决定并要求它声明假设，稀疏草稿通常扩到 2–5 倍、上限 5 倍）；**WorkBuddy** 逐字沿用它随包发布的原始提示词（先分析目标、歧义、清晰度与缺失上下文，再按七条原则重写；上限约 800 字符，这套没有逐字保真条款，长草稿会被压缩）。三者都不回答请求本身；旧版与意图优先的规则明文禁止反问，WorkBuddy 原文只禁「回答问题」，它若回问句由插件丢弃。 |
 | 参考之前的对话 | **开** | 读前面的内容。更准，但多耗 token、长对话更慢。 |
 | 参考输入框里的图片 | 关 | 输入框里的图一起参与。历史消息里的图片始终不读。 |
+| 参考附件内容 | **开** | 开：最多读取当前输入框中的 2 个非图片附件，每个不超过 5 MiB；文本类只发送最多 6000 字符的预览。关：不读取或发送附件内容，只把最多 8 个文件名作为上下文。 |
 | 快捷键 | 关 | 打开后可用键盘触发改写。默认关闭，不会在你没要求时抢占按键。 |
 
 - 模型下拉列出你**实际拥有**的渠道与模型，填不进不存在的模型。
 - 关掉模型开关不会清空你的选择，重新打开还是同一个。
-- 上传中的图片会被跳过，状态区会告诉你少读了几张。不会因为一张图让整次改写失败。
+- 上传中的图片或超出附件服务单图/单消息限额的图片会被跳过，状态区会告诉你少读了几张。不会因为一张图让整次改写失败。
+- 附件超出数量或大小上限时会跳过，并在结果状态中提示。
 - 设置页右上角显示**当前版本号**，点一下会打开项目主页。遇到问题时先看一眼版本，反馈时也更好定位。
+- 顶上一行是入口：「点个 Star ⭐ · 遇到问题？提 issue ↗」，分别进项目主页与本项目的 issue 列表。
 - 底部「更新日志」按版本折叠，默认展开当前版本；内容取自随包发布的 `CHANGELOG.md`，不联网也能看。
 
 ## 安装
 
-需要 DeepSeek Harness，`node >= 22`。**装完必须重启 Harness**——本插件没有 HMR。
+需要 DeepSeek Harness，`node >= 22`。**首次安装后重启一次 Harness**：宿主半边（增强接口与提示词规则）只在宿主启动时加载。装好之后只改 `client.js`（按钮、交互、提示文案）不必重启——Harness 的 client HMR 每 500ms 轮询插件的前端 bundle，变更经 `/plugins/events` 推送到已打开的窗口并就地替换，通常 1 秒内生效；刷新窗口只是兜底。
 
 ### 从 npm（推荐）
 
@@ -164,7 +168,7 @@ dsh plugin --profile web add github:huaguoxingkong/dsh-prompt-rewriter
 
 ## 配置
 
-profile 插件行的 `config` 全部可选。前六项由设置页托管，后七项是运维上限，不暴露在界面上：
+profile 插件行的 `config` 全部可选。前八项由设置页托管，后七项是运维上限，不暴露在界面上：
 
 ```yaml
 - id: dsh-prompt-rewriter
@@ -174,7 +178,9 @@ profile 插件行的 `config` 全部可选。前六项由设置页托管，后
     useCustomModel: false      # 是否固定使用 enhanceProvider/enhanceModel
     enhanceProvider: ""        # 空 = 跟随会话模型
     enhanceModel: ""
+    ruleSet: legacy            # 增强规则版本：legacy（旧版）/ intent-first（意图优先）/ workbuddy
     referenceImages: false     # 是否参考输入框图片
+    referenceFiles: true       # 是否参考输入框附件内容
     referenceContext: true     # 是否参考前文
     shortcutEnabled: false     # 键盘快捷键（默认关闭）
 
@@ -210,7 +216,14 @@ profile 插件行的 `config` 全部可选。前六项由设置页托管，后
 
 ## 开发
 
-插件分 Host 与 Client 两半：Host 只依赖 `ctx.connection`、`ctx.llm`、`ctx.settings` 等宿主服务，Client 通过 `window.__ModuleLoader__` 注册槽位组件。两半都随 bundle 在启动时加载，改动后需重启验证。
+插件分 Host 与 Client 两半：Host 只依赖 `ctx.connection`、`ctx.llm`、`ctx.settings` 等宿主服务，Client 通过 `window.__ModuleLoader__` 注册槽位组件。**两半的加载方式不同，验证方式也不同**：
+
+| 改了什么 | 生效方式 | 要不要重启宿主 |
+| --- | --- | --- |
+| `client.js`（按钮、交互、提示文案、样式） | client HMR 每 500ms 轮询前端 bundle，变更经 `/plugins/events` 推送，窗口就地替换该插件条目 | 不要；刷新窗口只是兜底 |
+| `index.js`、`*-rules.mjs`（增强接口、提示词规则、设置存储） | 宿主启动时一次性 import | 要 |
+
+client HMR 由 `@deepseek-ai/dsh-client-hmr` 提供，Web 组合里始终挂载；它与宿主侧的 `hmr` 是两套东西——本机 profile 把宿主 `hmr` 设成了 `disabled: true`（见 `cordis.patch.yml` 里的注释），所以宿主**代码**没有热重载。设置页里改的配置项仍会立即生效（走设置服务，不经文件监听）；手工改 `cordis.patch.yml` 才需要重启。
 
 **单元测试未随本仓库发布。** 开发期测试依赖宿主私有的 `@deepseek-ai/schemastery`、宿主 React 副本与本机 profile 目录结构，直接开源会让使用者拿到跑不起来的文件。