首页
/ 解决@hey-api/openapi-ts中@tanstack/react-query插件路径生成问题

解决@hey-api/openapi-ts中@tanstack/react-query插件路径生成问题

2025-07-01 17:02:31作者:卓艾滢Kingsley

在基于OpenAPI规范生成TypeScript客户端代码时,@hey-api/openapi-ts是一个常用的工具链。其插件系统允许开发者扩展功能,其中@tanstack/react-query插件能够为React应用生成便捷的查询钩子。然而,近期发现该插件在特定配置下存在路径生成异常的问题。

当开发者启用exportFromIndex选项时,工具会在index.ts中自动导出所有生成的文件。正常情况下,这个功能应该正确识别各个生成文件的路径。但实际使用中发现,对于@tanstack/react-query插件生成的类型文件,工具错误地将其路径简化为./react-query.gen,而实际上该文件是以./@tanstack/react-query.gen路径存在的。

这个问题的根源在于路径生成逻辑没有正确处理包含特殊字符(如@符号)的文件名。在Node.js模块系统中,@符号常用于表示作用域包(scoped packages),但作为普通文件名的一部分时也需要特殊处理。工具在生成导出语句时,应该保留原始文件名中的@符号,而不是将其省略。

该问题已在0.66.7版本中得到修复。修复后的版本会正确生成包含完整文件名的导出语句:

export * from './@tanstack/react-query.gen';

对于开发者而言,遇到类似问题时可以采取以下措施:

  1. 检查生成的文件名是否与导出语句中的路径完全匹配
  2. 确保使用最新版本的@hey-api/openapi-ts工具链
  3. 如果必须使用旧版本,可以手动修改index.ts中的导出路径

这类路径处理问题在代码生成工具中比较常见,特别是在处理包含特殊字符的文件名时。开发者在设计类似工具时,应该特别注意文件系统路径的规范化处理,确保在各种边缘情况下都能生成正确的路径引用。

通过这个案例,我们也看到开源社区快速响应和修复问题的优势。用户反馈的问题能够在较短时间内得到确认和解决,这体现了健康开源项目的活力。

登录后查看全文
热门项目推荐
相关项目推荐