Compare commits
5
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
e59be4d983 | ||
|
|
09114e210f | ||
|
|
f0c11176f2 | ||
|
|
2097aeaa76 | ||
|
|
2f38b7ea3c |
+11
@@ -0,0 +1,11 @@
|
|||||||
|
# <emoji> <type>[(scope)][!]: <中文描述,一句话,不加句号>
|
||||||
|
# 一条提交信息只有这一行,不写正文,也不写脚注。
|
||||||
|
# 破坏性变更只用 ! 标记,例如:♻️ refactor!: 改掉了某某行为
|
||||||
|
# 需要交代背景时,把说明写进 README.md、CHANGELOG.md、CONTRIBUTING.md 或代码注释。
|
||||||
|
#
|
||||||
|
# 类型与 emoji:feat ✨ / fix 🐛 / docs 📝 / refactor ♻️ / perf ⚡️ /
|
||||||
|
# test ✅ / build 📦️ / ci 💚 / chore 🔧 / revert ⏪️
|
||||||
|
# 作用域(可选):client 浏览器半 / host 宿主半
|
||||||
|
# 例:✨ feat(client): 后台走系统通知,前台走应用内轻弹窗
|
||||||
|
# 例:🐛 fix(client): 前台判定改为现读可见性
|
||||||
|
# 例:📝 docs: 安装说明补充 Git 标签与本地路径两种方式
|
||||||
@@ -0,0 +1,35 @@
|
|||||||
|
# 变更记录
|
||||||
|
|
||||||
|
版本说明按倒序排列。提交信息遵循 [CONTRIBUTING.md](CONTRIBUTING.md) 的单行规范,因此每次改动"为什么这样改、影响面是什么"记在这里,而不是提交信息里。
|
||||||
|
|
||||||
|
## v1.0.5
|
||||||
|
|
||||||
|
- 修复:**应用在后台时不发系统通知**。前台/后台以前只靠 `window` 的 `focus`/`blur` 事件记住,桌面外壳里 `blur` 可能不到,插件就一直以为窗口在前台,于是走了轻弹窗分支(而用户没在看,表现就是完全没有通知)。现在每次投递都现读 `document.visibilityState` 与 `document.hasFocus()`,任一表示不可见即走系统通知;观察器订阅的事件只是让重算更及时,不再决定通道。
|
||||||
|
- 系统通知构造失败时降级:改用轻弹窗,并把被拒原因写进插件页,不再静默失败。
|
||||||
|
- 插件页新增诊断:窗口当前状态(前台/后台,即会走哪条通道)、观察器健康、最近一次投递的通道与时间;「测试系统通知」按钮直接走系统通道(前台也照发),用来单独验证系统通知是否可用。
|
||||||
|
- 修掉日志前缀重复(`session-notify: session-notify:`)。
|
||||||
|
|
||||||
|
## v1.0.4
|
||||||
|
|
||||||
|
- 配置块去掉重复:插件页顶部已经有 DSH 渲染的插件标题与描述,原配置块又写了一遍标题和几乎一样的说明。现在这一段直接用一句「提醒是怎么送出去的」开头,随后进入设置项。
|
||||||
|
- 移除未使用的字典键 `config.title` / `config.note`,保证字典里没有死键。
|
||||||
|
|
||||||
|
## v1.0.3
|
||||||
|
|
||||||
|
- 设置从「设置 → 通用」移到插件自己的介绍页:注册 `plugins.bundle.config`(key 取包名),与官方 `dsh-experimental-voice-input-bundle` 用的是同一个口子;通用设置里不再有本插件的行。
|
||||||
|
- 应用内轻弹窗改成标题 + 描述两行:标题是提醒类型(会话已完成 / 需要授权 / 需要回答),描述是会话题目与细节;关闭按钮从 18px 放大到 28px 的方形热区,「查看」改成有 hover 背景的文字按钮,整条浮窗 hover 时暂停自动消失。
|
||||||
|
- 三个开关改为存浏览器本地(`localStorage`),重开页面、重装插件都保留;仍然不写 DSH 的配置文件。
|
||||||
|
- 插件页配置分四段:说明、提醒内容(三个开关)、系统通知权限、运行状态。
|
||||||
|
|
||||||
|
## v1.0.2
|
||||||
|
|
||||||
|
- 补上 `ctx.locale.register('session-notify', { zh, en })`:没有注册时 `locale.bind(ns)` 会把 key 原样返回,界面上就显示成 `settings.title` 这样的原始键。
|
||||||
|
- 字典兜底与 locale 兜底同时保留:缺框架的 `t`、或 locale 服务没保存注册,都不会显示原始键。
|
||||||
|
- 快照语言字段改为真实字段 `snapshot.active`。
|
||||||
|
|
||||||
|
## v1.0.1
|
||||||
|
|
||||||
|
- 首个发布版本:会话完成 / 需要授权 / 需要回答三类提醒。
|
||||||
|
- 窗口不在前台走系统通知(Windows / macOS / Linux 同一条渲染进程通道,无平台分支);窗口在前台走应用内轻弹窗;正在看的那个会话完成时不打扰。
|
||||||
|
- 只对「运行中 → 空闲」的转变提醒,同一会话同一轮只报一次,同一待处理请求只报一次;子智能体会话与空白会话跳过;多个会话同时完成有 1.5 秒节流,完成提醒前有 400ms 确认窗口。
|
||||||
|
- 修复:无渲染观察器原先挂在 `sidebar.panellist`,而该 slot 的宿主会把每个条目的 id 当作一个左侧面板按钮,导致左侧多出一行空面板并挤坏侧边栏;现改挂通用浮层 `shell.overlay`。
|
||||||
+103
@@ -0,0 +1,103 @@
|
|||||||
|
# 提交信息规范
|
||||||
|
|
||||||
|
本仓库的提交信息遵循 [Conventional Commits](https://www.conventionalcommits.org/) 的**首行**结构,并在行首加一个 emoji 做视觉标记。**描述用中文**,类型关键字、作用域保持英文。
|
||||||
|
|
||||||
|
## 格式
|
||||||
|
|
||||||
|
**一条提交信息只有一行**,没有正文,也没有脚注:
|
||||||
|
|
||||||
|
```text
|
||||||
|
<emoji> <type>[(scope)][!]: <中文描述>
|
||||||
|
```
|
||||||
|
|
||||||
|
- `<emoji>`:下面表格里该类型对应的 emoji,后面跟**一个空格**。emoji 是必需的,且必须与本行类型一致——`📝 docs:` 对,`✨ docs:` 不对。
|
||||||
|
- `<type>`:小写英文关键字,见下表。
|
||||||
|
- `(scope)`:可选,改动范围。用 `()` 包住一个简短英文标识,例如 `fix(client)`、`fix(host)`、`docs(ci)`。
|
||||||
|
- `!`:可选,紧跟在 type 或 scope 之后、冒号之前,表示破坏性变更。
|
||||||
|
- `<描述>`:中文,一句话,讲清这次改动做了什么;不换行、不用列表、不加句号。宽度不超过 72(中文字符按 2 个宽度算)。
|
||||||
|
|
||||||
|
**不要写正文,也不要写脚注。** 连 `Refs:` / `Closes:` / `BREAKING CHANGE:` 这类尾注也不写——需要交代的"为什么""影响面""迁移注意事项",写进 [README.md](README.md)、[CHANGELOG.md](CHANGELOG.md) 或本文件,或写进代码注释,让说明跟着代码走,而不是埋在 `git log` 里。
|
||||||
|
|
||||||
|
**破坏性变更只靠 `!` 标记**(例如 `♻️ refactor!: …`)。这一条是对 Conventional Commits 的有意偏离:它要求破坏性变更必须有 `BREAKING CHANGE:` 脚注,本仓库不写脚注,所以判断破坏性变更以 `!` 为准。
|
||||||
|
|
||||||
|
如果确实需要多行说明,说明这次改动不该只用一个提交标题交代——先补文档(这个插件的版本级说明进 [CHANGELOG.md](CHANGELOG.md)),再提交。
|
||||||
|
|
||||||
|
## 类型与 emoji
|
||||||
|
|
||||||
|
| 类型 | emoji | 码位 | 用途 |
|
||||||
|
| --- | --- | --- | --- |
|
||||||
|
| `feat` | ✨ | `U+2728` | 新增功能 |
|
||||||
|
| `fix` | 🐛 | `U+1F41B` | 修复缺陷 |
|
||||||
|
| `docs` | 📝 | `U+1F4DD` | 只改文档 |
|
||||||
|
| `refactor` | ♻️ | `U+267B U+FE0F` | 重构,行为不变 |
|
||||||
|
| `perf` | ⚡️ | `U+26A1 U+FE0F` | 性能优化 |
|
||||||
|
| `test` | ✅ | `U+2705` | 变更测试 |
|
||||||
|
| `build` | 📦️ | `U+1F4E6 U+FE0F` | 构建系统或依赖 |
|
||||||
|
| `ci` | 💚 | `U+1F49A` | CI 配置 |
|
||||||
|
| `chore` | 🔧 | `U+1F527` | 杂项,以上都不属于时用 |
|
||||||
|
| `revert` | ⏪️ | `U+23EA U+FE0F` | 回滚某次提交,正文写 `Refs: <被回滚的提交>` |
|
||||||
|
|
||||||
|
**复制上表里的 emoji,不要手敲。** 带 `U+FE0F` 的那五个是「基础字符 + 变体选择符」两个码位,手敲时很容易只打出前一个字符;对工具来说 `♻`(`U+267B`)和 `♻️`(`U+267B U+FE0F`)是两个不同的字符串,比对会失败。写规范或写脚本时,比较 emoji 前先做一次 NFC 归一化,或把两边都按 `\uFE0F?` 处理。
|
||||||
|
|
||||||
|
## 作用域约定
|
||||||
|
|
||||||
|
这个插件只有一个包,作用域用来区分改动落在哪一半,不是必需的:
|
||||||
|
|
||||||
|
- `client`:浏览器半(`client.js`)—— 通知引擎、轻弹窗、插件页配置、观察器;
|
||||||
|
- `host`:宿主半(`index.js`、`cordis.patch.yml`)—— 目前是空壳,只有它变化时才需要重启 DSH;
|
||||||
|
- 其它临时作用域(如 `deps`、`naming`)按需起,不必登记。
|
||||||
|
|
||||||
|
## 示例
|
||||||
|
|
||||||
|
每条都是一整条提交信息,就这一行:
|
||||||
|
|
||||||
|
```text
|
||||||
|
✨ feat(client): 后台走系统通知,前台走应用内轻弹窗
|
||||||
|
```
|
||||||
|
|
||||||
|
```text
|
||||||
|
🐛 fix(client): 前台判定改为现读可见性,不再只信 blur 事件
|
||||||
|
```
|
||||||
|
|
||||||
|
带作用域与破坏性标记(破坏性变更**没有**脚注,只看 `!`):
|
||||||
|
|
||||||
|
```text
|
||||||
|
♻️ refactor(client)!: 配置从通用设置挪到插件页
|
||||||
|
```
|
||||||
|
|
||||||
|
```text
|
||||||
|
📝 docs: 安装说明补充 Git 标签与本地路径两种方式
|
||||||
|
```
|
||||||
|
|
||||||
|
## 工具链提示
|
||||||
|
|
||||||
|
emoji 在行首是本仓库的有意选择,视觉上整齐。代价是:以类型前缀开头的解析工具(`commitlint`、`semantic-release`、`release-please` 等)会读不到类型。如果以后要接这类工具,有两条路:
|
||||||
|
|
||||||
|
1. 把 emoji 挪到冒号之后(`feat: ✨ 描述`),类型回到行首,规范其余部分不变;
|
||||||
|
2. 保留行首 emoji,给工具写一个剥掉开头 emoji 与空格的预处理。可用的正则(`\p{Extended_Pictographic}` 已覆盖带与不带变体选择符两种写法):
|
||||||
|
|
||||||
|
```text
|
||||||
|
^(?:\p{Extended_Pictographic}\uFE0F?\s+)?(?<type>[a-z]+)(?:\((?<scope>[^)]*)\))?(?<breaking>!)?:\s(?<desc>.+)$
|
||||||
|
```
|
||||||
|
|
||||||
|
## 自查
|
||||||
|
|
||||||
|
`scripts/check-commit-log.mjs` 会按本规范检查现有提交,只报告、不拦提交。除了首行格式,它还会报出**任何带正文或脚注的提交**:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
node scripts/check-commit-log.mjs # 最近 10 条
|
||||||
|
node scripts/check-commit-log.mjs all # 全部
|
||||||
|
DN_SPEC=path/to/CONTRIBUTING.md node scripts/check-commit-log.mjs # 换一份规范文件(可选)
|
||||||
|
```
|
||||||
|
|
||||||
|
它从本文件的类型表里读 emoji 对照表,所以改了表不用改脚本。
|
||||||
|
|
||||||
|
## 启用提交模板(可选)
|
||||||
|
|
||||||
|
`.gitmessage` 是提交信息模板。启用后每次 `git commit` 会带上前缀提示:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git config commit.template .gitmessage
|
||||||
|
```
|
||||||
|
|
||||||
|
模板整份都是 `#` 开头的注释,git 会自动丢弃,所以直接 `git commit -m` 也不受影响。只对当前仓库生效;换机器要重新执行一次。
|
||||||
@@ -0,0 +1,88 @@
|
|||||||
|
// 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.
|
||||||
|
//
|
||||||
|
// Usage:
|
||||||
|
// node scripts/check-commit-log.mjs # newest 10 commits
|
||||||
|
// node scripts/check-commit-log.mjs 50 # newest 50 commits
|
||||||
|
// node scripts/check-commit-log.mjs all # every commit
|
||||||
|
// DSD_SPEC=path/to/CONTRIBUTING.md node scripts/check-commit-log.mjs
|
||||||
|
import { execFileSync } from 'node:child_process'
|
||||||
|
import { readFileSync } from 'node:fs'
|
||||||
|
import { dirname, resolve } from 'node:path'
|
||||||
|
import { fileURLToPath } from 'node:url'
|
||||||
|
|
||||||
|
const repoRoot = resolve(dirname(fileURLToPath(import.meta.url)), '..')
|
||||||
|
const specPath = process.env.DN_SPEC ?? resolve(repoRoot, 'CONTRIBUTING.md')
|
||||||
|
const doc = readFileSync(specPath, 'utf8')
|
||||||
|
const count = process.argv[2] ?? '10'
|
||||||
|
|
||||||
|
/** The regex the spec documents for a subject line. */
|
||||||
|
const SUBJECT = new RegExp(
|
||||||
|
'^(?:\\p{Extended_Pictographic}\\uFE0F?\\s+)?' +
|
||||||
|
'(?<type>[a-z]+)' +
|
||||||
|
'(?:\\((?<scope>[^)]*)\\))?' +
|
||||||
|
'(?<breaking>!)?' +
|
||||||
|
':\\s(?<desc>.+)$',
|
||||||
|
'u',
|
||||||
|
)
|
||||||
|
|
||||||
|
// The spec's table is the single source of truth for the type → emoji mapping,
|
||||||
|
// so a table edit cannot drift from what this script checks.
|
||||||
|
const emojiOfType = new Map()
|
||||||
|
for (const row of doc.split('\n').filter((line) => /^\| `[a-z]+` \| /.test(line))) {
|
||||||
|
const cells = row.split('|').map((cell) => cell.trim())
|
||||||
|
emojiOfType.set(cells[1].replaceAll('`', ''), cells[2])
|
||||||
|
}
|
||||||
|
if (emojiOfType.size === 0) throw new Error(`${specPath} has no type table to read`)
|
||||||
|
|
||||||
|
/** Strip the variation selector, so '♻' and '♻️' compare equal. */
|
||||||
|
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)
|
||||||
|
|
||||||
|
// %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 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)][!]: <描述>')
|
||||||
|
} else {
|
||||||
|
const expected = emojiOfType.get(match.groups.type)
|
||||||
|
const lead = [...subject][0]
|
||||||
|
if (expected === undefined) notes.push(`类型不在规范表里:${match.groups.type}`)
|
||||||
|
else if (base(lead) !== base(expected)) notes.push(`类型 ${match.groups.type} 的 emoji 应为 ${expected},实际是 ${lead}`)
|
||||||
|
const width = widthOf(subject)
|
||||||
|
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检查了 ${commits.length} 条提交,全部符合规范`
|
||||||
|
: `\n检查了 ${commits.length} 条提交,其中 ${problems} 条不符合规范(规范文件:${specPath})`)
|
||||||
|
process.exit(problems === 0 ? 0 : 1)
|
||||||
Reference in New Issue
Block a user