配置test目录tsconfig后路径别名IDE自动补全与类型提示失效求助

配置修改步骤 #

1. 调整tests目录下的tsconfig.json #

删除手动添加的paths配置，新增baseUrl指向项目根目录：

{
  "extends": "../tsconfig.json",
  "compilerOptions": {
    "module": "commonjs",
    "experimentalDecorators": true,
    "strictPropertyInitialization": false,
    "isolatedModules": false,
    "strict": false,
    "noImplicitAny": false,
    "baseUrl": "../"
  },
  "exclude": ["../node_modules", "*.js"],
  "include": ["./**/*.ts", "../src/**/*"]
}

2. 修正register.js的路径注册配置 #

将tsConfigPaths.register的基准路径改为项目根目录，直接复用根目录tsconfig的paths规则即可：

/* eslint-disable @typescript-eslint/no-var-requires */
const tsNode = require("ts-node");
const tsConfigPaths = require("tsconfig-paths");
const mainTSConfig = require("./tsconfig.json");

tsConfigPaths.register({
  baseUrl: "./",
  paths: mainTSConfig.compilerOptions.paths,
});

tsNode.register({
  files: true,
  transpileOnly: true,
  project: "./tests/tsconfig.json",
});

3. 生效验证 #

清理IDE缓存后重启编辑器，再运行测试命令，此时IDE的路径别名自动补全、类型提示功能正常，测试运行时也能正确解析别名，不会抛出模块找不到的错误。

问题原因说明 #

之前的冲突来自路径基准不一致：

• 保留tests目录tsconfig的paths配置时，baseUrl默认指向tests目录本身，运行测试时解析路径正确，但IDE会优先匹配根目录tsconfig的别名规则，出现识别冲突。
• 删除tests目录tsconfig的paths配置时，继承的paths规则会基于tests目录解析，指向不存在的tests/src/*路径，导致测试运行失败。
  修改后tests目录的tsconfig显式将baseUrl指向项目根目录，和根目录tsconfig的路径规则完全对齐，同时运行时的路径注册也统一用根目录做基准，两边规则一致就不会出现冲突。

内容的提问来源于stack exchange，提问作者Nikola-Milovic