NestJS私有外部包集成golevelup/rabbitmq依赖报错求助

问题背景 #

创建NestJS私有外部包集成@golevelup/nestjs-rabbitmq以复用RabbitMQ配置，包内已配置PersoRabbitModule并设置默认参数，但其他项目引入该包时，出现RabbitMQModule无法解析ExternalContextCreator依赖的错误。直接在API项目中使用该库可正常运行。

解决方案 #

1. 调整私有包的依赖配置 #

在私有包的package.json中，将NestJS核心依赖及RabbitMQ库设为peerDependencies，避免私有包单独安装一份依赖导致实例隔离：

{
  "peerDependencies": {
    "@nestjs/common": "^9.0.0",
    "@nestjs/core": "^9.0.0",
    "@golevelup/nestjs-rabbitmq": "^4.0.0"
  },
  "dependencies": {
    // 仅保留私有包独有的业务依赖，不要包含NestJS核心或RabbitMQ相关库
  }
}

2. 修正PersoRabbitModule的导出配置 #

检查模块的exports数组，确保正确导出RabbitMQModule，同时保证模块上下文的依赖传递：

import { Module } from '@nestjs/common';
import { RabbitMQModule } from '@golevelup/nestjs-rabbitmq';
import { ConfigurableModuleClass } from './perso-rabbit.module-def';

@Module({
  imports: [
    RabbitMQModule.forRootAsync(RabbitMQModule, {
      useFactory: () => {        
        return {
          exchanges: [{ name: "rabname", type: "rabtype" }],
          uri: `amqp://rabbitmq:rabbitmq@localhost:5672`,
          connectionInitOptions: { wait: false },
        };
      },
    }),
  ],
  exports: [RabbitMQModule], // 修正导出项，确保宿主项目能访问RabbitMQ模块的提供者
})
export class PersoRabbitModule extends ConfigurableModuleClass {}

3. 确保宿主项目依赖完整 #

在宿主项目中安装所有必要依赖：

npm install @nestjs/common @nestjs/core @golevelup/nestjs-rabbitmq

4. 验证私有包构建与版本 #

确保私有包编译后的代码保留了正确的模块导入关系，且宿主项目安装的是私有包的最新版本。

原因说明 #

该错误本质是私有包与宿主项目的NestJS核心依赖实例不隔离（私有包单独安装了@nestjs/core），导致RabbitMQModule在私有包的模块上下文中无法找到宿主项目核心模块提供的ExternalContextCreator。通过将核心依赖设为peerDependencies，强制私有包复用宿主项目的依赖实例，即可解决依赖解析问题。

内容的提问来源于stack exchange，提问作者Silvère Nef