纯 TS 项目工程中, 如何使用 alias path?
参考答案
目标
让 import '@/utils/x' 这类别名在编辑器(类型解析)和运行时/构建(模块解析)都能工作,两边必须同时配置。
1. tsconfig 配置
{
"compilerOptions": {
"baseUrl": ".",
"paths": {
"@/*": ["src/*"],
"@components/*": ["src/components/*"]
}
}
}
2. 打包/运行侧同步
- Vite:
resolve.alias = { '@': path.resolve(__dirname, 'src') } - webpack:
resolve.alias = { '@': path.resolve(__dirname, 'src') } - ts-node:需要
tsconfig-paths/register,或在ts-node配置里指定tsconfig - 纯 tsc 产物 + Node 运行:
paths只影响类型,编译后不会改写 import 路径,需要额外处理——用tsc-alias重写路径,或运行时用module-alias/--experimental-loader,或干脆发布前打包。
3. 常见坑
- 只配了
paths没配打包器 → 编辑器不报错、运行时报 "Cannot find module"。 paths的键要以baseUrl为基准;baseUrl不设时 TS 5 会以 tsconfig 所在目录为基准(行为易混,建议显式写baseUrl)。- ESM 下别名解析更严格,可能需要带扩展名或用
exports映射。 - 测试框架(Jest)也要配
moduleNameMapper,否则单测失败。
纯 TS 项目建议
统一在 tsconfig.base.json 定义 paths,各构建工具读取同一份 alias 配置(如用 vite-tsconfig-paths 插件自动同步),避免多处维护漂移。