SuperAPI AI 工具集

effect

编程与开发

查看项目

更新于 10-27 16:29

技能介绍

Effect 是一个用于在代码仓库中编写 Effect v4 / effect-smol TypeScript 代码的技能。该代码库使用 Effect 来构建带类型、可组合的 TypeScript 服务、Schema 与工作流。

事实来源

使用当前的 Effect v4 / effect-smol 源码,而不是记忆或较旧的 Effect v2/v3 示例。

如果 .opencode/references/effect-smol 缺失,请将 https://github.com/Effect-TS/effect-smol 克隆到该位置。请在项目中执行此操作,而不是在技能文件夹中。

在回答或实现 Effect 特定代码之前,先在 .opencode/references/effect-smol 中搜索确切的 API、示例、测试和命名模式。

在引入新模式之前,还要检查现有仓库代码以了解本地风格。

优先使用由具体源文件或附近仓库示例支持的答案和实现。

指南

优先使用当前 Effect v4 API 和项目本地模式,而不是旧博客文章、示例或包记忆猜测。

使用 Effect.gen(function* () { ... }) 处理多步工作流。

在添加可复用服务方法或重要工作流时,使用 Effect.fn("Name") 或 Effect.fnUntraced(...) 命名 effect。

优先使用 Effect Schema 表示 API 和领域数据形状。在建模新错误表面时,对 ID 使用 branded schemas,对类型化领域错误使用 Schema.TaggedErrorClass。

保持 HTTP 处理器精简:解码输入、读取请求上下文、调用服务并映射传输错误。将业务规则放入服务中。

在 Effect 服务代码中,当周围代码已经这样做时,优先使用 Effect 感知的平台抽象和依赖,而不是临时 promise。

保持 layer 组合显式。避免大范围隐藏式供给,使缺失依赖难以发现。

在测试中,优先使用仓库现有的 Effect 测试辅助工具和 live tests 来处理文件系统、git、子进程、锁或时序行为。

不要为了满足类型而引入 any、非空断言、未检查的类型转换或较旧的 Effect API。

不要凭记忆回答。先对照 .opencode/references/effect-smol 或附近代码进行验证。

测试模式

对于测试 Effect 服务、layer、运行时上下文、作用域资源或平台集成的测试,使用 packages/opencode/test/lib/effect.ts 中的 testEffect(...)。

对于文件系统、git 仓库、HTTP 服务器、套接字、子进程、锁、实时和其他 live 平台行为,使用 it.live(...)。

从包目录(如 packages/opencode)运行测试;切勿从仓库根目录运行包测试。

优先使用显式测试 layer,而不是临时管理的运行时。保持依赖供给在测试文件中可见。

对必须清理的资源使用作用域夹具和终结器,包括临时目录、标志、数据库、fiber、服务器和全局状态。