SuperAPI AI 工具集

documenso-local-dev-loop

测试与质量

查看项目

更新于 10-15 23:25

技能介绍

用途:为 Documenso 集成配置快速的本地开发环境与测试工作流,覆盖项目结构、环境配置、通过 Docker 自托管 Documenso、测试工具与清理脚本,最终产出一个基于合成文档与签名者、带有正常源代码回滚路径的小型测试支撑的本地变更,以及一份不含文档内容、签名链接、凭据或签名者个人信息的脱敏开发验证凭证。

前置条件:需先完成 documenso-install-auth 设置;Node.js 18+ 与 TypeScript;自托管本地 Documenso 需 Docker。

主要能力与用法:按建议结构组织项目,包含 src/documenso 下的客户端、文档、收件人与 webhook 模块,scripts 下的连接校验、测试文档生成与清理脚本,tests/integration 下的文档与模板测试,并区分 .env.development、.env.test、.env.production 三套环境。客户端封装通过 @documenso/sdk-typescript 初始化,可指定 apiKey 与 serverURL。自托管方式使用 docker pull documenso/documenso:latest 与 docker-compose.local.yml,包含 Documenso、Postgres 16 与 MailHog 服务,启动命令为 docker compose -f docker-compose.local.yml up -d,访问 http://localhost:3000,邮件界面为 http://localhost:8025。

验证与清理:verify-connection.ts 调用 documents.findV0 做快速健康检查,401 时提示检查 DOCUMENSO_API_KEY;cleanup-test-docs.ts 删除标题以 [TEST] 或 Hello World 开头且状态为 DRAFT 的测试文档,其他状态跳过。package.json 中提供 dev:verify、dev:test-doc、dev:cleanup、dev:local、dev:local:stop、test:integration 脚本。

限制与错误处理:本地开发严禁使用生产文档、签名 URL 或凭据。常见问题包括 Docker 未运行导致的 ECONNREFUSED、环境 API key 不匹配导致 401、测试未清理导致数据残留、请求过多被限流(可在调用间加 await delay(500))、SMTP 配置错误导致邮件不到(检查 MailHog)。