rss-pal-dsh 0.1.0 → 0.1.2

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/README.en.md CHANGED
@@ -5,7 +5,7 @@
5
5
  **A local-first reading room inside DSH: RSS subscriptions, full-text search, bulk read marking, on-demand AI summaries and a native reading companion.**
6
6
 
7
7
  - Repository: <https://github.com/morefreeze/dsh-plugin-rss-pal>
8
- - Plugin package: `rss-pal-dsh` · Version: `0.1.0`
8
+ - Plugin package: `rss-pal-dsh` · Version: `0.1.2`
9
9
  - Marketplace category: **Data & Knowledge (knowledge)**
10
10
  - License: [MIT](LICENSE)
11
11
  - A community plugin, not affiliated with DeepSeek AI.
@@ -41,20 +41,38 @@ The repository includes prebuilt `lib/index.js` and `lib/client.js`, so installi
41
41
 
42
42
  ### Install a release package
43
43
 
44
- Download `rss-pal-dsh-0.1.0.tgz` from [GitHub Releases](https://github.com/morefreeze/dsh-plugin-rss-pal/releases):
44
+ Download `rss-pal-dsh-0.1.2.tgz` from [GitHub Releases](https://github.com/morefreeze/dsh-plugin-rss-pal/releases):
45
45
 
46
46
  ```sh
47
- dsh plugin --profile web add ./rss-pal-dsh-0.1.0.tgz
47
+ dsh plugin --profile web add ./rss-pal-dsh-0.1.2.tgz
48
48
  ```
49
49
 
50
- npm publication status: **not yet published**. Some marketplace websites accept GitHub-source listings; npm-backed one-click entries in the DSH plugin center require npm publication and marketplace verification. The package name will remain `rss-pal-dsh` when published.
50
+ ### Install from npm
51
+
52
+ `rss-pal-dsh@0.1.0` is published on [npm](https://www.npmjs.com/package/rss-pal-dsh):
53
+
54
+ ```sh
55
+ dsh plugin --profile web add rss-pal-dsh
56
+ ```
57
+
58
+ The latest GitHub Release is `0.1.2`; npm publication verification for `0.1.2` is pending. Marketplace listings and one-click installation remain subject to each marketplace's checks. New features on GitHub main may precede npm releases; the GitHub install above includes the latest source and committed builds.
59
+
60
+ ## Feedback and public download reports
61
+
62
+ The sidebar's **反馈与建议 (Feedback)** entry links to [bug reports](https://github.com/morefreeze/dsh-plugin-rss-pal/issues/new?template=bug-report.yml), [feature requests](https://github.com/morefreeze/dsh-plugin-rss-pal/issues/new?template=feature-request.yml) and [existing issues](https://github.com/morefreeze/dsh-plugin-rss-pal/issues). Include plugin/DSH versions, your environment and reproduction steps; redact screenshots and logs. The plugin never uploads diagnostics, subscriptions, articles or conversations automatically.
63
+
64
+ The [download report](docs/reports/downloads.md) shows npm downloads for the last 30 complete UTC days, GitHub Release asset downloads and stars/forks/issues. GitHub Actions generates it daily and supports manual runs. Failed sources are marked unknown, not zero. **Downloads are not unique users or active users; npm and Release counts must not be added as a user count.** Only the repository-side script queries public statistics; installed plugins remain telemetry-free.
65
+
66
+ ```sh
67
+ node scripts/download-report.mjs
68
+ ```
51
69
 
52
70
  ## Compatibility and runtime requirements
53
71
 
54
72
  | Item | Requirement / verification scope |
55
73
  | --- | --- |
56
74
  | DSH profile | `web` |
57
- | Declared DSH versions | `0.2.1-rc.5`, `0.2.2-rc.1` |
75
+ | Declared DSH range | `>=0.2.1-rc.5 <0.3.0-0` (host matches prereleases explicitly) |
58
76
  | Runtime-tested environment | macOS, DeepSeek Harness `0.2.1-rc.5` Web |
59
77
  | Node.js | `>=22.19.0`; the selected DSH release may require a newer version |
60
78
  | Database | Local SQLite through the `better-sqlite3` native module |
@@ -79,12 +97,18 @@ Agent reads do not count toward human reading time. The summary tool should be i
79
97
 
80
98
  ## Development and testing
81
99
 
82
- Install development dependencies:
100
+ The four official development peers are pinned to `0.2.2-rc.3`, so a clean install is sufficient. Keep native dependency install scripts enabled:
83
101
 
84
102
  ```sh
85
- npm ci --include=dev
103
+ npm ci --include=dev --registry=https://registry.npmjs.org
104
+ npm run check
105
+ npm run test:report
86
106
  ```
87
107
 
108
+ [Public CI](https://github.com/morefreeze/dsh-plugin-rss-pal/actions/workflows/check.yml) covers Ubuntu/macOS/Windows, Node 22.19/24 and DSH peers 0.2.1-rc.5/0.2.2-rc.3. Actual workflow results determine which environments passed. Windows uses the CI step's NODE_ENV environment and direct `node --import tsx --test` command instead of POSIX inline variable assignment.
109
+
110
+ The native SQLite dependency remains; the plugin does not change user build policy. Approve only better-sqlite3 when the manager reports build-blocked. See [build approval, manual repair and FTS5 verification](docs/native-build.md).
111
+
88
112
  The `@deepseek-ai` runtime dependencies are provided by DSH. For development, also install the following four packages at the same version as your target DSH release:
89
113
 
90
114
  ```sh
@@ -103,7 +127,7 @@ The Host entry is the Cordis `RssPalService` plugin class. The Web Client export
103
127
 
104
128
  ## Verification
105
129
 
106
- Current regression baseline: **88 passing tests**, covering transactional read ranges, filter isolation, pagination/filter navigation during pending writes, reading tracking, explicit summary generation and model selection. Desktop and mobile-width layouts, single-article read-state RPC and the native reading companion have been verified in actual DSH Web.
130
+ Current local regression baseline: **90 plugin tests and 11 report tests passing** (macOS, Node 22.19, DSH 0.2.2-rc.3 peers; not a new full-host Web acceptance run), covering transactional read ranges, filter isolation, pagination/filter navigation during pending writes, reading tracking, explicit summary generation and model selection. Desktop and mobile-width layouts, single-article read-state RPC and the native reading companion have been verified in actual DSH Web.
107
131
 
108
132
  ## Acknowledgments
109
133
 
package/README.md CHANGED
@@ -7,7 +7,7 @@
7
7
  A local-first RSS/Atom reader for DeepSeek Harness, with full-text search, on-demand AI summaries and a native reading companion.
8
8
 
9
9
  - 仓库:<https://github.com/morefreeze/dsh-plugin-rss-pal>
10
- - 插件包名:`rss-pal-dsh` · 版本:`0.1.0`
10
+ - 插件包名:`rss-pal-dsh` · 版本:`0.1.2`
11
11
  - 市场能力分类:**Data & Knowledge (knowledge) / 数据与知识**
12
12
  - 许可证:[MIT](LICENSE)
13
13
  - 社区插件,与 DeepSeek AI 官方无隶属关系。
@@ -43,20 +43,38 @@ dsh plugin --profile web add github:morefreeze/dsh-plugin-rss-pal
43
43
 
44
44
  ### 发布包安装
45
45
 
46
- 从 [GitHub Releases](https://github.com/morefreeze/dsh-plugin-rss-pal/releases) 下载 `rss-pal-dsh-0.1.0.tgz`:
46
+ 从 [GitHub Releases](https://github.com/morefreeze/dsh-plugin-rss-pal/releases) 下载 `rss-pal-dsh-0.1.2.tgz`:
47
47
 
48
48
  ```sh
49
- dsh plugin --profile web add ./rss-pal-dsh-0.1.0.tgz
49
+ dsh plugin --profile web add ./rss-pal-dsh-0.1.2.tgz
50
50
  ```
51
51
 
52
- npm 发布状态:**尚未发布**。市场官网支持 GitHub 源码收录;DSH 内插件中心的一键安装条目需要 npm 发布并通过市场核验。发布后包名将保持 `rss-pal-dsh`。
52
+ ### 从 npm 安装
53
+
54
+ `rss-pal-dsh@0.1.0` 已发布到 [npm](https://www.npmjs.com/package/rss-pal-dsh):
55
+
56
+ ```sh
57
+ dsh plugin --profile web add rss-pal-dsh
58
+ ```
59
+
60
+ GitHub Release 最新版本为 `0.1.2`;npm 的 `0.1.2` 发布验证进行中。市场的收录及一键安装状态取决于各市场核验。GitHub main 中的新功能可能先于 npm 发布;上方 GitHub 安装方式可取得最新源码及预构建产物。
61
+
62
+ ## 反馈与公开下载报表
63
+
64
+ 插件侧栏的 **反馈与建议** 提供[问题反馈](https://github.com/morefreeze/dsh-plugin-rss-pal/issues/new?template=bug-report.yml)、[功能建议](https://github.com/morefreeze/dsh-plugin-rss-pal/issues/new?template=feature-request.yml)与[已有反馈](https://github.com/morefreeze/dsh-plugin-rss-pal/issues)。请注明插件/DSH 版本、系统与复现步骤,并对截图和日志脱敏;插件不会自动上传诊断、订阅、文章或聊天。
65
+
66
+ [下载统计报表](docs/reports/downloads.md)展示最近 30 个完整 UTC 日的 npm 下载趋势、GitHub Release 文件下载及 Star/Fork/Issue。GitHub Actions 每天生成,也支持手动触发;来源失败会标明未知,不填成 0。**下载次数不代表独立用户或活跃人数,npm 与 Release 不相加当人数。** 仅仓库侧脚本访问公开统计接口,用户安装的插件保持无遥测。
67
+
68
+ ```sh
69
+ node scripts/download-report.mjs
70
+ ```
53
71
 
54
72
  ## 兼容与运行要求
55
73
 
56
74
  | 项目 | 要求 / 验证范围 |
57
75
  | --- | --- |
58
76
  | DSH profile | `web` |
59
- | DSH 版本声明 | `0.2.1-rc.5`、`0.2.2-rc.1` |
77
+ | DSH 版本声明 | `>=0.2.1-rc.5 <0.3.0-0`(宿主包含预发布版本匹配) |
60
78
  | 实机验收 | macOS、DeepSeek Harness `0.2.1-rc.5` Web |
61
79
  | Node.js | `>=22.19.0`;使用的 DSH 版本可能要求更高版本 |
62
80
  | 数据库 | 本地 SQLite / `better-sqlite3` 原生模块 |
@@ -81,12 +99,18 @@ Agent 阅读不会计入人类阅读时长。总结工具只在用户明确要
81
99
 
82
100
  ## 开发与测试
83
101
 
84
- 先安装开发依赖:
102
+ 官方四个开发依赖已固定到 `0.2.2-rc.3`,一次安装即可复现检查。依赖安装需允许 `better-sqlite3` 的正常原生构建:
85
103
 
86
104
  ```sh
87
- npm ci --include=dev
105
+ npm ci --include=dev --registry=https://registry.npmjs.org
106
+ npm run check
107
+ npm run test:report
88
108
  ```
89
109
 
110
+ [公开 CI](https://github.com/morefreeze/dsh-plugin-rss-pal/actions/workflows/check.yml)覆盖 Ubuntu/macOS/Windows、Node 22.19/24、DSH peers `0.2.1-rc.5`/`0.2.2-rc.3`。矩阵是否通过以工作流实际结果为准。Windows 使用 CI 中的 `NODE_ENV: test` 与 `node --import tsx --test` 命令,不使用 POSIX 内联变量语法。
111
+
112
+ 保留原生 SQLite,不自动放宽用户构建策略;商店提示 `build-blocked` 时仅批准该依赖。[构建审批、手动修复与 FTS5 验证步骤](docs/native-build.md)。
113
+
90
114
  宿主 `@deepseek-ai` 依赖由 DSH 提供,开发时还需在当前项目安装与目标 DSH 同版的 `dsh-tools`、`dsh-llm`、`dsh-home-paths`、`dsh-typert-protocol` 四个包:
91
115
 
92
116
  ```sh
@@ -105,7 +129,7 @@ Host 入口为 Cordis `RssPalService` 插件类;Web Client 在 `src/client/ind
105
129
 
106
130
  ## 验证
107
131
 
108
- 当前回归:**88 项通过**,包括事务范围已读、筛选隔离、待写入期间翻页 / 切筛选竞态、阅读追踪、手动总结与模型选择。已在真实 DSH Web 验证桌面和手机布局、单篇已读 RPC 与原生伴读。
132
+ 当前本地回归:**90 项插件测试 + 11 项报告测试通过**(macOS、Node 22.19、DSH `0.2.2-rc.3` peers;不是新宿主 Web 全流程验收),包括事务范围已读、筛选隔离、待写入期间翻页 / 切筛选竞态、阅读追踪、手动总结与模型选择。已在真实 DSH Web 验证桌面和手机布局、单篇已读 RPC 与原生伴读。
109
133
 
110
134
  ## 致谢
111
135
 
@@ -0,0 +1,35 @@
1
+ # Native SQLite installation / 原生 SQLite 安装
2
+
3
+ RSS Pal currently uses `better-sqlite3`, a required native dependency. The plugin's prebuilt JavaScript does **not** include a cross-platform `.node` binding. A package appearing in the plugin manager is not proof that its native dependency built successfully.
4
+
5
+ ## DSH marketplace build approval
6
+
7
+ When DSH reports `build-blocked` or `ERR_PNPM_IGNORED_BUILDS`, use its build-review prompt and approve **better-sqlite3 only**. Do not approve unrelated package scripts. Retry/complete the install through the same manager after approval, then reload RSS Pal or restart the host and refresh the page. On older managers with no review prompt, use the manual repair below. The plugin does not edit your profile's build policy automatically.
8
+
9
+ ## Manual repair in the actual profile directory
10
+
11
+ Locate the **profile package/workspace directory used by this installation** in DSH's plugin-manager diagnostics. Do not run these commands in the plugin source checkout or guess a profile path. Use the same Node and pnpm binaries as the host.
12
+
13
+ ```sh
14
+ # Replace /absolute/path/to/profile with the actual profile directory.
15
+ pnpm --dir /absolute/path/to/profile approve-builds better-sqlite3
16
+ pnpm --dir /absolute/path/to/profile rebuild better-sqlite3
17
+ ```
18
+
19
+ The named-approval form is available in pnpm 11.2.2. If your pnpm only supports the interactive approval UI, run `pnpm --dir /absolute/path/to/profile approve-builds` and select only `better-sqlite3`. Inspect the resulting workspace policy rather than adding a blanket allow-all setting.
20
+
21
+ If a compatible prebuilt binary is unavailable, better-sqlite3 falls back to node-gyp compilation: Python and a C/C++ build toolchain are required (Xcode Command Line Tools on macOS, a compiler/make on Linux, Visual Studio C++ Build Tools on Windows). Follow the actual build error. Changing the host Node major version may require rebuilding the binding.
22
+
23
+ ## Verify from the profile
24
+
25
+ Use a terminal in the profile directory and the host Node binary:
26
+
27
+ ```sh
28
+ node --input-type=module -e "import { createRequire } from 'node:module'; const require=createRequire(import.meta.url); const pluginRequire=createRequire(require.resolve('rss-pal-dsh')); const Database=pluginRequire('better-sqlite3'); const db=new Database(':memory:'); db.exec('CREATE VIRTUAL TABLE check_fts USING fts5(text)'); db.prepare('INSERT INTO check_fts VALUES (?)').run('RSS Pal'); console.log(db.prepare(\"SELECT text FROM check_fts WHERE check_fts MATCH 'RSS'\").all()); db.close();"
29
+ ```
30
+
31
+ Expected output contains `RSS Pal`. This is a disposable in-memory database and does not read or change your library. An error here means native installation is not complete; preserve the build log and report your OS, Node, pnpm and DSH versions, without private profile data.
32
+
33
+ ## 开发与验收
34
+
35
+ 当前方案保留 `better-sqlite3`,通过商店构建审批或上述手动步骤完成原生安装;没有承诺所有平台提供预编译 binding,也没有迁移已有用户数据库。公开 CI 会正常执行依赖构建并测试 SQLite/FTS5 行为,但它不代替 DSH profile 内的构建审批。源码开发直接运行 `npm ci --include=dev --registry=https://registry.npmjs.org`,不要使用 `--ignore-scripts` 后将结果当成完整安装。