构建项目

如果您要为 TSDoc 提交 pull request，您将需要使用 Rush monorepo 管理器工具。

这是什么 Rush 工具？ Rush 是一个 monorepo 构建编排器，用于处理策略验证、变更日志管理、安装（使用 PNPM）、链接、构建和发布。要了解有关 Rush 的更多信息，请访问：https://rush.node.org.cn

像这样安装该工具

$ npm install -g @microsoft/rush

注意：如果此命令失败，因为您的用户帐户没有访问 NPM 全局文件夹的权限，您可能需要修复您的 NPM 配置。

Rush 将符号链接 api-demo 项目以使用您本地构建的 @microsoft/tsdoc 库，以便于测试/验证。

构建项目

$ cd ./tsdoc
$ rush install
$ rush build

要从命令行运行所有单元测试

单元测试是使用 Jest 实现的，但通过 Heft 构建系统调用。（有关更全面的文档，请参阅链接页面。）

当您构建项目时，单元测试会自动调用

$ cd ./tsdoc
$ npm run build

交互式运行单元测试

您还可以交互式地调用 Heft/Jest（jest --watch 场景），以便在保存源文件时重新运行受影响的测试。像这样启动 watch 模式

$ cd ./tsdoc
$ npm run watch

调试单元测试

./tsdoc/.vscode/launch.json 文件包含一个 Visual Studio Code 配置，使调试更容易。要调试单元测试

1. 在 tsdoc 子文件夹（而不是存储库根目录）中启动 VS Code

   $ cd ./tsdoc
   $ code .

2. 在编辑器窗口中，打开一个测试文件。例如，src/tests/ParsingBasicTests.test.ts。

3. 在 VS Code 窗口中，单击 查看 --> 调试 (CTRL+SHIFT+D)

4. 从 DEBUG 组合框中，选择“Debug Jest tests”调试配置，然后单击播放按钮。这将运行调试器中的所有测试。