OpenAPI-TS 项目中常量字符串换行符处理问题解析

在 OpenAPI-TS 项目中，当处理包含换行符的常量字符串(const)时，会出现类型定义生成错误的问题。这个问题会导致生成的 TypeScript 类型文件无效，影响开发者的正常使用。

问题现象

当 OpenAPI 规范中包含带有换行符的常量字符串定义时，例如：

{
  "const": "First line.\n\nSecond line.\n\nPS: I love you."
}

OpenAPI-TS 会生成如下 TypeScript 类型定义：

DEFAULT_INSTRUCTIONS?: "First line.

Second line.

PS: I love you.";

这种输出在 TypeScript 中是无效的，因为双引号字符串不允许包含换行符。

技术背景

在 TypeScript 中，字符串字面量类型有三种表示方式：

1. 单引号('...')
2. 双引号("...")
3. 模板字符串(...)

其中只有模板字符串允许包含换行符。当 OpenAPI 规范中的 const 值包含换行符时，应该使用模板字符串语法来生成类型定义。

解决方案

OpenAPI-TS 项目已经通过实验性解析器(experimental parser)解决了这个问题。正确的处理方式应该是：

1. 检测 const 值是否包含换行符
2. 如果包含换行符，使用模板字符串语法(...)生成类型定义
3. 如果不包含换行符，保持原有的单引号或双引号语法

正确的输出应该如下：

DEFAULT_INSTRUCTIONS?: `First line.

Second line.

PS: I love you.`;

开发者建议

对于遇到此问题的开发者，可以采取以下措施：

1. 升级到最新版本的 OpenAPI-TS
2. 启用实验性解析器功能
3. 如果暂时无法升级，可以手动修改生成的类型定义文件

这个问题展示了在代码生成工具中处理特殊字符时需要考虑目标语言的语法规则。OpenAPI-TS 团队通过引入更智能的字符串生成逻辑，确保了生成的代码始终符合 TypeScript 语法规范。