跳到主要内容

环境搭建

要求​

  • Node.js 24.15.0（.nvmrc 锁定，用 nvm use 切换）
  • npm（国内网络建议 --registry=https://registry.npmjs.org）
  • 原生开发目标：macOS arm64、Windows x64
  • 不要在 SMB/NAS 挂载目录上构建或运行——Electron 在挂载盘上无法正常启动（icudtl.dat not found），打包产物也不能从挂载盘运行

macOS​

  • Xcode Command Line Tools（原生模块编译需要）
  • 媒体组件构建（仅需要重建时）：scripts/media-build/darwin-arm64.sh（vcpkg，耗时数小时）

Windows​

  • Git、PowerShell
  • Visual Studio Build Tools：勾选“使用 C++ 的桌面开发”（Desktop development with C++）工作负载及 Windows SDK（原生模块 better-sqlite3 编译必需）
  • Inno Setup 6（构建 Windows 安装包 SerpentSetup.exe 时必需）：
    • 推荐方式（免管理员）：通过 NuGet 获取 Tools.InnoSetup，解压提取 ISCC.exe 放置于 %LOCALAPPDATA%\SerpentTools\inno\tools\ 目录；
    • 官网安装方式：安装官方 Inno Setup 6 并将环境变量 SERPENT_INNO_TOOLS 指向 ISCC.exe 所在目录（或加入系统 PATH）；
    • 若仅在开发态运行（npm start）或生成便携版（npm run package），则无需安装 Inno Setup。
  • 媒体组件构建（仅需要重建底层二进制时）：scripts/media-build/win32-x64.ps1（vcpkg）

首次构建​

npm ci --registry=https://registry.npmjs.org
npm run rebuild:native
npm start

rebuild:native 把 better-sqlite3 编译为 Electron ABI 并实测 FTS5。Windows 上不要裸跑 @electron/rebuild 或 node-gyp——本机 vcpkg 的 MSBuild 集成可能链接到无 FTS5 的 sqlite3.dll；项目脚本已强制禁用。

媒体组件​

npm ci 不安装 FFmpeg/ffprobe/OpenImageIO。缺组件时普通开发与图片导入不受影响；视频缩略图/代理生成会报 FFMPEG_REQUIRED，EXR/TGA/复杂 TIFF 需要 OpenImageIO。

打包产物使用受控媒体包（FFmpeg 8.1 LGPL-only + OpenImageIO 3.1.12.0），门禁校验产物哈希与来源（bundle-lock.json 的晋升状态 + source-lock.json 的版本匹配）。本地开发可用 SERPENT_FFMPEG_PATH 指向任意可信 FFmpeg（需含所需滤镜/编码器，且 ffprobe 同目录；GPL 构建仅限本地覆盖）：

# macOS
export SERPENT_FFMPEG_PATH="$HOME/tools/ffmpeg/ffmpeg"
npm start
# Windows
$env:SERPENT_FFMPEG_PATH = 'C:\tools\ffmpeg\ffmpeg.exe'
npm start

更换后需完全退出 Serpent 再启动（单实例锁，二次 npm start 不会替换已运行进程）。

常见开发命令​

npm run lint             # ESLint
npm run typecheck        # tsc --noEmit
npm run test             # 单元 + Worker 集成（Electron 内运行）
npm run test:unit        # 仅单元
npm run test:worker      # 仅 Worker 集成
npm run test:e2e         # Playwright E2E
npm start                # 开发启动
npm run start:multi      # 双实例

开发注意事项​

  • 测试跑在 Electron ABI 下（test:worker/test 经 run-vitest-with-electron.mjs）；npm run package 后需 npm run rebuild:native 恢复 dev native 模块
  • npm start 自动避开被占用的 Vite 端口