NX Monorepo中如何扩展tsconfig.base.json实现路径别名继承？

TypeScript的子tsconfig.json中，compilerOptions.paths会完全覆盖父配置的paths而非合并，这是导致你遇到问题的核心原因。以下是几种优雅的解决方式：

方案1：统一在base配置库内子路径（最简洁） #

直接在tsconfig.base.json中扩展每个库的路径别名，同时包含根导出和内部子路径：

{
  "compilerOptions": {
    "baseUrl": ".",
    "paths": {
      "@sca/config": ["libs/sca-config/src/index.ts"],
      "@sca/config/*": ["libs/sca-config/src/*"],
      "@sca/utils": ["libs/sca-utils/src/index.ts"],
      "@sca/utils/*": ["libs/sca-utils/src/*"]
    }
  }
}

然后删除每个库tsconfig中的paths配置，仅保留继承：

// libs/sca-config/tsconfig.json
{
  "extends": "../../tsconfig.base.json"
}

• 跨库导入：使用@sca/utils或@sca/utils/xxx
• 库内部导入：使用@sca/config/xxx替代原@/xxx

优点：所有别名集中管理，无需维护库级paths，彻底避免覆盖问题；语义清晰，不会出现多库@/*别名冲突。
缺点：内部导入别名稍长，但可读性更强。

方案2：用脚本自动合并paths #

编写Node脚本自动将base的paths合并到每个库的tsconfig中，避免手动重复配置：

1. 创建scripts/update-lib-paths.js：

const fs = require('fs');
const path = require('path');

// 读取base配置中的路径别名
const baseConfig = JSON.parse(fs.readFileSync('./tsconfig.base.json', 'utf8'));
const basePaths = baseConfig.compilerOptions.paths || {};

// 遍历所有库目录
const libsDir = './libs';
fs.readdirSync(libsDir).forEach(libFolder => {
  const libTsConfigPath = path.join(libsDir, libFolder, 'tsconfig.json');
  if (!fs.existsSync(libTsConfigPath)) return;

  const libConfig = JSON.parse(fs.readFileSync(libTsConfigPath, 'utf8'));
  // 合并base路径与库自定义路径
  libConfig.compilerOptions.paths = {
    ...basePaths,
    ...(libConfig.compilerOptions.paths || {})
  };

  // 写回格式化后的配置文件
  fs.writeFileSync(libTsConfigPath, JSON.stringify(libConfig, null, 2));
});

2. 在package.json中添加执行脚本：

{
  "scripts": {
    "sync-lib-paths": "node scripts/update-lib-paths.js"
  }
}

3. 每次新增库或修改base的paths后，运行npm run sync-lib-paths自动合并。

优点：保留你习惯的@/*内部别名，无需修改导入写法；
缺点：需要额外维护脚本，每次配置变更后需手动执行。

方案3：使用NX工作区生成器自动配置 #

利用NX的工作区生成器，在创建新库时自动完成paths合并配置：

1. 生成自定义生成器：

nx g workspace-generator lib-tsconfig-setup

2. 在tools/generators/lib-tsconfig-setup/generator.ts中编写核心逻辑：

import { Tree, formatFiles } from '@nrwl/devkit';
import * as fs from 'fs';

export default async function (tree: Tree, schema: any) {
  const baseConfig = JSON.parse(fs.readFileSync('tsconfig.base.json', 'utf8'));
  const basePaths = baseConfig.compilerOptions.paths || {};

  const libTsConfigPath = `libs/${schema.name}/tsconfig.json`;
  const libConfig = JSON.parse(tree.read(libTsConfigPath)!.toString());
  
  libConfig.compilerOptions.paths = {
    ...basePaths,
    '@/*': [`libs/${schema.name}/src/*`]
  };

  tree.write(libTsConfigPath, JSON.stringify(libConfig, null, 2));
  await formatFiles(tree);
}

3. 创建新库时执行生成器完成配置：

nx g @nrwl/js:lib sca-new-lib && nx run workspace-generator:lib-tsconfig-setup --name=sca-new-lib

优点：自动化配置，新增库时无需手动处理；适合长期维护的大型仓库。
缺点：需要了解NX生成器的编写逻辑。

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