openapi-typescript 项目中枚举类型负数值的处理问题

问题背景

在 TypeScript 项目中，使用 openapi-typescript 工具从 OpenAPI 规范生成类型定义时，当枚举(enum)类型中包含负数值时，会遇到一个类型错误。这个错误源于 TypeScript 编译器对负数字面量的特殊处理要求。

错误现象

当 OpenAPI 规范中定义如下枚举值时：

enum:
  - -1
  - 0
  - 1

运行 openapi-typescript 生成类型定义时，会抛出以下错误：

Error: Debug Failure. False expression: Negative numbers should be created in combination with createPrefixUnaryExpression

技术分析

这个问题的根本原因在于 TypeScript 编译器内部对负数字面量的处理机制。在 TypeScript 的 AST(抽象语法树)构建过程中，负数字面量不能直接作为数值字面量节点创建，而应该通过一元表达式(UnaryExpression)来表示。

在 openapi-typescript 的代码实现中，当处理枚举值时，直接尝试创建负数的数值字面量节点，违反了 TypeScript 编译器的这一内部约束。

解决方案

正确的处理方式应该是：

1. 对于正数，可以直接创建数值字面量节点
2. 对于负数，应该创建一元减号操作符表达式，将正数作为操作数

具体实现上，可以在生成 TypeScript AST 时，对枚举值进行判断：

• 如果是字符串形式的负数(以"-"开头)，先提取其绝对值部分
• 然后创建一元减号表达式，将绝对值作为操作数

实现示例

以下是修复该问题的核心代码思路：

function createEnumLiteral(value: string | number) {
  if (typeof value === 'string' && value.startsWith('-')) {
    // 处理负数情况
    const absoluteValue = value.substring(1);
    return ts.factory.createPrefixUnaryExpression(
      ts.SyntaxKind.MinusToken,
      ts.factory.createNumericLiteral(absoluteValue)
    );
  }
  // 处理正数情况
  return ts.factory.createNumericLiteral(String(value));
}

总结

这个问题展示了 TypeScript 编译器内部实现的一些细节约束，特别是在 AST 构建过程中的特殊规则。对于工具开发者来说，理解这些内部机制非常重要，可以避免类似的边界情况问题。

openapi-typescript 作为连接 OpenAPI 规范和 TypeScript 类型系统的桥梁，需要正确处理各种数据类型和边界情况。这个负枚举值问题的修复，进一步完善了工具对 OpenAPI 规范的支持能力。

对于使用者来说，如果遇到类似的类型生成问题，可以检查输入规范中是否包含特殊的数值表示，并考虑升级到包含此修复的版本。