Node.js TypeScript项目中排除目录构建且不破坏模块别名的解决方案咨询

嘿，我看你现在的Node.js + TypeScript项目里，src和test目录都有.ts文件，而且两边都用了@/*的模块别名，还都导入了module-alias/register。你应该是想把test目录从最终的dist构建产物里排除掉，但又不想让test文件里的模块别名失效，对吧？我来给你分享几个实用的解决方案：

方案1：拆分TS配置文件（最推荐） #

这种方法把公共配置和构建配置分开，既能保证IDE和类型检查时识别test里的别名，又能让构建只处理src目录，非常清晰：

1. 新建tsconfig.base.json，存放所有公共的TypeScript配置：

{
  "compilerOptions": {
    "target": "es6",
    "module": "commonjs",
    "sourceMap": true,
    "strict": true,
    "strictNullChecks": true,
    "strictPropertyInitialization": false,
    "resolveJsonModule": true,
    "moduleResolution": "node",
    "esModuleInterop": true,
    "forceConsistentCasingInFileNames": true,
    "baseUrl": ".",
    "paths": {
      "@/*": ["./src/*"]
    }
  }
}

2. 新建tsconfig.build.json，专门用于生产构建，只处理src目录：

{
  "extends": "./tsconfig.base.json",
  "compilerOptions": {
    "outDir": "./dist"
  },
  "include": ["src/**/*"]
}

3. 根目录的tsconfig.json保留给IDE和日常开发、类型检查用，包含test目录：

{
  "extends": "./tsconfig.base.json",
  "include": ["src/**/*", "test/**/*"]
}

之后构建的时候，执行这个命令就行：

tsc --project tsconfig.build.json

这样dist里只会有src编译后的内容，而IDE和类型检查时，test里的@/*别名依然能正常识别，不会报错。

方案2：命令行临时指定构建范围（轻量但不够直观） #

如果你不想多维护配置文件，也可以在构建时通过命令行参数临时覆盖include配置，只编译src目录：

tsc --include src/**/*

不过这种方式不够直观，团队协作时容易忘记这个参数，不如拆分配置清晰，所以只适合个人小项目用。

额外的配套配置提醒 #

不管用哪种方案，都要确保module-alias的配置和TS的别名对应上，在你的package.json里加上：

{
  "_moduleAliases": {
    "@": "dist/src"
  }
}

这样不管是运行项目代码还是测试代码，module-alias都能正确解析@别名。

另外，如果用jest之类的测试框架，记得在jest.config.js里加上别名映射：

module.exports = {
  // ...其他jest配置
  moduleNameMapper: {
    "^@/(.*)$": "<rootDir>/src/$1"
  }
}

避免测试运行时因为别名报错。

备注：内容来源于stack exchange，提问作者foo