如何简化tsconfig.json的paths配置？解决多API路径复用问题

方案1：用脚本自动生成paths配置 #

如果你的API子文件夹数量较多或者会频繁新增，写个简单的Node.js脚本遍历./projects/APIs/下的所有子目录，自动生成对应的paths规则是最高效的方式。

示例脚本（保存为generate-tsconfig-paths.js）：

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

const tsconfigPath = path.resolve(__dirname, 'tsconfig.json');
const apisDir = path.resolve(__dirname, 'projects/APIs');

// 读取现有tsconfig
const tsconfig = JSON.parse(fs.readFileSync(tsconfigPath, 'utf8'));

// 遍历API子目录生成paths
const paths = {};
fs.readdirSync(apisDir, { withFileTypes: true })
  .filter(dirent => dirent.isDirectory())
  .forEach(dirent => {
    const apiName = dirent.name;
    paths[`@example/${apiName}/*`] = [`./projects/APIs/${apiName}/src/lib/*`];
  });

// 更新tsconfig的paths
tsconfig.compilerOptions.paths = paths;

// 写回tsconfig.json
fs.writeFileSync(tsconfigPath, JSON.stringify(tsconfig, null, 2));

运行脚本后就能自动生成所有需要的paths规则，后续新增API子文件夹时重新跑一遍脚本即可。

方案2：调整别名指向，简化导入路径 #

如果不想写脚本，可以修改paths配置，让别名指向每个API的src/lib目录根，这样导入时可以省略src/lib部分：

"paths": {
  "@example/APIs/*": ["./projects/APIs/*/src/lib"]
}

之后导入文件时，直接写：

import { SomeService } from '@example/APIs/api1/SomeService';

TypeScript会自动解析到./projects/APIs/api1/src/lib/SomeService.ts。

方案3：统一共享文件目录结构（可选） #

如果项目允许调整目录结构，可以把所有API的共享文件迁移到一个统一的目录下，比如./projects/APIs/shared/lib/，然后只需要一条paths规则：

"paths": {
  "@example/APIs/*": ["./projects/APIs/shared/lib/*"]
}

不过这个方案需要调整现有文件的存放位置，适合重构阶段考虑。

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