Hey API OpenAPI-TS 项目中 TanStack React Query 插件路径问题分析

在 Hey API 的 OpenAPI-TS 项目中，当配置项 config.client.bundle 设置为 true 时，TanStack React Query 插件生成的客户端代码存在一个路径引用错误。这个问题会导致构建工具无法正确解析模块路径，进而影响项目的正常编译和运行。

问题现象

在生成的 @tanstack/react-query.gen.ts 文件中，存在以下错误的导入语句：

import type { Options } from './client';  // 错误的相对路径

正确的导入路径应该是 '../client' 而不是 './client'。这个路径错误会导致构建工具无法找到对应的模块文件。

技术背景

在 TypeScript 项目中，模块路径解析是一个关键环节。当使用相对路径导入时：

1. './client' 表示从当前目录查找 client 模块
2. '../client' 表示从父目录查找 client 模块

在 Hey API OpenAPI-TS 的代码生成结构中，生成的 React Query 客户端文件通常位于 @tanstack 子目录中，而基础客户端文件则位于父目录。因此需要使用 ../ 来正确引用父级目录中的模块。

影响范围

这个路径错误会影响以下场景：

1. 使用 config.client.bundle = true 配置的项目
2. 使用 TanStack React Query 插件的项目
3. 使用 TypeScript 或 JavaScript 模块系统的构建环境

解决方案

项目维护者已经确认了这个问题，并标记为高优先级。修复方案应该是修改代码生成逻辑，确保在生成 React Query 客户端代码时使用正确的相对路径 ../client 来引用基础客户端模块。

对于开发者来说，如果遇到这个问题，可以暂时手动修改生成的代码文件，将路径更正为 ../client，或者等待官方发布修复版本。

最佳实践

在使用代码生成工具时，建议：

1. 定期检查生成的代码是否符合预期
2. 关注项目的 issue 列表，了解已知问题
3. 对于关键业务代码，考虑添加构建时的验证步骤
4. 保持生成工具的版本更新，及时获取问题修复

这个问题的发现和修复过程也体现了开源社区协作的价值，通过用户反馈和开发者响应的良性互动，共同提升工具的质量和稳定性。