references配置项详解

references

在 TypeScript 的 tsconfig.json 配置文件中，references 配置项用于设置项目间的依赖关系。它主要用于多项目的构建流程中，特别是在 Project References（项目引用）中，帮助 TypeScript 确定不同项目之间的依赖和构建顺序。这种配置适用于将多个 TypeScript 项目分割成小的子项目进行构建，提高构建效率和模块化管理。

references 的基本作用

• references 是一个数组，每个元素描述一个外部 TypeScript 项目（另一个 tsconfig.json 文件）。
• 在一个 TypeScript 项目中使用 references 配置项，可以指定该项目依赖于其他项目。TypeScript 会自动解析依赖关系，并按照正确的顺序进行构建。
• references 配置项在 项目引用（Project References） 模式中非常有用，能够让 TypeScript 在构建过程中进行增量构建，而不需要重新构建所有项目。

path 配置项

• path 是 references 配置项中必需的字段，指定一个相对路径或绝对路径，指向另一个 tsconfig.json 文件的位置。
• TypeScript 会根据 path 指定的位置找到另一个项目，并将其作为当前项目的依赖项。

composite 配置项

• composite 是 tsconfig.json 中的一个 compilerOptions 配置项，在启用项目引用时，它必须被设置为 true。
• 启用 composite 后，TypeScript 会在项目构建时创建 .tsbuildinfo 文件，这是 TypeScript 用来存储增量构建信息的文件。它可以加速后续构建，只重建那些发生变化的部分。
• 只有启用了 composite 的项目才能作为其他项目的引用。

tsconfig.build.json 和 references 配置

在大型项目中，通常会有一个专门的构建配置文件，例如 tsconfig.build.json，它仅用于项目引用和构建，而不包含开发环境的设置。这个文件通常包含 references 配置项，指向所有的子项目。

总结

• references 配置项是 TypeScript 在多项目构建中使用的重要配置项，它用于指定项目间的依赖关系。
• 通过 references，TypeScript 可以正确地确定构建顺序，进行增量构建，提高构建效率。
• 项目引用模式必须启用 composite 配置项，且每个被引用的项目应配置正确的 outDir。
• 使用项目引用可以将大型项目拆分为多个子项目，使得每个子项目可以独立构建，从而提高管理效率和构建速度。