node.js - Monorepo – Yarn workspaces Typescript Node.JS 项目 – 运行 nodemon 时找不到模块

Question

我已经使用 yarn workspaces 为 typescript Node.JS 项目设置了一个 monorepo。构建项目工作正常，但是，我在本地开发过程中遇到了问题。

我需要在运行 yarn dev 之前手动运行 yarn build。否则我会收到以下错误:

Error: Cannot find module '/Users/benedikt/code/monorepo-build/node_modules/@bhirmer/utils/dist/index.js'. Please verify that the package.json has a valid "main" entry

这是 sample repo重现了这个问题。

或者，重要文件。

项目结构

packages/
  utils
services/
  api

根 package.json

{
  "name": "@bhirmer/monorepo",
  "description": "Workspace",
  "private": true,
  "workspaces": [
    "packages/*",
    "services/*"
  ],
  "scripts": {},
  "devDependencies": {
    "eslint": "~7.14.0",
    "typescript": "^4.0.5"
  }
}

root tsconfig.json

{
  "compilerOptions": {
    "module": "commonjs",
    "target": "ES2015",
    "lib": ["ES2019", "dom"],
    "types": ["node"],
    "esModuleInterop": true,
    "skipLibCheck": true,
    "sourceMap": true,
    "noEmitOnError": true,
    "allowUmdGlobalAccess": true,
    "allowJs": false,
    "strict": true,
    "forceConsistentCasingInFileNames": true,
    "noEmit": false,
    "moduleResolution": "node",
    "resolveJsonModule": true,
    "allowSyntheticDefaultImports": true,
    "noImplicitAny": true,
    "noUnusedLocals": true,
    "noImplicitThis": true,
    "strictNullChecks": true,
    "noImplicitReturns": true,
    "preserveConstEnums": true,
    "suppressImplicitAnyIndexErrors": true,
    "composite": true,
    "baseUrl": "../..",
    "paths": {
      "@bhirmer/*": ["packages/*/src"]
    }
  },
  "include": ["src/**/*"],
  "exclude": ["node_modules", "dist"]
}

实用程序包.json

{
  "name": "@bhirmer/utils",
  "version": "1.0.0",
  "main": "dist/index.js",
  "types": "dist/index.d.ts",
    "files": [
        "dist"
    ],
  "scripts": {
    "build": "yarn run clean && yarn run compile",
    "clean": "rimraf ./dist && rimraf ./tsconfig.buildinfo",
    "compile": "tsc --build",
    "test": "yarn run build"
  },
  "dependencies": {
    "@types/node": "^14.14.12"
  },
  "devDependencies": {},
  "sideEffects": false
}

实用程序 tsconfig.json

{
  "extends": "../../tsconfig.json",
  "compilerOptions": {
    "baseUrl": "../../",
    "rootDir": "./src",
    "outDir": "./dist",
    "composite": true
  },
  "include": ["src/**/*"],
  "exclude": ["node_modules", "dist"]
}

API 包.json

{
  "name": "@bhirmer/api",
  "description": "api",
  "author": "Benedikt Hirmer <benedikt@hirmer.me",
  "license": "UNLICENSED",
  "private": true,
  "version": "1.0.0",
  "main": "server/index",
  "scripts": {
    "dev": "PROJECT_ID=test-dev PORT=3010 nodemon src/server/index.ts",
    "clean": "rimraf ./dist",
    "compile": "NODE_ENV=production tsc --build",
    "build": "yarn run compile",
    "start": "PROJECT_ID=test-prod NODE_ENV=production node dist/server/index.js",
  },
  "dependencies": {
    "@bhirmer/utils": "^1.0.0",
    "@types/compression": "^1.7.0",
    "@types/express": "^4.17.11",
    "@types/node": "^14.14.12",
    "compression": "^1.7.4",
    "express": "^4.17.1",
    "typescript": "^4.2.4"
  },
  "devDependencies": {
    "nodemon": "^2.0.7",
    "ts-node": "^9.1.1"
  }
}

API tsconfig.json

{
  "extends": "../../tsconfig.json",
  "compilerOptions": {
    "outDir": "dist",
    "baseUrl": "../../",
    // "rootDir": "src", // Getting `TypeError: src/server/index.ts: Emit skipped` if not commented out
    "composite": true
  },
  "include": ["src/**/*"],
  "types": ["typePatches"],
  "references": [{ "path": "../../packages/utils" }]
}

services/api 中 packages/utils 的使用示例

import { getProjectID } from '@bhirmer/utils';

...

const projectID = getProjectID();

...

另一点要注意的是，一旦我在 services/api/tsconfig.json 中设置了 "rootDir": "src"，然后我遇到了以下错误:

TypeError: src/server/index.ts: Emit skipped if not commented out

Answer 1

NPM 工作区仍然需​​要您在根目录(带有工作区定义/位置的 package.json 所在的位置)内运行 npm install，以便与本地包建立相关的符号链接(symbolic link)。

当你这样做时，你应该得到:

node_modules/
    @bhirmer/
        utils/ <-- symlink to /packages/utils/
        api/ <-- symlink to /services/api/
packages/
    utils/
        ...
services/
    api/
        ...
package.json <-- root package.json with "workspaces"

每次创建一个新的本地包文件夹时，您都必须重新运行它，其中包含 package.json，您希望从其他地方访问它。