如何将Monorepo Node项目打包为单文件？@vercel/ncc报错求助

先帮你理清问题根源：@vercel/ncc 基于Webpack实现，它打包单个文件时会把所有依赖的源码（包括Monorepo内其他子包）纳入当前编译上下文，但你的子包tsconfig.json里rootDir仅指向当前包的src目录，其他子包源码不在这个范围内，因此触发了'rootDir' is expected to contain all source files错误。而tsc能正常工作，是因为它通过项目引用（references）分别处理每个子包的编译范围，不会把所有源码塞进同一个rootDir。

下面是具体的解决步骤：

1. 完善Monorepo工作区配置 #

先在根目录package.json中添加工作区配置，让包管理器能正确识别所有子包：

{
  "workspaces": [
    "packages/*"
  ]
}

这一步能确保子包之间的导入不会错误地去node_modules查找，而是直接指向源码目录。

2. 配置TypeScript项目引用（References） #

项目引用是TypeScript官方的Monorepo解决方案，能让工具明确子包间的依赖关系，解决编译范围冲突问题。

修改根目录tsconfig-build.json #

添加references字段列出所有子包：

{
  "compilerOptions": {
    "target": "es2018",
    "module": "commonjs",
    "lib": ["es2018"],
    "moduleResolution": "node",
    "declaration": true,
    "strict": true,
    "esModuleInterop": true,
    "emitDecoratorMetadata": true,
    "experimentalDecorators": true,
    "sourceMap": true,
    "resolveJsonModule": true,
    "outDir": "build"
  },
  "exclude": ["**/node_modules", "**/build", "**/dist"],
  "references": [
    { "path": "./packages/lib1" },
    { "path": "./packages/lib2" },
    { "path": "./packages/graph" },
    { "path": "./packages/peer" }
  ]
}

修改子包tsconfig.json #

根据依赖关系添加对应references：

• packages/lib2/tsconfig.json（依赖lib1）：

{
  "extends": "../../tsconfig-build.json",
  "compilerOptions": {
    "rootDir": "src",
    "outDir": "build"
  },
  "references": [
    { "path": "../lib1" }
  ]
}

• packages/graph/tsconfig.json（依赖lib2）：

{
  "extends": "../../tsconfig-build.json",
  "compilerOptions": {
    "rootDir": "src",
    "outDir": "build"
  },
  "references": [
    { "path": "../lib2" }
  ]
}

lib1和peer无内部依赖，无需添加references字段。

3. 选择合适的ncc打包方案 #

有两种可行的打包方式，你可以根据需求选择：

方案一：先编译所有子包，再打包已编译的JS文件 #

这种方式最稳妥，先让tsc处理好TypeScript依赖，再用ncc打包编译后的JS：

1. 根目录package.json添加编译脚本：

{
  "scripts": {
    "build:all": "tsc --build tsconfig-build.json"
  }
}

2. packages/graph/package.json修改打包脚本：

{
  "scripts": {
    "build": "ncc build build/index.js"
  }
}

3. 执行顺序：先运行npm run build:all编译所有子包，再进入packages/graph执行npm run build，即可得到单个打包后的JS文件。

方案二：让ncc直接处理TypeScript并识别内部依赖 #

如果想一步完成打包，可以修改ncc命令，指定全局tsconfig并配置路径别名：

1. 根目录tsconfig-build.json添加paths配置，通过别名映射子包源码：

{
  "compilerOptions": {
    /* 原配置不变 */
    "paths": {
      "@your-monorepo/lib1": ["packages/lib1/src"],
      "@your-monorepo/lib2": ["packages/lib2/src"],
      "@your-monorepo/graph": ["packages/graph/src"]
    }
  },
  /* 其他配置不变 */
}

（将@your-monorepo替换为你的项目前缀）
2. 修改子包内的导入语句，使用别名，比如lib2/src/index.ts中导入lib1：

import * as lib1 from '@your-monorepo/lib1';

3. 修改packages/graph/package.json的打包脚本：

{
  "scripts": {
    "build": "ncc build src/index.ts --tsconfig ../../tsconfig-build.json"
  }
}

这样ncc会使用全局tsconfig，通过路径别名找到所有内部依赖的源码，同时避免rootDir冲突。

4. Docker部署验证 #

打包完成后，packages/graph/dist目录下会生成index.js，可以直接用于Docker部署：

FROM node:18-alpine
WORKDIR /app
COPY packages/graph/dist/index.js ./
CMD ["node", "index.js"]

构建镜像后即可正常运行。

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