Rush Stack 项目教程

1. 项目的目录结构及介绍

Rush Stack 是一个用于管理大型 monorepo 的工具集合。项目的目录结构如下：

rushstack/
├── apps/
│   ├── api-documenter/
│   ├── api-extractor/
│   ├── heft/
│   ├── lockfile-explorer/
│   ├── rundown/
│   └── rush/
├── libraries/
│   ├── rush-core-library/
│   └── ...
├── common/
│   ├── config/
│   └── scripts/
├── rush.json
└── ...

• apps/：包含 Rush Stack 的主要应用程序，如 api-documenter、api-extractor、heft 等。
• libraries/：包含 Rush Stack 的核心库和其他辅助库。
• common/：包含项目通用的配置文件和脚本。
• rush.json：Rush 项目的主要配置文件。

2. 项目的启动文件介绍

Rush Stack 项目的启动文件主要是 rush.json 和各个应用程序的入口文件。以下是一些关键的启动文件：

• rush.json：Rush 项目的主要配置文件，定义了项目的依赖关系、脚本命令等。
• apps/rush/src/index.ts：Rush 应用程序的入口文件。
• apps/heft/src/index.ts：Heft 构建系统的入口文件。

3. 项目的配置文件介绍

Rush Stack 项目的配置文件主要位于 common/config/ 目录下，以及各个应用程序的配置文件。以下是一些关键的配置文件：

• rush.json：Rush 项目的主要配置文件，包含项目的依赖管理、脚本命令、版本控制等配置。
• common/config/rush/：包含 Rush 项目的通用配置文件，如 command-line.json、version-policies.json 等。
• apps/api-extractor/config/api-extractor.json：API Extractor 的配置文件，用于管理 API 文档的生成和打包。
• apps/heft/config/heft.json：Heft 构建系统的配置文件，定义了构建任务和插件。

以上是 Rush Stack 项目的基本教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用 Rush Stack。