deep-read-summarize 0.3.16 → 0.3.17
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +25 -0
- package/docs/RELEASE.md +22 -2
- package/package.json +3 -1
- package/parsers/index.js +10 -2
- package/schemas/index.js +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,31 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
The format is based on [Keep a Changelog](https://keepachangelog.com/).
|
|
5
5
|
|
|
6
|
+
## [0.3.17] — 2026-10-20
|
|
7
|
+
|
|
8
|
+
修两个「对外暴露、内部没人盯着」的缺陷,并把发布流程自动化。
|
|
9
|
+
|
|
10
|
+
### Fixed
|
|
11
|
+
|
|
12
|
+
- **`parsers.resolve()` 在原型链名字上不回退**:它用裸方括号查表,于是 `resolve("constructor")` 返回 `Object` 构造函数、`resolve("toString")` 返回 `toString`、`resolve("__proto__")` 返回 `Object.prototype` —— 这些都没有 `buildPrompt`,调用方拿到的是 `TypeError`,而不是文档承诺的「未知类型回退 web」。现在用 `hasOwnProperty` 守住查表。
|
|
13
|
+
- 影响面:workflow 本身打不到这条路径(它先用 `Object.keys` 校验 type),但 `resolve()` 是公开导出,程序化调用方传入用户输入就会中招。
|
|
14
|
+
- **`qualityChecklistSchema` 声明 6 个门,只 `required` 5 个**:漏了 `languageConsistent`,而 workflow 的质量校验提示词问的正是 6 项。夹具测试还写着 `required.length === 5`,等于在断言这个 bug。现在断言改成「`required` == 声明的布尔项集合」,这才是该守的不变量。
|
|
15
|
+
|
|
16
|
+
### Added
|
|
17
|
+
|
|
18
|
+
- **`scripts/release.js` + `npm run release`**:发布自动化。发布日期在**运行时**取、CHANGELOG 必须与之一致、`RELEASE.md` 与本地/远端 tag 都不得已有该版本、门禁先跑、先推 tag 再建 Release、成败只认日志里的 `+ 包名@版本`、说明从 CHANGELOG 小节原样生成(发布说明与变更日志不会再各说一套)。
|
|
19
|
+
- 它存在的理由:手工流程踩过三次 —— 发布日期写错两次(0.3.12 与 0.3.16)、`docs/RELEASE.md` 未更新导致 publish 被 tag 校验拦下一次(0.3.13)。
|
|
20
|
+
- 脚本本身**不进 npm 包**(`files[]` 用 `!scripts/release.js` 排除);`scripts/transcribe.js` 仍随包发布。
|
|
21
|
+
- 2 条回归测试(`node:test` 52 → 54):原型链名字必须回退到 web;质量清单的 `required` 必须等于声明的门数。
|
|
22
|
+
|
|
23
|
+
### Compatibility
|
|
24
|
+
|
|
25
|
+
- 无破坏性变更。行为上有两处**变严格**:`resolve()` 对原型链名字从「返回垃圾」改为「回退 web」;质量清单 schema 的 `required` 多了 `languageConsistent`。
|
|
26
|
+
|
|
27
|
+
### 升级提醒
|
|
28
|
+
|
|
29
|
+
- 不需要改配置。
|
|
30
|
+
|
|
6
31
|
## [0.3.16] — 2026-10-19
|
|
7
32
|
|
|
8
33
|
新增 `options.frontmatter` 三档,解决 frontmatter 在 Hugo 里的语义冲突。**默认档与历史行为逐字一致**,不构成破坏性变更。
|
package/docs/RELEASE.md
CHANGED
|
@@ -34,7 +34,26 @@
|
|
|
34
34
|
|
|
35
35
|
## npm 发布流程
|
|
36
36
|
|
|
37
|
-
###
|
|
37
|
+
### 首选:`npm run release`(自动化,2026-10-19 起)
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
# 1. 先在 CHANGELOG.md 顶部写好这一版的小节,日期必须是今天:
|
|
41
|
+
# ## [X.Y.Z] — YYYY-MM-DD
|
|
42
|
+
# 2. 看计划(不做任何写操作)
|
|
43
|
+
npm run release
|
|
44
|
+
# 3. 真发
|
|
45
|
+
npm run release -- --yes # 或 --minor / --major / --version X.Y.Z
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
脚本逐条校验:工作区干净(**只允许 `CHANGELOG.md` 未提交**,它会并进发布 commit)、在 `main`、与 `origin/main` 一致、CHANGELOG 里已有目标版本**且日期等于今天**、`docs/RELEASE.md` 与本地/远端 tag 都没有该版本。
|
|
49
|
+
|
|
50
|
+
然后依次:跑门禁 → bump `package.json` → 更新版本表 → commit → tag → push → dispatch(**先 dry-run 再真发**)→ **只认日志里的 `+ 包名@版本`** → 用 npm 同字节建 Release。
|
|
51
|
+
|
|
52
|
+
发布说明从 CHANGELOG 对应小节**原样生成**,不再手写,因此说明与变更日志不会各说一套。
|
|
53
|
+
|
|
54
|
+
它存在的理由:手工流程曾踩过三次坑 —— 发布日期写错两次(0.3.12、0.3.16)、`docs/RELEASE.md` 没更新导致 publish 被 tag 校验拦下一次(0.3.13)。
|
|
55
|
+
|
|
56
|
+
### 手工路径(脚本不可用时):npm Trusted Publishing(OIDC,无 token、无 OTP)
|
|
38
57
|
|
|
39
58
|
```yaml
|
|
40
59
|
.github/workflows/publish.yml ← 手动 dispatch(首选,可靠)/ Release 被发布 / 历史 tag 补发
|
|
@@ -117,7 +136,8 @@ npm view deep-read-summarize --prefer-online # 验证线
|
|
|
117
136
|
| v0.3.13 | npm 已发布 | 声明:补 `engines.dsh`(此前的 `dsh.minVersion` 非公开字段,市场不读,判定一直是 `undeclared`) |
|
|
118
137
|
| v0.3.14 | npm 已发布 | 修:路径尾分隔符、本地日期、config 白名单;README 测试数 |
|
|
119
138
|
| v0.3.15 | npm 已发布 | 工程卫生:锁定 LF、脚本正文独立成文、lint 扩检查、包瘦身、提示词改「标准 Markdown」 |
|
|
120
|
-
|
|
|
139
|
+
| v0.3.16 | npm 已发布 | 新增 `options.frontmatter` 三档(obsidian / generic / minimal),解决 Hugo 保留键冲突;默认档不变 |
|
|
140
|
+
| **v0.3.17** | **仅 GitHub(npm 待补)** | 修 `resolve()` 原型链回退与质量清单 required;新增发布脚本 `scripts/release.js` |
|
|
121
141
|
| v1.0.0 | 计划 | API 稳定后发布 |
|
|
122
142
|
|
|
123
143
|
> 早期迭代用 0.x 表达不稳定;API 稳定后再发 1.0.0。
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "deep-read-summarize",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.17",
|
|
4
4
|
"description": "Deep reading & summarization for DSH: books/papers/videos/web → structured Markdown notes (Obsidian / Logseq / static sites). Plugin parsers, MapReduce deep-read, JSON Schema-constrained sub-tasks.",
|
|
5
5
|
"type": "commonjs",
|
|
6
6
|
"main": "index.js",
|
|
@@ -20,6 +20,7 @@
|
|
|
20
20
|
"lib",
|
|
21
21
|
"skills",
|
|
22
22
|
"scripts",
|
|
23
|
+
"!scripts/release.js",
|
|
23
24
|
"docs/RELEASE.md",
|
|
24
25
|
"cordis.patch.yml",
|
|
25
26
|
"CHANGELOG.md",
|
|
@@ -34,6 +35,7 @@
|
|
|
34
35
|
"validate": "node tests/quick_validate.js && node scripts/security-check.js",
|
|
35
36
|
"security": "node scripts/security-check.js",
|
|
36
37
|
"test:node": "node --test",
|
|
38
|
+
"release": "node scripts/release.js",
|
|
37
39
|
"prepublishOnly": "node tests/run-tests.js && node --test && node scripts/lint.js && node scripts/security-check.js"
|
|
38
40
|
},
|
|
39
41
|
"dsh": {
|
package/parsers/index.js
CHANGED
|
@@ -54,9 +54,17 @@ class ParserRegistry {
|
|
|
54
54
|
}
|
|
55
55
|
}
|
|
56
56
|
|
|
57
|
-
/**
|
|
57
|
+
/**
|
|
58
|
+
* 按类型解析解析器;未知类型回退到 web。
|
|
59
|
+
*
|
|
60
|
+
* 必须走 hasOwnProperty:直接 `this.parsers[type]` 会把原型链上的键也当成解析器
|
|
61
|
+
* 返回 —— `resolve("constructor")` 拿到的是 Object 构造函数、`resolve("toString")`
|
|
62
|
+
* 拿到 toString,两者都没有 buildPrompt,调用方会拿到 TypeError 而不是回退到 web。
|
|
63
|
+
* 也就是说「未知类型回退 web」这条契约会在十来个名字上静默失效。
|
|
64
|
+
*/
|
|
58
65
|
resolve(type) {
|
|
59
|
-
|
|
66
|
+
if (!Object.prototype.hasOwnProperty.call(this.parsers, type)) return this.parsers.web;
|
|
67
|
+
return this.parsers[type];
|
|
60
68
|
}
|
|
61
69
|
|
|
62
70
|
/** 列出所有已注册解析器 */
|
package/schemas/index.js
CHANGED
|
@@ -106,7 +106,7 @@ const qualityChecklistSchema = {
|
|
|
106
106
|
languageConsistent: { type: "boolean" },
|
|
107
107
|
issues: { type: "array", items: { type: "string" } }
|
|
108
108
|
},
|
|
109
|
-
required: ["coverage", "citationsReal", "terminologyConsistent", "formatComplete", "lengthMet"],
|
|
109
|
+
required: ["coverage", "citationsReal", "terminologyConsistent", "formatComplete", "lengthMet", "languageConsistent"],
|
|
110
110
|
additionalProperties: false
|
|
111
111
|
};
|
|
112
112
|
|