SuperAPI AI 工具集

zod-infer-type-best-practice

编程与开发

查看项目

更新于 10-16 06:01

技能介绍

用途

该技能用于约束管理 Zod schema 与 TypeScript 类型之间的同步关系。当项目中存在 Zod schema 定义时,该规范要求所有 TypeScript 类型必须直接从 schema 派生,避免手写重复的类型声明,从而消除类型与校验逻辑不一致的风险。

核心原则

Zod schema 是唯一真实来源(Single Source of Truth)。TypeScript 类型必须从 schema 派生,不得手写重复的 interface/type。

禁止行为

  • 项目中存在 Zod schema 定义时,禁止另建 type.ts 文件重复声明类型
  • 不得手写与 schema 重复的 interface/type

前置条件

必须先确认项目已安装 Zod。若未安装,则先执行:

pnpm add zod

使用方式

  • 阅读规范说明,了解核心原则与禁止行为
  • 对照检查清单逐项验证代码
  • 参考最佳实践示例理解正确写法

适用场景

适用于任何使用 Zod 进行 schema 定义的项目,尤其是在需要保证运行时校验与静态类型一致性、避免维护两份定义的 TypeScript 项目中。

限制

资料中未提供更多关于具体检查清单条目、最佳实践示例细节及适用范围边界的信息。