TypeScript Monorepo中从Node Server引用Next.js Web模块的问题

问题描述 #

我的TypeScript Monorepo包含三个包：

• web（Next.js 项目）
• server（Node.js 服务）
• lib（通用工具库）

从server中引用lib时，使用import { something } from "@acme/lib/dist/somemodule"可以正常工作。但尝试从server引用web的源码模块时，用import { somethingelse } from "@acme/web/src/someothermodule"虽然能通过代码检查，但运行时会报错：Error: Cannot find module '@acme/web/src/someothermodule'。我推测原因是Next.js编译后的JS文件不在src目录，而是在.next目录中，但该目录下的代码是打包后的产物。请问该如何实现从server引用web模块？

1. 为web包配置独立的Node兼容编译流程 #

Next.js默认构建产物是针对浏览器/SSR优化的打包文件，无法直接被Node模块引用。可以给web包新增一套针对Node的编译规则，输出可被直接引用的产物：

• 在web包根目录创建tsconfig.node.json，指定编译目标和输出目录：

  {
    "extends": "./tsconfig.json",
    "compilerOptions": {
      "target": "ES2020",
      "module": "CommonJS",
      "outDir": "./dist",
      "declaration": true,
      "skipLibCheck": true,
      "strict": true
    },
    "include": ["src/shared/**/*"], // 仅编译需要跨包共享的代码
    "exclude": ["node_modules", ".next", "pages", "public"]
  }
  

• 在web包的package.json中添加编译脚本，并配置产物入口：

  {
    "scripts": {
      "build:shared": "tsc -p tsconfig.node.json"
    },
    "main": "./dist/index.js",
    "types": "./dist/index.d.ts"
  }
  

• 将需要被server引用的代码放到src/shared目录，避免引入Next.js专属API（如next/router、getServerSideProps等）。
• 每次修改共享代码后，先运行npm run build:shared，再启动server，之后可通过以下方式引用：

  import { somethingelse } from "@acme/web";
  

2. 迁移共享代码到lib包（更推荐） #

如果web和server都需要用到某部分代码，最合理的做法是将这些代码迁移到已有的lib包中：

• 复用lib包成熟的编译流程，无需额外配置
• 避免代码冗余，保证两端逻辑一致
• 降低跨包引用的维护复杂度

比如把web/src/someothermodule的代码移到lib/src/someothermodule，之后web和server统一从@acme/lib引用即可。

3. 直接引用web源码（仅临时场景使用） #

若必须直接引用web的src目录，需要配置server的TS编译规则以识别源码：

• 在server的tsconfig.json中添加路径映射和源码包含规则：

  {
    "compilerOptions": {
      "baseUrl": ".",
      "paths": {
        "@acme/web/src/*": ["../web/src/*"]
      },
      "skipLibCheck": true
    },
    "include": ["src/**/*", "../web/src/shared/**/*"]
  }
  

• 确保web的共享代码中没有依赖浏览器专属API，否则server运行时会因环境不兼容报错。
• 运行server前，需将web的源码编译为JS（可单独用tsc编译共享部分，或让server的编译流程一并处理）。

注意：这种方式维护风险高，容易出现Node不兼容的代码问题，不推荐生产环境使用。

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