请解释 tsc 的 --build 选项的作用。如何使用项目引用进行构建？

推荐答案

tsc 的 --build 选项用于构建 TypeScript 项目，特别是在使用项目引用（Project References）时。它允许你构建一个项目及其依赖项，并且只会重新编译发生变化的文件，从而提高构建效率。

使用项目引用进行构建的步骤：

1. 在 tsconfig.json 中配置项目引用，使用 references 字段指定依赖的其他项目。
2. 在命令行中运行 tsc --build 或 tsc -b，指定要构建的项目配置文件（如 tsconfig.json）。
3. TypeScript 会自动构建当前项目及其所有依赖项目，并确保构建顺序正确。

本题详细解读

--build 选项的作用

--build 选项是 TypeScript 3.0 引入的功能，主要用于优化多项目构建流程。它的主要作用包括：

1. 增量构建：只重新编译发生变化的文件，减少构建时间。
2. 依赖管理：自动检测并构建项目引用的其他项目，确保依赖关系正确。
3. 错误报告：在构建过程中，如果某个依赖项目有错误，会立即停止并报告错误。

项目引用（Project References）

项目引用是 TypeScript 中用于管理多项目依赖的机制。通过在 tsconfig.json 中配置 references 字段，可以指定当前项目依赖的其他项目。例如：

{
  "references": [
    { "path": "../core" },
    { "path": "../utils" }
  ]
}

如何使用 --build 进行构建

1. 配置项目引用：在 tsconfig.json 中添加 references 字段，指定依赖的项目路径。
2. 运行构建命令：在命令行中执行 tsc --build 或 tsc -b，指定要构建的配置文件。例如：

   tsc -b src/tsconfig.json

3. 构建结果：TypeScript 会按照依赖关系依次构建所有项目，并输出编译结果。

示例

假设有两个项目：core 和 app，app 依赖于 core。它们的 tsconfig.json 配置如下：

• core/tsconfig.json:

  {
    "compilerOptions": {
      "composite": true,
      "outDir": "./dist"
    }
  }

• app/tsconfig.json:

  {
    "references": [
      { "path": "../core" }
    ],
    "compilerOptions": {
      "outDir": "./dist"
    }
  }

在 app 目录下运行 tsc -b，TypeScript 会先构建 core 项目，然后再构建 app 项目。

注意事项

• 使用 --build 时，依赖项目的 tsconfig.json 必须设置 composite: true。
• --build 选项支持增量构建，因此后续构建会更快。
• 如果某个依赖项目有错误，整个构建过程会立即停止。