Files
Ncurator/scripts

脚本目录

脚本按用途分组,不再兼容旧路径。

  • scripts/build/native/:准备 Electron 和 Node 使用的原生模块。
  • scripts/build/package/:生成暂存包、混淆 main、审计暂存包和最终安装包。
  • scripts/build/runtime/:检查 bundle 边界、递归追踪运行时依赖、验证暂存依赖。
  • scripts/build/sidecar/:构建和检查网页爬虫 sidecar。
  • scripts/release/:本地发布入口。
  • scripts/release/r2/:R2 上传、元数据和发布收尾。
  • scripts/release/shared/:发布流程共享能力。
  • scripts/test/:源码/正式包 E2E 编排和真实更新测试。

正式包 E2E 只消费发布候选 bundle,不再自行调用任何 build:* 脚本。发布入口必须显式选择 --prepare-only、--test-only 或 --publish-only:prepare 固化候选,test 只重测候选,publish 只上传同一候选。

  • scripts/postinstall.mjs:安装完成后的唯一根级入口。

打包主流程

pnpm run build 最后调用 scripts/build/package/prepare-stage.mjs。该脚本固定按以下顺序执行:

  1. 用 @vercel/nft 递归追踪 main 和 preload 的文件依赖。
  2. 按追踪结果生成最小生产依赖并安装到 release-stage/app。
  3. 使用暂存目录中的真实 DocxLoader 和 PDFLoader 读取测试文件。
  4. 混淆 out/main 并验证输出哈希和受保护明文。
  5. 执行暂存包内容审计。

追踪规则在 build/runtime-trace-policy.json。新增显式包含项时必须同时写清原因和对应测试;未知追踪告警会直接中止构建。

最终安装包由 scripts/build/package/audit-app.mjs 再次检查。它会核对追踪到的包和关键文件是否真的进入 app.asar。

Electron E2E

  • pnpm test:e2e:source:构建 out 后运行全部 E2E。
  • pnpm test:e2e:package -- --bundle <release-bundle.json>:安装既有候选包后运行同一套 E2E,不重新构建。
  • 正式包测试只在发布命令传入 --package-e2e 或单独执行上述命令时运行。
  • macOS 测试应用按 macos-arm64、macos-x64 分目录保留在 ~/Applications/NCurator-E2E/。
  • 正式包 bundle 校验、安装和用例汇总保存在 tests/logs/package/<run-id>。
  • Workbench 和需要真实文件的 Settings 用例复制 tests/fixtures/workspace 到临时目录,结束后删除临时副本。
  • 每个 E2E 必须显式声明 serviceMode;fixture 还必须提供 fixtureReason。
  • 知识库缓存按构建隔离:source 使用 tests/.cache/workspace-knowledge/source/<build-sha256>,package 使用 tests/.cache/workspace-knowledge/package/<artifact-sha256>;同一轮所有用例共用选中的目录。
  • --fresh-knowledge-cache 强制清空当前构建缓存;--reuse-knowledge-cache 只用于人工调试时跨构建复用。
  • 每个 case 的附件都有 knowledge-cache-summary.json,正式包汇总也记录缓存路径、构建指纹和 hit/miss。