NPM公共库如何配置依赖实现跨项目按需加载且无编译错误

理论场景通用配置 #

• 公共库A将仅项目B需要的依赖D从dependencies迁移到peerDependencies，同时在peerDependenciesMeta中将D标记为可选，要求使用方按需安装。
• 公共库A内所有对D的引用优先用import type导入类型，避免编译产物中保留对D的硬导入逻辑。
• 公共库A的tsconfig.json开启importsNotUsedAsValues: "remove"配置，自动删除未使用的导入语句。
• 项目B显式安装依赖D满足使用需求，项目C无需安装，两侧项目的tsconfig.json均开启skipLibCheck: true，跳过对依赖库的类型校验避免报错。

实际场景落地步骤 #

1. 调整DTO公共库依赖配置 #

修改DTO库的package.json，移除dependencies中的@nestjs/swagger，新增如下配置：

{
  "peerDependencies": {
    "@nestjs/swagger": "^7.0.0"
  },
  "peerDependenciesMeta": {
    "@nestjs/swagger": {
      "optional": true
    }
  }
}

2. 新增装饰器兼容逻辑 #

在DTO库中新增工具文件，做装饰器的运行时兼容：

// src/compat.ts
let ApiProperty: (options?: any) => PropertyDecorator = () => () => {};
try {
  const swaggerModule = require('@nestjs/swagger');
  ApiProperty = swaggerModule.ApiProperty;
} catch (e) {}

export { ApiProperty };

所有DTO文件中的@ApiProperty装饰器统一从该兼容文件导入，不再直接依赖@nestjs/swagger。

3. 调整前后端项目配置 #

在Angular前端项目和Nest后端项目的tsconfig.json中新增配置：

{
  "compilerOptions": {
    "skipLibCheck": true
  }
}

后端项目正常安装@nestjs/swagger即可正常使用装饰器能力，前端项目无需安装该依赖也不会出现编译报错。

内容的提问来源于stack exchange，提问作者Ugo Evola