Compare commits
4
Commits
83eae74f63
..
main
| Author | SHA1 | Date | |
|---|---|---|---|
 pyh
|
4e7c501b11 | ||
|
pyh
|
6b5cdd89e6 | ||
|
pyh
|
7b29e900f7 | ||
|
pyh
|
b977f57fa4 |
+6
-6
@@ -1,10 +1,10 @@
|
||||
# <emoji> <type>[(scope)][!]: <中文描述，不超过 72 宽度，不加句号>
|
||||
# <emoji> <type>[(scope)][!]: <中文描述，一句话，不加句号>
|
||||
# 一条提交信息只有这一行，不写正文，也不写脚注。
|
||||
# 破坏性变更只用 ! 标记，例如：♻️ refactor!: 改掉了某某行为
|
||||
# 需要交代背景时，把说明写进 README.md、CONTRIBUTING.md 或代码注释。
|
||||
#
|
||||
# 类型与 emoji：feat ✨ / fix 🐛 / docs 📝 / refactor ♻️ / perf ⚡️ /
|
||||
# test ✅ / build 📦️ / ci 💚 / chore 🔧 / revert ⏪️
|
||||
# 例：✨ feat(client): 会话行悬停区加删除按钮
|
||||
# 例：🐛 fix(host): 延迟删除台账只记录根会话
|
||||
#
|
||||
# ↓ 正文（可省略）：为什么这么改、影响面、迁移注意事项，每行不超过 72 宽度
|
||||
#
|
||||
#
|
||||
# ↓ 脚注（可省略）：Refs: #12 / Closes: #34 / BREAKING CHANGE: <中文说明>
|
||||
# 例：📝 docs(ci): 安装说明只保留 Git 标签与本地 tgz
|
||||
|
||||
+17
-28
@@ -1,24 +1,26 @@
|
||||
# 提交信息规范
|
||||
|
||||
本仓库的提交信息遵循 [Conventional Commits](https://www.conventionalcommits.org/) 的结构，并在行首加一个 emoji 做视觉标记。**描述用中文**，类型关键字、作用域、脚注关键字保持英文。
|
||||
本仓库的提交信息遵循 [Conventional Commits](https://www.conventionalcommits.org/) 的**首行**结构，并在行首加一个 emoji 做视觉标记。**描述用中文**，类型关键字、作用域保持英文。
|
||||
|
||||
## 格式
|
||||
|
||||
**一条提交信息只有一行**，没有正文，也没有脚注：
|
||||
|
||||
```text
|
||||
<emoji> <type>[(scope)][!]: <描述>
|
||||
<空行>
|
||||
[正文：为什么这么改、影响面、迁移注意事项]
|
||||
<空行>
|
||||
[脚注：Refs: #12 / Closes: #34 / BREAKING CHANGE: ...]
|
||||
<emoji> <type>[(scope)][!]: <中文描述>
|
||||
```
|
||||
|
||||
- `<emoji>`：下面表格里该类型对应的 emoji，后面跟**一个空格**。emoji 是必需的，且必须与本行类型一致——`📝 docs:` 对，`✨ docs:` 不对。
|
||||
- `<type>`：小写英文关键字，见下表。
|
||||
- `(scope)`：可选，改动范围。用 `()` 包住一个简短英文标识，例如 `docs(ci)`、`fix(client)`、`feat(host)`。
|
||||
- `!`：可选，紧跟在 type 或 scope 之后、冒号之前，表示破坏性变更。
|
||||
- `<描述>`：中文，一句话，讲清这次改动做了什么。**首行不超过 72 个字符**（中文字符按 2 个宽度算），结尾不加句号。
|
||||
- 正文：中文，每行不超过 72 个宽度。说清"为什么"，不要复述 diff。单行描述足以讲明白时就省略。
|
||||
- 脚注：破坏性变更必须写 `BREAKING CHANGE: <中文说明>`，不能只靠 `!`。
|
||||
- `<描述>`：中文，一句话，讲清这次改动做了什么；不换行、不用列表、不加句号。宽度不超过 72（中文字符按 2 个宽度算）。
|
||||
|
||||
**不要写正文，也不要写脚注。** 连 `Refs:` / `Closes:` / `BREAKING CHANGE:` 这类尾注也不写——需要交代的"为什么""影响面""迁移注意事项"，写进 [README.md](README.md) 或本文件，或写进代码注释，让说明跟着代码走，而不是埋在 `git log` 里。
|
||||
|
||||
**破坏性变更只靠 `!` 标记**（例如 `♻️ refactor!: …`）。这一条是对 Conventional Commits 的有意偏离：它要求破坏性变更必须有 `BREAKING CHANGE:` 脚注，本仓库不写脚注，所以判断破坏性变更以 `!` 为准。
|
||||
|
||||
如果确实需要多行说明，说明这次改动不该只用一个提交标题交代——先补文档，再提交。
|
||||
|
||||
## 类型与 emoji
|
||||
|
||||
@@ -39,35 +41,22 @@
|
||||
|
||||
## 示例
|
||||
|
||||
新增功能：
|
||||
每条都是一整条提交信息，就这一行：
|
||||
|
||||
```text
|
||||
✨ feat(client): 会话行悬停区加删除按钮
|
||||
|
||||
官方 archive 与 pin 两个悬停按钮保持原位，本插件的删除按钮插在两者
|
||||
之间，不再借用 archive 的 id 压级替换。
|
||||
```
|
||||
|
||||
修复缺陷：
|
||||
|
||||
```text
|
||||
🐛 fix(host): 延迟删除台账只记录根会话
|
||||
|
||||
台账原先记录整棵树，但启动清扫以根为单位整棵删除，导致子会话被重复
|
||||
删除并重复广播 api-session/removed。
|
||||
```
|
||||
|
||||
破坏性变更：
|
||||
带作用域与破坏性标记（破坏性变更**没有**脚注，只看 `!`）：
|
||||
|
||||
```text
|
||||
♻️ refactor!: 行内按钮改用自己的槽位 id
|
||||
|
||||
BREAKING CHANGE: 悬停区布局变化，官方归档按钮回到原来的位置。按住旧
|
||||
结构写样式的用户需要调整。
|
||||
♻️ refactor(client)!: 行内按钮改用自己的槽位 id
|
||||
```
|
||||
|
||||
纯文档：
|
||||
|
||||
```text
|
||||
📝 docs: 安装说明改为只走 Git 标签与本地 tgz
|
||||
```
|
||||
@@ -85,7 +74,7 @@ emoji 在行首是本仓库的有意选择，视觉上整齐。代价是：以
|
||||
|
||||
## 自查
|
||||
|
||||
`scripts/check-commit-log.mjs` 会按本规范检查现有提交的首行，只报告、不拦提交：
|
||||
`scripts/check-commit-log.mjs` 会按本规范检查现有提交，只报告、不拦提交。除了首行格式，它还会报出**任何带正文或脚注的提交**：
|
||||
|
||||
```bash
|
||||
node scripts/check-commit-log.mjs # 最近 10 条
|
||||
@@ -96,10 +85,10 @@ node scripts/check-commit-log.mjs all # 全部
|
||||
|
||||
## 启用提交模板（可选）
|
||||
|
||||
`.gitmessage` 是提交信息模板。启用后每次 `git commit` 会带上前缀提示，删掉不需要的部分即可：
|
||||
`.gitmessage` 是提交信息模板。启用后每次 `git commit` 会带上前缀提示：
|
||||
|
||||
```bash
|
||||
git config commit.template .gitmessage
|
||||
```
|
||||
|
||||
模板里以 `#` 开头的行会被 git 自动丢弃，不会进入提交信息。只对当前仓库生效；换机器要重新执行一次。
|
||||
模板整份都是 `#` 开头的注释，git 会自动丢弃，所以直接 `git commit -m` 也不受影响。只对当前仓库生效；换机器要重新执行一次。
|
||||
|
||||
@@ -2,13 +2,13 @@
|
||||
|
||||
DeepSeek Harness（DSH）插件：给会话加上**真正不可逆的删除**，并清理已删除会话遗留的临时文件。
|
||||
|
||||
DSH 原本只能归档会话——归档只是把会话从列表里移开，日志仍然留在磁盘上（DSH 官方的 JSONL 会话存储后端明确写着「没有任何东西会删除会话文件，日志会一直堆在 root 下直到被外部移除」，会话存储契约里也没有删除 API）。这个插件补上的正是这一块：两处删除入口，以及设置页里的一次性孤儿文件清理。
|
||||
DSH 原本只能归档会话——归档只是把会话从列表里移开，日志仍然留在磁盘上，越堆越多。这个插件补上的正是这一块：两处删除入口，以及插件页上的临时文件清理。
|
||||
|
||||
## 功能
|
||||
|
||||
### 1. 删除会话
|
||||
|
||||
两个入口，行为一致，都会先弹出确认弹窗（复刻系统 Modal 的样式与键盘行为：Esc 关闭、Tab 焦点圈定、打开时焦点进入、关闭后焦点归位）：
|
||||
两个入口，行为一致，都会先弹出确认弹窗（Esc 关闭、Tab 焦点圈定、打开时焦点进入、关闭后焦点归位）：
|
||||
|
||||
- 会话行右侧 **⋯** 菜单 → **删除会话**
|
||||
- 会话行悬停时的 🗑 按钮（在官方的「归档」「置顶」之前，是悬停区的第一个按钮）
|
||||
@@ -17,37 +17,35 @@ DSH 原本只能归档会话——归档只是把会话从列表里移开，日
|
||||
|
||||
| 对象 | 处理方式 |
|
||||
| --- | --- |
|
||||
| 会话日志目录 | 整个删除，仅保留 `session.lock` |
|
||||
| 子智能体会话 | 按血缘递归收集，连同日志与溢出文件一并删除 |
|
||||
| 工具输出溢出文件（spill） | 删除该会话（含子会话）对应的 spill 目录 |
|
||||
| 会话日志 | 整个删除 |
|
||||
| 子智能体会话 | 递归找出它的全部子会话，连同日志与临时文件一并删除 |
|
||||
| 工具输出的溢出临时文件 | 删除该会话（含子会话）对应的目录 |
|
||||
| 工作区登记项 | 解除绑定、取消置顶、取消归档 |
|
||||
| 客户端列表 | 广播 `api-session/removed`，列表行立即消失 |
|
||||
| 会话列表 | 该行立即消失 |
|
||||
|
||||
有意**不**处理：
|
||||
有意**不**删除：
|
||||
|
||||
- **附件对象**（`$DSH_HOME/attachments/v1/objects`）：按内容 sha256 寻址，同一份内容可能被多个会话共享，而 DSH 没有引用计数，跟着一个会话删除会破坏别的会话；
|
||||
- **投影缓存**（`$DSH_HOME/storages/session_projcache`）：由日志派生的缓存，读取时带生命周期身份校验，永远不会串到别的会话。
|
||||
- **附件**：同一份内容可能被多个会话共用，DSH 没有引用计数，跟着一个会话删除会破坏别的会话；
|
||||
- **派生缓存**：由日志生成，读取时带会话身份校验，不会串到别的会话。
|
||||
|
||||
### 2. 清理临时文件
|
||||
|
||||
**设置 → 插件 → 会话彻底删除**（点会话彻底删除那一行右侧的配置按钮），清理 spill 后端留下的**孤儿**目录。判定偏保守：
|
||||
**设置 → 插件 → 会话彻底删除**，打开插件页就能看到。它清理的是**孤儿**临时文件——那些属于已经不存在会话的工具输出溢出目录。判定偏保守：
|
||||
|
||||
1. 目录名必须精确等于 `session-<sha256(会话 id) 前 12 位>`——这是 spill 后端唯一会生成的形状；
|
||||
2. 该名字不属于任何已知会话（`sessionQuery.listSessions()` 已经把存量会话与内存中正在运行的会话合并成同一份语料，所以「已知」只需要一个来源）；
|
||||
3. 只在 spill 的 root 内操作（后端当前 root + 系统临时目录下的 `dsh-spill*`）；
|
||||
1. 只认 DSH 生成溢出目录时的固定命名（`session-` 加会话 id 哈希的前 12 位），形状不符的一概不动；
|
||||
2. 该名字不属于任何已知会话（磁盘上的与正在运行的都算）；
|
||||
3. 只在 DSH 的临时目录范围内操作；
|
||||
4. 符号链接一律跳过、不跟随；单项失败只记警告。
|
||||
|
||||
结果直接显示在该页（清理了几个目录、几个文件、释放多少空间），可反复点击。
|
||||
|
||||
这个页面占的是 `plugins.row.config` 槽位——和官方插件「终端」的配置页是同一个位置。注册了这个槽位的 key（`<包名>#<行 id>`）之后，插件行就会长出配置入口，所以本插件不声明 `Config` 也能有自己的页面。
|
||||
结果直接显示在页面上（清理了几个目录、几个文件、释放多少空间），可反复点击。
|
||||
|
||||
## 行为与边界
|
||||
|
||||
- **仍在运行的会话**无法被插件从内存里移除：它会先被归档并停止，日志与溢出文件在**下次启动 DSH 时**删除（界面会明确提示）；在此之前取消归档就会取消这次删除。
|
||||
- **仍在运行的会话**无法被插件从内存里移除：它会先被归档并停止，日志与临时文件在**下次启动 DSH 时**删除（界面会明确提示）；在此之前取消归档就会取消这次删除。
|
||||
- 删除**不可恢复**，但**不是安全擦除**：按普通文件删除处理，底层介质上可能有残留。
|
||||
- 工作区里的代码文件不受影响。
|
||||
- 溢出文件被删除后，fork 出来的会话日志里若仍保留指向它的路径文本，那些路径会失效。
|
||||
- 行内按钮的悬停气泡由按钮自身定位。指针停在会话行上时，行自己的悬停预览卡可能和这个气泡同时出现——插件不会去动宿主的行 DOM 来避免这一点（那是插件不该依赖的自有渲染结构）。若观感不能接受，可把气泡改为只在键盘 focus 时显示：删掉 `DeleteSessionRowButton` 里的 `onMouseEnter: show` / `onMouseLeave: hide` 两行即可。
|
||||
- 临时文件被删除后，fork 出来的会话日志里若仍保留指向它的路径文本，那些路径会失效。
|
||||
- 指针停在会话行上时，删除按钮的气泡可能和会话行自带的悬停预览卡同时出现。
|
||||
|
||||
## 安装
|
||||
|
||||
@@ -61,38 +59,24 @@ DSH 的 **插件 → 添加插件** 里有两个输入，含义不同：
|
||||
在上面的输入框里填：
|
||||
|
||||
```text
|
||||
https://gitea.iwake.top/dsh-plugin/session-delete.git#v2.0.0
|
||||
https://gitea.iwake.top/dsh-plugin/session-delete.git#v2.0.2
|
||||
```
|
||||
|
||||
`#` 后面可以跟标签或提交，用来锁定版本；不写则取默认分支。仓库是公开的，不需要凭据，也不需要改安装源。
|
||||
|
||||
想跟随 2.x 的最新版本，可以把后缀写成 `#semver:^2.0.0`——pnpm 会按仓库里的标签挑最高的 2.x，以后发了 v2.0.1，移除旧版本再装一次就能拿到。
|
||||
想跟随 2.x 的最新版本，可以把后缀写成 `#semver:^2.0.2`——以后发了新版本，移除旧版本再装一次就能拿到。
|
||||
|
||||
### 2. 本地 tgz
|
||||
|
||||
把仓库打包成 tgz（例如在仓库目录执行 `npm pack`，得到 `dsh-plugin-session-delete-2.0.0.tgz`），把它在运行 DSH 那台机器上的绝对路径填进上面的输入框。
|
||||
把仓库打包成 tgz（得到 `dsh-plugin-session-delete-2.0.2.tgz`），把它在运行 DSH 那台机器上的绝对路径填进上面的输入框。
|
||||
|
||||
### 升级
|
||||
|
||||
DSH 暂不支持插件自动更新，升级就是用新标签重装一次（建议先移除旧版本）。安装或升级后：**宿主半变更需要重启 DSH**（完全退出再打开，仅关闭窗口不一定退出进程）；只改浏览器半时刷新页面即可。
|
||||
|
||||
如果你是在本地开发这个插件（profile 里装的是 `link:` 到工作目录），**光刷新页面看不到改动**：profile 的 `node_modules` 里可能是一份与源码同 inode 的硬链接副本，需要移除再重装一次插件，让 profile 重新取一份。
|
||||
DSH 暂不支持插件自动更新，升级就是用新标签重装一次（建议先移除旧版本）。装好后刷新页面即可生效。
|
||||
|
||||
## 兼容性
|
||||
|
||||
基于 **DeepSeek Harness 0.2.0-rc.2** 编写。DSH 仍在演进，其它版本与平台组合未逐一验证。
|
||||
|
||||
- **浏览器半**不 import 任何 Harness 客户端包（上游规范如此要求：这些包随时可能变化，渲染抛错会让整个插槽条目变空白），而是复刻 `dsh-client-ui-primitives` 的 markup、CSS 声明、图标 path 数据与键盘行为，只保留 `--dsw-*` 主题 token 引用。它**不读写宿主的 DOM**，也不占用官方槽位：行内按钮用自己的 id 与官方「归档」「置顶」并列，不是顶替。上游若改动这些内部结构，界面细节可能失配（例如悬停气泡不再出现），但不会导致插件加载失败。
|
||||
- **宿主半**只依赖稳定的服务契约：`sessionQuery`（`traceSession` 取血缘、`listSessions` 取语料）、`sessionPersistence`（含其 JSONL 后端的 `locate()` 诊断钩子，用于定位会话目录）、`workspaceRegistry`、`connection.fetch`（注册受认证的 exact 路由），以及 spill 后端的目录规则。
|
||||
- **跨半边通信**走 `connection.fetch` 注册的 `POST /api/plugin/session-delete/delete` 与 `.../orphans` 两条路由，浏览器半用文档相对路径请求（支持挂载前缀）。这是静态客户端包与宿主半通信的正规通道；`host.call` 属于动态客户端运行器，不适用于包形式的插件。
|
||||
|
||||
## 贡献
|
||||
|
||||
提交信息用「emoji + Conventional Commits + 中文描述」，规则、类型表和示例见 [CONTRIBUTING.md](CONTRIBUTING.md)。想省事可以让 git 带上模板：
|
||||
|
||||
```bash
|
||||
git config commit.template .gitmessage
|
||||
```
|
||||
基于 **DeepSeek Harness 0.2.0-rc.2** 编写，其它版本与平台组合未逐一验证。
|
||||
|
||||
## License
|
||||
|
||||
|
||||
@@ -8,11 +8,14 @@
|
||||
*
|
||||
* The temporary-file sweep is the plugin's other operation, and it lives on
|
||||
* this plugin's own page under Settings → Plugins: the entry registers into
|
||||
* `plugins.row.config` under the `<package name>#<row id>` key the manager
|
||||
* dispatches, which also gives the row its configure control. That is the same
|
||||
* seat a bundled plugin's configuration form occupies, so the plugin's only
|
||||
* control sits beside everything else the manager says about it instead of
|
||||
* taking a row in General settings.
|
||||
* `plugins.bundle.config` under this package's name, the page-level seat the
|
||||
* manager renders on a bundle's page between its description and its rows.
|
||||
*
|
||||
* That page-level seat is deliberate, not the row-level `plugins.row.config`
|
||||
* one. The row seat grows a configure control on the row listed under
|
||||
* 「包含的组件」 and nothing else, so it parks this plugin's one and only control
|
||||
* one click deeper than the page the user just opened; the page seat puts it
|
||||
* where the page is read.
|
||||
*
|
||||
* Two client-authoring rules shape this file:
|
||||
*
|
||||
@@ -44,15 +47,13 @@ window.__ModuleLoader__.load({
|
||||
/** Between the shipped `archive` (100) and `pin` (200) hover buttons. */
|
||||
const ROW_ACTION_ORDER = 150
|
||||
/**
|
||||
* The key `plugins.row.config` is dispatched under: the manager composes it
|
||||
* as `<package name>#<row id>`, with the row id read from this bundle's own
|
||||
* patch. Both halves are literals from `package.json` and
|
||||
* `cordis.patch.yml`; a typo costs the configure control silently, so they
|
||||
* are the only two places renaming has to reach.
|
||||
* The key `plugins.bundle.config` is dispatched under: the manager keys a
|
||||
* bundle's own configuration by its npm package name and renders the entry
|
||||
* on that bundle's page, between the description and the rows. The value is
|
||||
* the literal from `package.json` — a typo costs the section silently, so
|
||||
* it is the only place renaming has to reach.
|
||||
*/
|
||||
const PACKAGE = '@dsh-plugin/session-delete'
|
||||
const ROW_ID = 'session-delete'
|
||||
const CONFIG_KEY = `${PACKAGE}#${ROW_ID}`
|
||||
const TOOLTIP_DELAY_MS = 500
|
||||
const TOOLTIP_GAP = 8
|
||||
/** Document base captured at bundle registration, before any routing. */
|
||||
@@ -331,12 +332,12 @@ window.__ModuleLoader__.load({
|
||||
* This plugin's page under Settings → Plugins: sweep spilled tool output
|
||||
* whose conversation no longer exists.
|
||||
*
|
||||
* The owner asks every `plugins.row.config` entry for two views. `summary`
|
||||
* is the one-liner on the row, and this plugin's manifest description
|
||||
* already fills that seat, so `summary` renders nothing and the page keeps
|
||||
* the text the manager read from `locale/*.json`. `page` is the section the
|
||||
* manager renders with its own heading, breadcrumb, and title; copy,
|
||||
* control, and result belong to this entry.
|
||||
* The owner dispatches the `page` view only: a bundle's configuration has
|
||||
* no one-line form, because the page header already prints this package's
|
||||
* title and description from the manifest. So the section opens with the
|
||||
* operation's own name and the rule it applies — what the header cannot say
|
||||
* — and the guard below keeps rendering nothing if a `summary` view ever
|
||||
* arrives.
|
||||
*/
|
||||
function TempCleanupPanel(props) {
|
||||
const t = translate(props.t)
|
||||
@@ -650,12 +651,13 @@ window.__ModuleLoader__.load({
|
||||
}),
|
||||
}, DeleteSessionDialog))
|
||||
|
||||
// The cleanup control belongs on this plugin's own page: registering
|
||||
// this cell key is what makes the row grow a configure control, and the
|
||||
// manager renders the entry for both its summary and page views.
|
||||
ctx.slots.inject('plugins.row.config', () => ctx.slots.register({
|
||||
name: 'plugins.row.config',
|
||||
key: CONFIG_KEY,
|
||||
// The cleanup control belongs on this plugin's own page itself, not
|
||||
// behind the component row listed under 「包含的组件」:
|
||||
// `plugins.bundle.config` keyed by this package's name is the seat the
|
||||
// manager renders between the page's description and its rows.
|
||||
ctx.slots.inject('plugins.bundle.config', () => ctx.slots.register({
|
||||
name: 'plugins.bundle.config',
|
||||
key: PACKAGE,
|
||||
locale: NS,
|
||||
inject: () => ({ cleanOrphans }),
|
||||
}, TempCleanupPanel))
|
||||
|
||||
+5
-2
@@ -1,9 +1,9 @@
|
||||
{
|
||||
"name": "@dsh-plugin/session-delete",
|
||||
"version": "2.0.0",
|
||||
"version": "2.0.2",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"description": "Permanently delete a conversation: stop it, remove its session log, subagent logs, and spilled tool output, and drop every registry reference. Settings → General can sweep orphaned temporary files left by conversations that are gone.",
|
||||
"description": "Permanently delete a conversation: stop it, remove its session log, subagent logs, and spilled tool output, and drop every registry reference. The plugin's own page under Settings → Plugins can sweep orphaned temporary files.",
|
||||
"license": "MIT",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
@@ -28,6 +28,9 @@
|
||||
"icon.svg",
|
||||
"locale/*.json",
|
||||
"README.md",
|
||||
"CONTRIBUTING.md",
|
||||
".gitmessage",
|
||||
"scripts/**/*.mjs",
|
||||
"LICENSE"
|
||||
],
|
||||
"engines": {
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Checks real commit subjects (newest first) against the CONTRIBUTING.md spec:
|
||||
// the documented regex must parse them, the leading emoji must be present and
|
||||
// match the type table exactly, and the subject must stay within 72 width.
|
||||
// Checks existing commits against the CONTRIBUTING.md spec. The spec allows one
|
||||
// line only, so a subject must both parse (emoji + type + Chinese description)
|
||||
// and be the whole message: any body or footer is reported too.
|
||||
//
|
||||
// This is a reporting tool, not a hook: it never blocks a commit.
|
||||
//
|
||||
@@ -19,7 +19,7 @@ const specPath = process.env.DSD_SPEC ?? resolve(repoRoot, 'CONTRIBUTING.md')
|
||||
const doc = readFileSync(specPath, 'utf8')
|
||||
const count = process.argv[2] ?? '10'
|
||||
|
||||
/** The regex the spec documents for stripping a leading emoji. */
|
||||
/** The regex the spec documents for a subject line. */
|
||||
const SUBJECT = new RegExp(
|
||||
'^(?:\\p{Extended_Pictographic}\\uFE0F?\\s+)?' +
|
||||
'(?<type>[a-z]+)' +
|
||||
@@ -43,17 +43,29 @@ const base = (text) => text.replace(/\uFE0F/g, '')
|
||||
/** Display width, counting anything above U+2000 as double. */
|
||||
const widthOf = (text) => [...text].reduce((n, c) => n + (c.codePointAt(0) > 0x2000 ? 2 : 1), 0)
|
||||
|
||||
const args = count === 'all' ? ['log', '--format=%h%x09%s'] : ['log', `-${Number(count)}`, '--format=%h%x09%s']
|
||||
const rows = execFileSync('git', args, { encoding: 'utf8', cwd: repoRoot })
|
||||
.trim().split('\n').filter((line) => line !== '')
|
||||
// %B is the raw message body, so a record can hold several lines: a record ends
|
||||
// at the next hash that starts a line, which is what this splits on.
|
||||
const range = count === 'all' ? [] : [`-${Number(count)}`]
|
||||
const raw = execFileSync('git', ['log', ...range, '--format=%h%x09%B%x00'], {
|
||||
encoding: 'utf8',
|
||||
cwd: repoRoot,
|
||||
})
|
||||
|
||||
const commits = raw.split('\0').map((chunk) => chunk.replace(/^\n+/, '')).filter((chunk) => chunk.trim() !== '')
|
||||
|
||||
let problems = 0
|
||||
for (const row of rows) {
|
||||
const [hash, subject] = row.split('\t')
|
||||
for (const chunk of commits) {
|
||||
const tab = chunk.indexOf('\t')
|
||||
const hash = chunk.slice(0, tab)
|
||||
const message = chunk.slice(tab + 1).replace(/\n+$/, '')
|
||||
const lines = message.split('\n')
|
||||
const subject = lines[0]
|
||||
const extra = lines.slice(1).filter((line) => line.trim() !== '')
|
||||
const notes = []
|
||||
|
||||
const match = SUBJECT.exec(subject)
|
||||
if (match === null) {
|
||||
notes.push('缺少类型前缀，或整体格式不是 <emoji> <type>[(scope)][!]: <描述>')
|
||||
notes.push('首行缺少类型前缀，或整体格式不是 <emoji> <type>[(scope)][!]: <描述>')
|
||||
} else {
|
||||
const expected = emojiOfType.get(match.groups.type)
|
||||
const lead = [...subject][0]
|
||||
@@ -63,12 +75,14 @@ for (const row of rows) {
|
||||
if (width > 72) notes.push(`首行宽度 ${width}，超过 72`)
|
||||
if (/[。.]$/.test(subject)) notes.push('首行结尾不应有句号')
|
||||
}
|
||||
if (extra.length > 0) notes.push(`带了 ${extra.length} 行正文或脚注，规范要求只有一行`)
|
||||
|
||||
if (notes.length > 0) problems += 1
|
||||
const mark = notes.length === 0 ? 'ok ' : 'FAIL'
|
||||
console.log(` ${mark} ${hash} ${notes.length === 0 ? '' : notes.join('；') + ' — '}${subject}`)
|
||||
}
|
||||
|
||||
console.log(problems === 0
|
||||
? `\n检查了 ${rows.length} 条提交，全部符合规范`
|
||||
: `\n检查了 ${rows.length} 条提交，其中 ${problems} 条不符合规范（规范文件：${specPath}）`)
|
||||
? `\n检查了 ${commits.length} 条提交，全部符合规范`
|
||||
: `\n检查了 ${commits.length} 条提交，其中 ${problems} 条不符合规范（规范文件：${specPath}）`)
|
||||
process.exit(problems === 0 ? 0 : 1)
|
||||
|
||||
Reference in New Issue
Block a user