调试

如果您正在为 API 提取器贡献代码，您最终会想在调试器中运行它。如果您在 **apps/api-extractor** 文件夹中打开 VS Code，它包含一个 launch.json 文件，其中包含用于在 **build-tests** 文件夹中的各种测试项目上运行 API 提取器的预制调试器配置。

例如，要在调试器中分析 **build-tests/api-extractor-test-01**，您将执行以下操作

1. 确保该项目已编译（因为 API 提取器处理 .d.ts 文件，而不是 .ts 文件）

   $ cd ./build-tests/api-extractor-test-01
   $ rushx build

   (npm run build 也可以工作)

2. 在 **apps/api-extractor** 文件夹中打开 VS Code。

3. 单击左侧工具栏上的“调试”图标（Ctrl+Shift+D）。

4. 从组合框中选择 "test-01" 配置。

5. 单击绿色“播放”按钮（F5）。

**api-extractor-scenarios** 项目略微棘手，因为它有许多不同的入口点。对于每个入口点，runScenarios.ts 驱动程序将在 **temp/configs** 文件夹中创建一个完整的 **api-extractor.json** 样式配置文件。因此，您需要手动编辑调试器配置以指定所需的配置。该部分如下所示

api-extractor/.vscode/launch.json

    . . .
    {
      "type": "node",
      "request": "launch",
      "name": "scenario",
      "program": "${workspaceFolder}/lib/start.js",
      "cwd": "${workspaceFolder}/../../build-tests/api-extractor-scenarios",
      "args": [
        "--debug",
        "run",
        "--local",
        "--config",
        "./temp/configs/api-extractor-typeof.json"
      ],
      "sourceMaps": true
    },
    . . .

将 --config 参数从 "./temp/configs/api-extractor-typeof.json" 更改为指定要调试的场景的特定配置文件。

顺便说一句，如果您想向 **api-extractor-scenarios** 添加新场景，请不要忘记在 config/build-config.json 中注册它。