jestjs - 防止在 Monorepo 中重复 TypeScript 路径配置

要点

我喜欢遵循“干式”（不要重复自己）原则。但目前我在三个不同的地方有几乎相同的路径配置：

1. Typescript 配置文件

我有一个包含多个 Bazel TypeScript 包的 monorepo，因此我需要在 tsconfig.json 中像这样引用它们的路径

"paths": {
  "@cents-ideas/enums": ["./packages/enums"],
  "@cents-ideas/utils": ["./packages/utils"],
  "@cents-ideas/event-sourcing": ["./packages/event-sourcing"],
  "@cents-ideas/models": ["./packages/models"]
},

2. 节点包文件

对于使用 ts-node 的开发，我还需要将路径添加到 package.json 中，以便 Node.js 可以识别 TypeScript 别名。（我正在使用一个名为 module-alias 的包来实现这一点。）

"_moduleAliases": {
  "@cents-ideas/enums": "./packages/enums",
  "@cents-ideas/utils": "./packages/utils",
  "@cents-ideas/event-sourcing": "./packages/event-sourcing",
  "@cents-ideas/models": "./packages/models"
}

3. Jest 配置文件

最后，我还需要将这些路径添加到我的 Jest 配置中，这样测试才能找到这些路径：

moduleNameMapper: {
  '^@cents-ideas/utils(.*)$': '<rootDir>/packages/utils$1',
  '^@cents-ideas/event-sourcing(.*)$': '<rootDir>/packages/event-sourcing$1',
  '^@cents-ideas/enums(.*)$': '<rootDir>/packages/enums$1',
  '^@cents-ideas/models(.*)$': '<rootDir>/packages/models$1',
},

目标

我的目标是有一个公共的地方，我可以放置路径，所有其他地方都会自动更新。

以防你需要对这个项目有更多了解，你可以在这里查看：https://github.com/flolude/cents-ideas

答案＃1

Typescript 配置文件

"paths": {
  "@cents-ideas/*": ["./packages/*"]
},

节点包文件

const moduleAlias = require('module-alias');

const registerAliases = () => {
  if (process.env.ENV === 'dev') {
    const fs = require('fs');
    const paths: string[] = fs.readdirSync('./packages');
    paths.forEach(addPackageAlias);
  }
};

const addPackageAlias = (name: string) => {
  moduleAlias.addAlias(`@cents-ideas/${name}`, `${__dirname}../../../packages/${name}`);
};

registerAliases();

Jest 配置文件

在 Bazel 的帮助下已修复。但我确定 Jest 支持与 Typescript 配置类似的通配符。

答案＃2

你正在使用 yarn，所以你可能应该看看 yarn 工作区。你应该能够添加

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

然后运行 yarn，它会在 node_modules 中创建符号链接，你应该能够移除上面提到的所有三种配置