项目引用 Project References
TypeScript 的项目引用（Project References）是一个强大的功能，允许一个 TypeScript 项目引用另一个 TypeScript 项目。这个功能非常适用于大型代码库和单体仓库（monorepos），它使得项目之间的依赖关系更明确，并且可以显著加快编译速度。
项目引用的核心概念
项目引用通过允许一个项目依赖于另一个项目，使得 TypeScript 编译器可以在编译时确保所有引用的项目都被正确编译。这不仅提高了编译效率，还改善了项目间的类型检查和代码导航。
配置项目引用
要使用项目引用，需要对 TypeScript 项目进行一些配置，主要包括 tsconfig.json 文件的设置。
步骤 1: 创建多个项目
假设我们有两个项目，core 和 app。app 项目依赖于 core 项目。
/my-monorepo
/core
src/
index.ts
tsconfig.json
/app
src/
main.ts
tsconfig.json
tsconfig.json
步骤 2: 配置 core 项目的 tsconfig.json
首先，我们需要配置 core 项目的 tsconfig.json：
{
"compilerOptions": {
"composite": true, // 必须启用
"declaration": true,
"declarationMap": true,
"outDir": "./dist"
},
"include": ["src"]
}
composite 选项必须启用，它表示这是一个可以被引用的 TypeScript 项目。
步骤 3: 配置 app 项目的 tsconfig.json
接下来，我们需要配置 app 项目的 tsconfig.json，并引用 core 项目：
{
"compilerOptions": {
"outDir": "./dist"
},
"include": ["src"],
"references": [
{
"path": "../core"
}
]
}
references 字段指定了 app 项目引用了 core 项目。
步骤 4: 配置顶层 tsconfig.json
在顶层目录创建一个 tsconfig.json 文件，以便可以一次性编译整个项目结构：
{
"files": [],
"references": [
{
"path": "./core"
},
{
"path": "./app"
}
]
}
构建项目
通过在顶层目录运行 tsc --build 命令，可以一次性编译所有的子项目：
tsc --build
这个命令会按照项目之间的依赖关系顺序编译所有的项目，并生成相应的输出文件。
项目引用的优势
- 加快增量编译：由于每个项目可以单独编译，并且编译结果可以被缓存，所以在修改一个项目时，只需要重新编译受影响的项目，从而加快编译速度。
- 更好的模块化：项目引用使得项目之间的依赖关系更加明确，有助于模块化管理代码。
- 改进的类型检查和代码导航：TypeScript 编译器可以跨项目进行类型检查，确保类型安全，并且开发工具（如 VS Code）可以提供更好的代码导航支持。
总结
TypeScript 的项目引用是一个非常实用的功能，特别适用于大型项目和单体仓库。通过配置项目引用，可以提高编译速度，改进代码模块化管理，并且增强类型检查和代码导航能力。使用项目引用可以使得 TypeScript 项目之间的依赖关系更加清晰和高效，从而更好地管理和维护大型代码库。