开源项目 Rush Stack 教程

1. 项目介绍

Rush Stack 是一个由微软发起的开源项目，旨在为大型单体仓库（monorepo）开发提供可重用技术，特别适用于Web应用程序。这个项目汇集了社区合作伙伴的力量，他们共同解决在大规模项目中遇到的工具挑战。Rush Stack 战略是整合诸如 Node.js、TypeScript、ESLint、Prettier、Webpack 和 Jest 等流行工具，并填补这些工具之间空白，以实现高效开发流程。

核心组件包括：

• Rush: 可扩展的构建编排器，用于管理复杂且多变的项目结构。
• Heft: 一个可扩展的构建系统，能够与 Rush 配合，提供自定义构建逻辑。
• API Extractor: 协调库包的API审查，并生成d.ts聚合文件。
• API Documenter: 生成API文档网站。

此外，还有 ESLint 相关工具，如 bulk、config 和 patch，以及 packlets 等。

2. 项目快速启动

安装依赖

首先确保全局安装了 npm。然后通过以下命令安装 Rush：

npm install -g @microsoft/rush

克隆仓库

获取 rushstack 示例项目：

git clone https://github.com/microsoft/rushstack.git

安装包

进入项目目录并运行 Rush 来安装所有依赖：

cd rushstack
rush install

如果你没有配置 GitHub 邮箱，可以添加 --bypass-policy 选项跳过政策检查。

构建项目

现在可以重建整个项目仓库：

rush rebuild

或者，如果你想只构建特定的项目，例如 rush-core-library：

cd libraries\rush-core-library
rushx build

注意，在 Rush 库里尽量避免直接使用 npm install 命令，更多关于 Rush 的使用方法可以在其文档中查找。

3. 应用案例和最佳实践

在 rushstack-samples 子仓库中提供了多种应用场景示例，展示如何在不同项目设置下使用 Heft 与其他流行的 JavaScript 框架结合。你可以参考这些样例来学习最佳实践。

4. 典型生态项目

Rush Stack 下涵盖多个子项目，它们各自承担着不同的职责，比如：

• @rushstack/api-documenter：处理 API 文档的生成。
• @rushstack/api-extractor：协调 API 的审核和导出。
• @rushstack/heft：构建系统的底层框架。
• @rushstack/lockfile-explorer：锁定文件查看工具。
• @rushstack/rundown：用于管理和执行任务的工具。
• @rushstack/rush：核心的 monorepo 构建管理器。

此外，还有一些 ESLint 相关的包，比如 eslint-bulk, eslint-config, eslint-patch 和 eslint-plugin-packlets，用来增强 ESLint 在大型 TypeScript 项目中的功能。

通过这些项目和工具，开发者可以搭建一个强大、可扩展的 monorepo 工作流。具体的使用场景和配置可以根据实际需求进行选择和定制。