Nx使用tsc executor构建时导入其他库运行找不到模块如何解决

该问题与Stack Overflow帖子《Building library with imports from another library using NX Monorepo》描述的场景一致，具体复现场景如下：

• 在Nx monorepo中搭建Node应用与配套代码库，应用采用@nrwl/js:tsc executor构建（未使用默认webpack构建方案），构建完成后通过@nrwl/node:node执行，项目project.json初始配置如下：

"build": {
  "executor": "@nrwl/js:tsc",
  "outputs": ["{options.outputPath}"],
  "options": {
    "main": "apps/dep/src/main.ts",
    "outputPath": "dist/apps/dep",
    "tsConfig": "apps/dep/tsconfig.app.json"
  }
},
"serve": {
  "executor": "@nrwl/node:node",
  "options": {
    "buildTarget": "dep:build"
  }
},

• 初始从其他内部代码库导入内容时，因导入文件不在rootDir范围内导致构建失败，导入语句示例：

import { MyEnum } from '@zorro/types';

• 参考帖子给出的临时方案，在tsconfig.app.json中添加如下配置后，构建阶段的报错消失：

"compilerOptions": {
  ...
  "incremental": false,
  "paths": { "@zorro/*": ["dist/libs/*"] }
},

• 但运行构建产物时Node抛出如下错误，无法正常启动：

Error: Cannot find module '@zorro/types'

• 核心诉求：明确需要调整的配置项，让编译生成的main.js文件可以正确解析依赖库路径。

• TypeScript的paths配置仅做编译阶段的路径映射，TSC默认不会将别名路径转换为Node.js可识别的真实路径，编译后的代码仍保留@zorro/types这类别名导入语法，原生Node.js运行时无法识别该类路径，因此抛出模块找不到的错误。
• 现有配置将@zorro/*直接映射到dist/libs/*存在逻辑缺陷：如果依赖库未提前构建输出到dist目录，TS编译阶段会直接报找不到源文件，正常的路径映射应该优先指向libs目录下的库源码，而非构建产物。

方案一：使用Nx原生能力处理（推荐） #

该方案不需要引入额外第三方依赖，适配Nx monorepo的标准工作流：

1. 修正tsconfig.app.json中的路径映射，指向库源码入口：

"compilerOptions": {
  "incremental": false,
  "paths": {
    "@zorro/*": ["libs/*/src/index.ts"]
  }
}

如果对应库的入口文件不是src/index.ts，可根据库的实际package.json中main字段配置调整映射路径。
2. 确认所有@zorro/*前缀的内部库都是可构建库（通过@nrwl/js:library生成，且自身配置了build target）。
3. 修改应用的project.json中build配置项，添加Nx路径自动处理参数：

"build": {
  "executor": "@nrwl/js:tsc",
  "outputs": ["{options.outputPath}"],
  "options": {
    "main": "apps/dep/src/main.ts",
    "outputPath": "dist/apps/dep",
    "tsConfig": "apps/dep/tsconfig.app.json",
    "buildLibsFromSource": false,
    "updateBuildableProjectDepsInPackageJson": true
  },
  "dependsOn": ["^build"]
}

配置说明：

• dependsOn: ["^build"]：构建应用前自动构建所有依赖的内部库
• buildLibsFromSource: false：构建时自动将TS别名路径替换为指向dist目录下依赖库构建产物的相对路径
• updateBuildableProjectDepsInPackageJson: true：自动更新构建产物目录下的package.json，将依赖的内部库写入依赖列表

方案二：使用tsc-alias做编译后路径替换 #

如果不需要将内部库单独构建输出，可在TS编译完成后自动替换别名路径：

1. 安装开发依赖：

npm install tsc-alias -D

2. 同样先修正tsconfig.app.json中的路径映射为源码路径（同方案一第一步）。
3. 在应用的build配置中添加dependsOn规则（同方案一第三步中的dependsOn配置）。
4. 调整构建命令，在TS编译完成后执行路径替换：

"scripts": {
  "build:dep": "nx build dep && tsc-alias -p apps/dep/tsconfig.app.json"
}

验证方法 #

重新执行构建后，打开dist/apps/dep/main.js查看导入语句，若原@zorro/types别名已被替换为Node可识别的相对路径，则配置生效。

注意：不要将路径映射硬编码指向dist目录，否则每次构建应用前都需要手动提前构建所有依赖库，会大幅降低开发效率。

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