deep-read-summarize 0.3.10 → 0.3.11

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 CHANGED
@@ -3,6 +3,24 @@
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.11] — 2026-10-05
7
+
8
+ 文档与 CI 补强:**运行时行为与 0.3.10 完全一致**,没有任何解析器 / 脚本 / schema 改动。
9
+
10
+ ### Added
11
+
12
+ - **`README.md` / `README.en.md` 新增「支持平台」(Platform support)一节**:逐环节列出三平台各自需要的工具(poppler / curl / yt-dlp / uv)、转写默认走 CPU(Apple Silicon 与 Intel Mac 都不需要 CUDA)、三平台缓存目录,并如实写明**尚未在真实 macOS 上跑过一次完整转写推理**(CI 只覆盖到平台路径解析)。
13
+
14
+ ### Changed
15
+
16
+ - **CI 的 `cross-platform` 作业从「lint + `--self-check`」扩到与 ubuntu 作业同一套门禁**(security / lint / fixture / node:test / validate)。此前 42 项测试套件从未在 macOS 或 Windows 上执行过,而文档一直写着「三平台同等支持」——现在三平台各跑一遍。
17
+ - **「已验证的宿主」锚点从 DSH `0.1.2-rc.1` 更新为 `0.2.0-rc.2`**(`README.md` / `README.en.md` / `index.js` 头部注释),依据是 2026-09-30 在 0.2.0-rc.2 上的契约复核。
18
+
19
+ ### Compatibility
20
+
21
+ - 无破坏性变更:依赖、`exports`、`files` 与全部运行时行为均与 0.3.10 相同。
22
+ - 从 npm 安装的用户:包内 `README` 会更新(本次唯一的用户可见变化);`.github/` 不进包,CI 改动只影响仓库。
23
+
6
24
  ## [0.3.10] — 2026-09-24
7
25
 
8
26
  对**已发布的 0.3.9** 做的一轮审计修复。审计对象是 **npm 上那份字节**(不是工作区):先确认 29 个文件与 tag `v0.3.9` **逐字节一致**,再在解包目录里跑该包自带的门禁(lint / security / 35 fixture / 38 node:test 全绿),然后逐项找问题。
package/README.en.md CHANGED
@@ -17,6 +17,8 @@ Content is split into chunks, read in parallel by multiple sub-agents, then merg
17
17
 
18
18
  > Note: DSH is currently a developer preview and its interfaces may change. This repo targets a specific version of the workflow-tool semantics — see [Compatibility](#compatibility).
19
19
 
20
+ > **Platforms**: Windows / macOS / Linux are equally supported (since 0.3.9) — see [Platform support](#platform-support) below.
21
+
20
22
  ---
21
23
 
22
24
  ## What it looks like
@@ -92,6 +94,24 @@ This repo carries the `dsh-plugin` topic and the `dsh` field in `package.json`,
92
94
  dsh.so listing requirements: a public repo, the `dsh-plugin` topic (or the dsh field), README install instructions, and an SPDX license (MIT).
93
95
  After submission it is marked **Declared** (self-declared compatibility); if you actually use it and verify compatibility, report your results in the official Discussions — that is the only way to be promoted to **Verified**.
94
96
 
97
+ ---
98
+
99
+ ## Platform support
100
+
101
+ **Windows / macOS / Linux are equally supported** (since 0.3.9). The plugin itself only needs Node (which DSH ships); the extra tools each input type may use are installed per platform:
102
+
103
+ - **Book / paper PDF** → `pdftotext` (poppler): macOS `brew install poppler`, Windows `winget install poppler`, Debian/Ubuntu `apt install poppler-utils`
104
+ - **Bilibili subtitles / audio** → `curl`: already present on Windows 10+, macOS and Linux — nothing to install
105
+ - **YouTube subtitles** → `yt-dlp`: macOS `brew install yt-dlp`, Windows `winget install yt-dlp.yt-dlp`, any platform `pip install -U yt-dlp`
106
+ - **Transcription when there are no subtitles** → `uv` (the script bootstraps a Python 3.12 env and installs faster-whisper): macOS `brew install uv`, Windows `winget install astral-sh.uv`, or the official installer script on macOS / Linux (hand `curl -LsSf https://astral.sh/uv/install.sh` to `sh`)
107
+
108
+ Further notes:
109
+
110
+ - Transcription is the **only** part that needs an extra toolchain, and all three platforms share one Node script and one command: `node scripts/transcribe.js --audio <file> --out <txt>`.
111
+ - Transcription runs on **CPU** by default, so Apple Silicon / Intel Macs and Linux need no CUDA; GPU support needs a CUDA runtime and `options.device: "auto"` will try it and fall back to CPU on failure.
112
+ - Cache location per platform: macOS `~/Library/Caches/deep-read-summarize`, Linux `$XDG_CACHE_HOME/deep-read-summarize`, Windows `%LOCALAPPDATA%\deep-read-summarize`.
113
+ - A full transcription has **not yet been run on real macOS hardware** (CI only verifies platform path resolution on `macos-latest`; it does not download the model). If it works for you on a Mac — or fails — please open an issue.
114
+
95
115
  ---
96
116
  ## Installation (DSH plugin)
97
117
 
@@ -294,7 +314,7 @@ See CHANGELOG.md for changes and CONTRIBUTING.md for contribution guidelines.
294
314
 
295
315
  ## Compatibility
296
316
 
297
- **Verified host: DSH 0.1.2-rc.1** (Node 24). The dependency surface is exactly two things:
317
+ **Verified host: DSH 0.2.0-rc.2** (Node 24). The dependency surface is exactly two things:
298
318
 
299
319
  | Surface | Current contract | How this repo uses it |
300
320
  | --- | --- | --- |
package/README.md CHANGED
@@ -17,6 +17,8 @@
17
17
 
18
18
  > 注意:DSH 目前是 developer preview,接口可能变化。本仓库针对特定版本的 workflow 工具语义编写,见下文[兼容性](#兼容性)。
19
19
 
20
+ > **平台**:Windows / macOS / Linux 同等支持(0.3.9 起),详见下文[支持平台](#支持平台)。
21
+
20
22
  ---
21
23
 
22
24
  ## 实际效果
@@ -92,6 +94,24 @@ workflow.js workflow 脚本本体(meta + script)
92
94
  dsh.so 收录要求:公开仓库、`dsh-plugin` topic(或 dsh 字段)、README 安装说明、SPDX 许可证(MIT)。
93
95
  提交后标记为 **Declared**(自声明兼容);如果你实际使用并验证兼容,请在官方 Discussions 报告结果,这是唯一升 **Verified** 的途径。
94
96
 
97
+ ---
98
+
99
+ ## 支持平台
100
+
101
+ **Windows / macOS / Linux 同等支持**(0.3.9 起)。插件本身只依赖 Node(DSH 自带),各环节需要的额外工具按平台装:
102
+
103
+ - **书籍 / 论文 PDF** → `pdftotext`(poppler):macOS `brew install poppler`、Windows `winget install poppler`、Debian/Ubuntu `apt install poppler-utils`
104
+ - **B站字幕 / 音频** → `curl`:Windows 10+ 与 macOS / Linux 都自带,零安装
105
+ - **YouTube 字幕** → `yt-dlp`:macOS `brew install yt-dlp`、Windows `winget install yt-dlp.yt-dlp`、任意平台 `pip install -U yt-dlp`
106
+ - **无字幕转写** → `uv`(脚本自举:建 Python 3.12 环境 + 装 faster-whisper):macOS `brew install uv`、Windows `winget install astral-sh.uv`,macOS / Linux 也可用官方安装脚本(`curl -LsSf https://astral.sh/uv/install.sh` 交给 `sh`)
107
+
108
+ 其余说明:
109
+
110
+ - 转写是**唯一**需要额外工具链的环节,三平台共用同一份 Node 脚本、同一条命令:`node scripts/transcribe.js --audio <音频> --out <txt>`。
111
+ - 转写默认走 **CPU**,Apple Silicon / Intel Mac 与 Linux 都不需要 CUDA;GPU 需自备 CUDA 运行库,`options.device: "auto"` 会尝试并在失败时自动回退 CPU。
112
+ - 缓存目录按平台取:macOS `~/Library/Caches/deep-read-summarize`、Linux `$XDG_CACHE_HOME/deep-read-summarize`、Windows `%LOCALAPPDATA%\deep-read-summarize`。
113
+ - 尚未在**真实 macOS** 上跑过一次完整转写推理(CI 只在 `macos-latest` 上验证平台路径解析,不下载模型)。如果你在 Mac 上跑通或遇到报错,欢迎开 issue 反馈。
114
+
95
115
  ---
96
116
  ## 安装(DSH 插件)
97
117
 
@@ -294,7 +314,7 @@ npm publish 会自动先跑 prepublishOnly(测试 + lint + 安全检查),
294
314
 
295
315
  ## 兼容性
296
316
 
297
- **已验证的宿主:DSH 0.1.2-rc.1**(Node 24)。本仓库的依赖面只有两处:
317
+ **已验证的宿主:DSH 0.2.0-rc.2**(Node 24)。本仓库的依赖面只有两处:
298
318
 
299
319
  | 依赖面 | 现行契约 | 本仓库的用法 |
300
320
  | --- | --- | --- |
package/docs/RELEASE.md CHANGED
@@ -111,7 +111,8 @@ npm view deep-read-summarize --prefer-online # 验证线
111
111
  | v0.3.0 – v0.3.7 | npm 已发布 | 解析器插件化、幂等缓存、视频转写流水线 |
112
112
  | v0.3.8 | **仅 GitHub** | 打了 tag 与 Release 但漏发到 npm(Trusted Publishing 迁移期的缺口;修复已随 0.3.9 交付) |
113
113
  | v0.3.9 | npm 已发布 | macOS / Linux 支持(转写链路跨平台) |
114
- | **v0.3.10** | **npm 已发布(当前)** | 修:失效的 uv 镜像、空转写被当成成功、发布文档过时 |
114
+ | v0.3.10 | npm 已发布 | 修:失效的 uv 镜像、空转写被当成成功、发布文档过时 |
115
+ | **v0.3.11** | **npm 已发布(当前)** | 文档:README 补「支持平台」;CI:三平台跑全套门禁 |
115
116
  | v1.0.0 | 计划 | API 稳定后发布 |
116
117
 
117
118
  > 早期迭代用 0.x 表达不稳定;API 稳定后再发 1.0.0。
package/index.js CHANGED
@@ -1,7 +1,7 @@
1
1
  // ============================================================================
2
2
  // deep-read-summarize — DSH plugin entry
3
3
  // ============================================================================
4
- // 标准 Cordis 插件(DSH 0.1.x 契约,已在 0.1.2-rc.1 实测):导出 name + inject + apply(ctx, config)。
4
+ // 标准 Cordis 插件(DSH 0.1.x / 0.2.x 契约,已在 0.2.0-rc.2 实测):导出 name + inject + apply(ctx, config)。
5
5
  // apply() 将插件自带的 SKILL.md 注册为运行时技能,并把 workflow 的
6
6
  // meta + 自包含 script + args 示例嵌入技能内容,使模型可直接用 workflow
7
7
  // 工具执行精读流程。
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "deep-read-summarize",
3
- "version": "0.3.10",
3
+ "version": "0.3.11",
4
4
  "description": "Deep reading & summarization for DSH: books/papers/videos/web → structured Obsidian notes. Plugin parsers, MapReduce deep-read, JSON Schema-constrained sub-tasks.",
5
5
  "type": "commonjs",
6
6
  "main": "index.js",