mcpField
P
principle-type-system-discipline

principle-type-system-discipline

github.com/ericlitman开发54249 次安装2 周前更新
代码仓库

关于 principle-type-system-discipline

Type System Discipline 是一项开发技能,借助类型系统实践避免无效状态和类型不匹配。它面向设计应用类型的开发者,涵盖语义原始类型、非可信输入解析,以及从权威模式派生类型。

主要功能

  1. 01为语义不同的原始类型添加标记
  2. 02在系统边界解析数据
  3. 03从权威模式派生类型

适用场景

  1. 01区分用户 ID 与订单 ID
  2. 02为解析后的 RPC 或配置数据定义类型
  3. 03根据 API 或数据库模式生成类型

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/ericlitman/open-pstack --skill principle-type-system-discipline

安装后在 Claude Code 中输入/principle-type-system-discipline确认已加载。

详细介绍

类型系统规范

让编译器拒绝不可能的状态、不匹配的基本类型和未处理的变体。与其不断增加处理程序,不如优先让错误和特殊情况无从产生。TypeScript 语法请参阅 typescript-best-practices 技能。

  • 为具有语义的基本类型添加品牌标记。 UserId 和 OrderId 底层都是字符串,但不应可以互换。为它们分别定义类型,例如在 TypeScript 中使用品牌交叉类型,或在其他语言中使用 newtype。创建时验证一次,下游代码即可信任该类型。如果两个参数的基本类型相同,但含义不同,就为它们添加品牌标记。
  • 外部数据在解析之前没有类型。 RPC 负载、JSON、IPC 消息、CLI 参数、配置文件、环境变量、数据库行都是如此。在每个边界都添加解析函数,将非结构化输入转换为有类型的模型。boundary-discipline 原则技能说明了应将验证放在哪里。
  • 从权威架构中派生类型。 如果某个形状由协议缓冲区、OpenAPI 规范、GraphQL 架构、数据库迁移、设计令牌文件或其他文件定义,就应从中派生类型,而不是手工编写一套平行类型。请参阅 encode-lessons-in-structure 原则技能。

评论

支持 Markdown