Drizzle ORM 跨包类型推断问题分析与解决方案
问题背景
在使用 Drizzle ORM 构建的 monorepo 项目中,开发者遇到了一个关于类型推断的特殊问题。当在一个共享的数据库包中使用 $inferSelect 和 $inferInsert 生成类型,并在其他包中引用这些类型时,类型会被错误地推断为 any。然而,手动定义的类型却能正常推断。
问题现象
具体表现为:
-
在共享包中定义的类型:
export type User = typeof users.$inferSelect // 在其他包中被推断为 any export type Organization = { id: number, name: string, created_at: Date } // 正常推断 export type UserDetail = User & { organizations: Organization[] } // 只有 Organization[] 部分被正确推断 -
项目结构为 monorepo,包含:
- 共享包 (packages/shared)
- Next.js 应用 (apps/web)
根本原因分析
经过深入调查,发现问题根源在于 TypeScript 的构建配置和类型文件处理方式:
-
构建系统问题:Next.js 的构建系统不支持传统的 TypeScript 项目引用(project references),导致无法正确解析跨包的类型依赖关系。
-
类型文件处理:
.d.ts类型声明文件没有被包含在构建输出中,而实际导入的是原始 schema 文件,这导致了类型推断链的中断。 -
Drizzle ORM 的特殊性:
$inferSelect和$inferInsert是 Drizzle ORM 特有的类型级操作,它们依赖于完整的类型上下文才能正常工作。
解决方案
解决此问题的关键在于确保类型文件被正确处理和包含:
-
正确配置构建系统:
- 确保共享包的
tsconfig.json中设置了"declaration": true以生成类型声明文件 - 确认
"include"和"exclude"配置正确覆盖所有需要处理的文件
- 确保共享包的
-
确保类型文件被包含:
// 在共享包的构建配置中明确包含类型文件 { "include": ["./**/*.ts", "./**/*.d.ts"], "exclude": ["node_modules", "dist"] } -
Next.js 适配方案:
- 使用 Next.js 支持的模块解析方式
- 确保共享包构建后的输出结构符合 Next.js 的预期
最佳实践建议
-
monorepo 类型共享:
- 对于 Drizzle ORM 生成的类型,建议将其单独导出到一个类型文件中
- 考虑使用类型重导出来减少依赖链的复杂性
-
构建流程优化:
- 在共享包中设置预构建脚本,确保类型文件先被生成
- 在消费者应用中配置正确的类型查找路径
-
调试技巧:
- 使用
tsc --traceResolution来跟踪类型解析过程 - 检查构建后的 dist 目录,确认所有必要的类型文件都存在
- 使用
总结
Drizzle ORM 的类型系统在 monorepo 环境中需要特别注意构建配置和类型文件的处理。通过确保类型文件被正确包含在构建过程中,并适当配置 TypeScript 的模块解析,可以解决跨包类型推断为 any 的问题。这个问题也提醒我们,在使用高级类型特性时,需要更加关注构建系统的细节配置。
对于使用 Drizzle ORM 的开发者来说,理解类型推断的工作原理和构建系统的交互方式,将有助于避免类似问题的发生,并构建出更加健壮的类型系统。
PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00- DDeepSeek-OCR暂无简介Python00
openPangu-Ultra-MoE-718B-V1.1昇腾原生的开源盘古 Ultra-MoE-718B-V1.1 语言模型Python00
HunyuanWorld-Mirror混元3D世界重建模型,支持多模态先验注入和多任务统一输出Python00
AI内容魔方AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。03
Spark-Scilit-X1-13BFLYTEK Spark Scilit-X1-13B is based on the latest generation of iFLYTEK Foundation Model, and has been trained on multiple core tasks derived from scientific literature. As a large language model tailored for academic research scenarios, it has shown excellent performance in Paper Assisted Reading, Academic Translation, English Polishing, and Review Generation, aiming to provide efficient and accurate intelligent assistance for researchers, faculty members, and students.Python00
GOT-OCR-2.0-hf阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile013
Spark-Chemistry-X1-13B科大讯飞星火化学-X1-13B (iFLYTEK Spark Chemistry-X1-13B) 是一款专为化学领域优化的大语言模型。它由星火-X1 (Spark-X1) 基础模型微调而来,在化学知识问答、分子性质预测、化学名称转换和科学推理方面展现出强大的能力,同时保持了强大的通用语言理解与生成能力。Python00- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00