skills

为AI编码助手提供Effect框架的编码规范与最佳实践指导。

安装使用

复制下面这段提示词发给你的 AI(Claude / Cursor / TRAE / Codex / WorkBuddy 等),它会自动帮你完成安装:

帮我安装这个 AI Skill:skills。
它的用途是:为AI编码助手提供Effect框架的编码规范与最佳实践指导。
完整的 Skill 内容见:https://321skill.com/skills/skills-effect-ts/raw/index.md
请读取该页面内容,如果是 SKILL.md 格式直接安装,如果是 README 提炼核心 prompt 后安装。

提示词包含完整的 Skill 内容链接,AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。

使用示例

当你需要为Effect项目添加一个新的数据查询服务时,可以

对AI说:“请遵循Effect Skills的规范,帮我创建一个使用Layer和Schema的用户查询服务。” AI助手会基于技能库的指导,生成类型安全、符合依赖注入规范、并优先使用`Effect.fn`和Schema的代码结构,而不是随意拼接API。

介绍

Effect Skills 是一个专为AI编码助手设计的技能库,旨在解决开发者在基于Effect框架的项目中,因缺乏统一、强制的编码规范而导致代码风格不一致、架构混乱和最佳实践缺失的问题。它通过向AI助手注入预设的规则和指南,确保生成的代码遵循Effect社区推崇的架构模式和类型安全原则。

使用时,开发者只需在项目中通过简单的命令安装此技能,AI助手(如Cursor、Claude等)便会自动加载并应用其中定义的规范。技能库的核心是一个结构化的Markdown知识库,包含了从基础构造器使用、依赖注入与Layer管理,到复杂的Schema设计、错误处理和SQL迁移等全方位指导,并鼓励优先查阅本地指南而非直接搜索源代码。

该技能主要面向使用Effect-TS框架进行中大型TypeScript应用开发的团队和个人开发者,尤其适合那些希望提升代码质量、强化类型安全并统一团队编码风格的场景。它要求项目在本地有一个Effect仓库的副本(位于./.repos/effect),以支持更深层次的上下文理解和代码生成。

与普通的API文档或零散的代码片段集合不同,Effect Skills的核心区别在于其“强观点性”和“操作导向”。它不仅仅描述Effect能做什么,而是明确规定了在真实项目中的“应该怎么做”,例如优先使用Effect.fn、推崇类型安全的Schema驱动开发、以及使用Effect原生的测试工具@effect/vitest等,旨在将最佳实践编码为AI可执行的指令。

核心特点

本Skill的核心区别在于其“强观点性”和“操作导向”,它不仅提供API参考,更强制规定了Effect框架在真实项目中的实现偏好(如优先使用`Effect.fn`、Schema驱动、原生测试工具),并将这些规范编码为AI助手可直接遵循的指令,而非被动的知识库。

注意事项

不适合不熟悉Effect框架基础概念的新手,或项目结构无法满足其要求(如在本地存放Effect仓库副本)的轻量级、快速原型开发场景。

常见问题

Effect Skills 和普通的 Effect 官方文档有什么区别?

官方文档是全面的API参考,而Effect Skills是编码规范和最佳实践的“操作手册”,它告诉AI在具体场景下“应该怎么写”,具有更强的指导性和约束性。

安装这个Skill后,AI助手会自动应用所有规范吗?

是的,安装后,具备Skill感知能力的AI编码助手(如某些配置下的Cursor)会在相关编码任务中自动参考并应用此技能库中定义的规范和最佳实践。

给 AI 助手的安装指引

如果你的 AI 编程助手(Claude Code、Cursor、TRAE 等)能看到这个页面,把下面这段发给它即可自动完成安装:

请访问 https://321skill.com/skills/skills-effect-ts/raw/index.md 读取 skills 的原始 Skill 定义(Markdown 格式),按其中说明在我的环境里完成安装和配置。