@klarkxy/dsh-git-commit 0.1.4 → 0.1.5

package/README.md

@@ -1,37 +1,65 @@
 # @klarkxy/dsh-git-commit
 
-Commit workspace changes to git without leaving the chat. Each conversation
-thread gets a **Commit** action in its header: click it, review the branch,
+Commit workspace changes to git without leaving the chat. Every conversation
+thread gets a **Commit** action in its header: click it, check the branch, the
 file count and the model that will be used, then confirm to commit every
 uncommitted path in the repository that contains the session's working
 directory.
 
+[简体中文](docs/README.zh-CN.md)
+
+## Install
+
+Requires Node.js ≥22. If your DSH distribution does not bundle this plugin,
+install it and enable its `git-commit` entry through the host plugin
+configuration.
+
+```sh
+npm install @klarkxy/dsh-git-commit
+```
+
+## How it works
+
 A model splits the change set into a small number of coherent commits with
 proper messages, then the groups are applied in order as path-scoped commits.
-The model route comes from
-[@klarkxy/dsh-ai-services](https://klarkxy.github.io/dsh-plugins/plugins/ai-services/):
-configure the **Git 提交** (`git-commit.plan`) purpose there in advance to pin
-a dedicated model; when nothing is configured, the request inherits the normal
-model tier and finally the default chat model. If the model call fails or
-returns an invalid plan, the changes land in one fallback commit instead.
+The model route comes from this plugin's own settings row: configure the
+**Commit planning model** there in advance to pin a dedicated model; when
+nothing is configured, the request follows the live session model and then the
+host default chat model. If the model call fails or returns an invalid plan,
+the run is **rejected** and nothing is staged or committed — a commit the model
+never planned is not one you asked for. The plugin page can opt back into the
+old behavior with **Commit even without a model plan**, which merges every
+change into a single commit with a plugin-written message.
+
+## Plugin page settings
+
+`Settings → Plugins → Git Commit` holds the rows this plugin needs.
+**Commit planning model** is optional: a saved route is used for the planning
+call as an explicit model, an empty selection follows the live session model
+and then the host default chat model, and the conversation header panel reports
+which of the two is in effect. Only that call is affected; a saved route selects
+a model, but it is not evidence of connectivity. **Commit even without a model
+plan** is off by default and only changes what happens when planning produces
+nothing.
 
 ## Usage
 
-1. Open a conversation whose workspace is inside a git repository.
+1. Open a conversation whose workspace sits inside a git repository.
 2. Click **Commit** in the thread header (top right).
-3. Confirm in the popover and wait for the run.
-4. The panel lists every commit created (hash + message).
+3. Confirm in the popover, then wait for the run to finish.
+4. The panel lists every commit it created (hash + message).
 
 The button is disabled while the session is running. The host checks again
-before committing and stops if the workspace changes during planning.
+before committing, and stops the run if the workspace changes during planning.
 
 ## Notes
 
 - Each selected file is committed from its current worktree content. Pre-staged
-  changes in other groups stay staged until their group is committed.
-- Untracked files are included; small text files get a content preview for the
-  model, binaries are listed by path only.
-- Commits never push; pushing stays a manual decision.
+  changes that belong to another group stay staged until that group is
+  committed.
+- Untracked files are included: small text files get a content preview for the
+  model, while binaries are listed by path only.
+- Commits never push. Pushing stays a manual decision.
 
 ## License
 

package/docs/README.zh-CN.md

@@ -1,29 +1,46 @@
 # @klarkxy/dsh-git-commit
 
-在对话里直接把工作区修改提交到 git。每个对话线程的右上角有一个 **提交** 按钮：
+在对话里直接把工作区修改提交到 git。每个对话线程的右上角都有一个 **提交** 按钮：
 点一下打开弹层，确认分支、文件数量和将使用的模型，再点一下即可把会话工作目录
 所在仓库的全部未提交改动分次提交。
 
-模型会把改动整理成若干个内聚的提交并生成提交信息，然后按顺序逐组创建限定路径的提交。模型路由由
-[@klarkxy/dsh-ai-services](https://klarkxy.github.io/dsh-plugins/plugins/ai-services/)
-提供：在「AI 服务」设置里提前给 **Git 提交**（`git-commit.plan`）用途配置专用模型；
-没有配置时依次回退到 normal 角色和默认对话模型。模型调用失败或返回非法分组时，
-改动会合并为一个兜底提交。
+[English](../README.md)
+
+## 安装
+
+需要 Node.js ≥22。若所用 DSH 发行版未内置本插件，可先安装，再通过宿主插件配置启用
+`git-commit` 入口：
+
+```sh
+npm install @klarkxy/dsh-git-commit
+```
+
+## 工作方式
+
+模型会把改动整理成若干个内聚的提交并生成提交信息，然后按顺序逐组创建限定路径的提交。模型路由由本插件自己的设置行提供：在「设置 → 插件 → Git 提交」提前配置**提交规划模型**即可固定专用模型；没有配置时依次使用当前会话模型和宿主默认对话模型。模型调用失败或返回非法分组时，本次提交会被**拒绝**，不会暂存也不会提交任何内容——模型没有规划过的提交不是你要求的提交。想要回到旧行为，可以在插件页打开**模型不可用时仍然提交**，此时全部改动会合并成一个提交，由插件代写提交信息。
+
+## 插件页设置
+
+「设置 → 插件 → Git 提交」下是本插件需要的设置项。**提交规划模型**用于提交规划调用，
+可留空：保存某个路由后，对应该调用会使用这个显式模型；留空则使用当前会话模型，
+再回落到宿主默认对话模型。对话头部面板会显示实际生效的是哪一种。只有这个调用受影响；
+保存路由只表示选定模型，不代表已连通。**模型不可用时仍然提交**默认关闭，只在
+规划完全没有产出时改变行为。
 
 ## 使用
 
 1. 打开一个工作目录位于 git 仓库内的对话。
 2. 点击线程右上角的 **提交** 按钮。
-3. 在弹层里确认并等待执行完成。
+3. 在弹层里确认，然后等待执行完成。
 4. 面板会列出创建的每个提交（哈希 + 信息）。
 
-会话运行期间按钮不可用。宿主在提交前还会再次检查，规划期间工作区变化时会中止。
+会话运行期间按钮不可用。宿主在提交前还会再检查一次，规划期间工作区发生变化时会中止本次提交。
 
 ## 说明
 
-- 每个选中文件按当前工作区内容提交。其他分组的已暂存修改会保留到对应分组提交。
-- 未跟踪文件也会提交；较小的文本文件会把内容预览发给模型，二进制文件只列路径。
-- 插件只做 commit，不会 push。
+- 每个选中文件按当前工作区内容提交。属于其他分组的已暂存修改会保留到对应分组提交。
+- 未跟踪文件也会提交：较小的文本文件会把内容预览发给模型，二进制文件只列路径。
+- 插件只做 commit，不会 push；push 仍由你手动决定。
 
 ## 许可证