如何正确导入NestJS数据库实体模型项目到其他NestJS项目
本地实体包IDE无提示、无法跳转的修复步骤
- 在实体包的
package.json中补充类型声明入口配置,新增types字段指向编译后的类型文件入口:
"types": "dist/index.d.ts"
缺少该字段时,TypeScript和IDE只会默认在包根目录查找index.d.ts文件,不会主动进入dist目录检索类型定义,无法给出导入提示和跳转支持。
- 检查实体包的
tsconfig.json配置,确保编译过程会生成类型声明文件:
{ "compilerOptions": { "declaration": true, "declarationMap": true } }
其中declaration: true是核心要求,开启后执行构建命令时会同步生成与js文件对应的.d.ts类型声明;declarationMap: true为可选优化,开启后可以实现从使用方直接跳转到实体包的原始TS源码,而非仅能跳转到dist目录下的编译后声明文件。
- 在实体包根目录下执行构建命令,生成完整的dist产物:
npm run build
执行完成后确认dist目录下已存在对应的.d.ts文件,而非仅包含编译后的js代码。
- 回到使用方项目排查本地包安装状态:
- 确认
node_modules下的models包为指向实体包源码路径的符号链接,不存在文件拷贝缺失问题 - 如果链接异常,可删除
node_modules下的models目录、移除package-lock.json中对应models的条目,重新执行安装命令:
npm install PATH_TO_ENTITIES_PACKAGE - 确认
可选开发优化:如果在联调阶段需要频繁修改实体包代码,可使用npm link替代普通本地安装减少重复操作:
- 在实体包目录下执行
npm link,将当前包注册到全局npm链接目录 - 在使用方项目目录下执行
npm link models,将全局注册的包链接到当前项目的node_modules中 - 为实体包开启tsc watch模式,代码修改后会自动生成类型声明,使用方可以实时同步拿到最新的类型提示
内容的提问来源于stack exchange,提问作者Daniel Stefanelli
相关产品推荐
相关产品推荐

